org.basex.data

Class MetaData

java.lang.Object

org.basex.data.MetaData

public final class MetaData
extends java.lang.Object

This class provides meta information on a database.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
boolean	attrindex Indicates if a attribute index exists.
boolean	casesens Flag for full-text case sensitivity.
boolean	chop Flag for whitespace chopping.
boolean	corrupt Flag to indicate possible corruption.
boolean	createattr Indicates if attribute index is to be recreated.
boolean	createftxt Indicates if full-text index is to be recreated.
boolean	createtext Indicates if text index is to be recreated.
boolean	diacritics Flag for full-text diacritics removal.
boolean	dirty Dirty flag.
java.lang.String	encoding Encoding of original document.
long	filesize Size of original document.
boolean	ftxtindex Indicates if a full-text index exists.
Language	language Language of full-text search index.
int	lastid Last (highest) id assigned to a node.
int	maxcats Maximum number of categories.
int	maxlen Maximum token length.
int	maxscore Maximal indexed full-text score.
int	minscore Minimal indexed full-text score.
java.lang.String	name Database name.
int	ndocs Number of stored documents.
boolean	oldindex Flag for out-of-date indexes.
java.lang.String	original Path to original document.
IOFile	path Database path.
Prop	prop Properties.
int	scoring Scoring mode: see Prop.SCORING.
int	size Table size.
boolean	stemming Flag for full-text stemming.
boolean	textindex Indicates if a text index exists.
long	time Timestamp of original document.
boolean	updindex Flag for activated automatic index update.
boolean	uptodate Flag for out-of-date index structures.
Users	users Database users.
boolean	wildcards Flag for wildcard indexing.

Constructor Summary

Constructors

Constructor and Description
MetaData(Prop pr) Constructor, specifying the database properties.
MetaData(java.lang.String db, Context ctx) Constructor, specifying the database name and context.
MetaData(java.lang.String db, Prop pr, MainProp mprop) Constructor, specifying the database name.

Method Summary

Methods

Modifier and Type	Method and Description
IOFile	binaries() Returns the binary directory.
IOFile	binary(java.lang.String pth) Returns the specified binary file, or null if the resource path cannot be resolved (e.g.
IOFile	dbfile(java.lang.String fn) Returns a file instance for the specified database file.
long	dbsize() Returns the disk size of the database.
long	dbtime() Returns the disk timestamp of the database.
boolean	drop(java.lang.String pat) Drops the specified database files.
static boolean	found(java.lang.String path, java.lang.String db, MainProp mprop) Checks if the specified file path refers to the specified database.
static java.lang.String	normPath(java.lang.String path) Normalizes a database path.
void	read(DataInput in) Reads in meta data from the specified stream.
static boolean	validName(java.lang.String name, boolean glob) Checks if the specified database name is valid, matching the pattern [-\w]+, or [-\w*?,]+ if the glob flag is activated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

path

public final IOFile path

Database path. Set to null if database is in main memory.

prop

public final Prop prop

Properties.

name

public java.lang.String name

Database name.

users

public Users users

Database users.

encoding

public java.lang.String encoding

Encoding of original document.

original

public java.lang.String original

Path to original document.

filesize

public long filesize

Size of original document.

ndocs

public int ndocs

Number of stored documents.

time

public long time

Timestamp of original document.

chop

public boolean chop

Flag for whitespace chopping.

updindex

public boolean updindex

Flag for activated automatic index update.

textindex

public boolean textindex

Indicates if a text index exists.

attrindex

public boolean attrindex

Indicates if a attribute index exists.

ftxtindex

public boolean ftxtindex

Indicates if a full-text index exists.

createtext

public boolean createtext

Indicates if text index is to be recreated.

createattr

public boolean createattr

Indicates if attribute index is to be recreated.

createftxt

public boolean createftxt

Indicates if full-text index is to be recreated.

wildcards

public boolean wildcards

Flag for wildcard indexing.

stemming

public boolean stemming

Flag for full-text stemming.

casesens

public boolean casesens

Flag for full-text case sensitivity.

diacritics

public boolean diacritics

Flag for full-text diacritics removal.

maxscore

public int maxscore

Maximal indexed full-text score.

minscore

public int minscore

Minimal indexed full-text score.

scoring

public int scoring

Scoring mode: see Prop.SCORING.

maxcats

public int maxcats

Maximum number of categories.

maxlen

public int maxlen

Maximum token length.

language

public Language language

Language of full-text search index.

uptodate

public boolean uptodate

Flag for out-of-date index structures. Will be removed as soon as all indexes support updates.

oldindex

public boolean oldindex

Flag for out-of-date indexes.

corrupt

public boolean corrupt

Flag to indicate possible corruption.

dirty

public boolean dirty

Dirty flag.

size

public int size

Table size.

lastid

public int lastid

Last (highest) id assigned to a node.

Constructor Detail

MetaData

public MetaData(Prop pr)

Constructor, specifying the database properties.

Parameters:

pr - database properties

MetaData

public MetaData(java.lang.String db,
        Context ctx)

Constructor, specifying the database name and context.

Parameters:

db - name of the database

ctx - database context

MetaData

public MetaData(java.lang.String db,
        Prop pr,
        MainProp mprop)

Constructor, specifying the database name.

Parameters:

db - name of the database

pr - database properties

mprop - main properties

Method Detail

found

public static boolean found(java.lang.String path,
            java.lang.String db,
            MainProp mprop)

Checks if the specified file path refers to the specified database.

Parameters:

path - file path

db - name of the database

mprop - main properties

Returns:

result of check

normPath

public static java.lang.String normPath(java.lang.String path)

Normalizes a database path. Converts backslashes and removes duplicate and leading slashes. Returns null if the path contains invalid characters.

Parameters:

path - input path

Returns:

normalized path, or null

validName

public static boolean validName(java.lang.String name,
                boolean glob)

Checks if the specified database name is valid, matching the pattern [-\w]+, or [-\w*?,]+ if the glob flag is activated.

Parameters:

name - name to be checked

glob - allow glob syntax

Returns:

result of check

dbsize

public long dbsize()

Returns the disk size of the database.

Returns:

database size

dbtime

public long dbtime()

Returns the disk timestamp of the database.

Returns:

database size

dbfile

public IOFile dbfile(java.lang.String fn)

Returns a file instance for the specified database file. Should only be called if database is disk-based.

Parameters:

fn - filename

Returns:

database filename

binaries

public IOFile binaries()

Returns the binary directory.

Returns:

binary directory

binary

public IOFile binary(java.lang.String pth)

Returns the specified binary file, or null if the resource path cannot be resolved (e.g. if it points to a parent directory).

Parameters:

pth - internal file path

Returns:

binary directory

drop

public boolean drop(java.lang.String pat)

Drops the specified database files. Should only be called if database is disk-based.

Parameters:

pat - file pattern, or null if all files are to be deleted

Returns:

result of check

read

public void read(DataInput in)
          throws java.io.IOException

Reads in meta data from the specified stream.

Parameters:

in - input stream

Throws:

java.io.IOException - I/O exception