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:

Workgroup DBIS, University of Konstanz 2005-09, ISC License, Christian Gruen

Field Summary

boolean	atvindex Flag for creating a attribute value index.
java.lang.String	backingpath DeepFS backing path.
boolean	chop Flag for whitespace chopping.
java.lang.String	dbname Database name.
boolean	dirty Dirty flag.
java.lang.String	encoding Encoding of XML document.
boolean	entity Flag for entity parsing.
IO	file Original filename of XML document.
long	filesize Original file size of XML document.
boolean	ftcs Flag for fulltext case sensitivity.
boolean	ftdc Flag for fulltext diacritics removal.
boolean	ftfz Flag for fuzzy indexing.
boolean	ftittr Flag for iterator optimized storage within ftindex.
boolean	ftst Flag for fulltext stemming.
boolean	ftxindex Flag for creating a fulltext index.
int	height Maximum document height.
int	lastid Last (highest) id assigned to a node.
java.lang.String	mountpoint DeepFS mount point.
int	ndocs Number of XML documents.
boolean	oldindex Flag for out-of-dates indexes.
int	size Table size.
long	time Modification time.
boolean	txtindex Flag for creating a text index.
boolean	uptodate Flag for removed index structures.

Constructor Summary

MetaData(java.lang.String db)
Constructor, specifying the database name.

Method Summary

static boolean	found(java.lang.String path, java.lang.String db) Checks if the specified file path refers to the specified database.
void	read(DataInput in) Opens the metadata for the current database and returns the table size.
void	update() Notifies the meta structures of an update.
void	write(DataOutput out) Writes the database to the specified path.

Methods inherited from class java.lang.Object

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

Field Detail

dbname

public java.lang.String dbname

Database name.

mountpoint

public java.lang.String mountpoint

DeepFS mount point.

backingpath

public java.lang.String backingpath

DeepFS backing path.

encoding

public java.lang.String encoding

Encoding of XML document.

file

public IO file

Original filename of XML document.

filesize

public long filesize

Original file size of XML document.

ndocs

public int ndocs

Number of XML documents.

height

public int height

Maximum document height.

time

public long time

Modification time.

chop

public boolean chop

Flag for whitespace chopping.

entity

public boolean entity

Flag for entity parsing.

txtindex

public boolean txtindex

Flag for creating a text index.

atvindex

public boolean atvindex

Flag for creating a attribute value index.

ftxindex

public boolean ftxindex

Flag for creating a fulltext index.

ftittr

public boolean ftittr

Flag for iterator optimized storage within ftindex.

ftfz

public boolean ftfz

Flag for fuzzy indexing.

ftst

public boolean ftst

Flag for fulltext stemming.

ftcs

public boolean ftcs

Flag for fulltext case sensitivity.

ftdc

public boolean ftdc

Flag for fulltext diacritics removal.

uptodate

public boolean uptodate

Flag for removed index structures.

dirty

public boolean dirty

Dirty flag.

oldindex

public boolean oldindex

Flag for out-of-dates indexes.

size

public int size

Table size.

lastid

public int lastid

Last (highest) id assigned to a node.

Constructor Detail

MetaData

public MetaData(java.lang.String db)

Constructor, specifying the database name.

Parameters:

db - database name

Method Detail

found

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

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

Parameters:

path - file path

db - database name

Returns:

result of check

update

public void update()

Notifies the meta structures of an update. Deletes/resets the indexes.

read

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

Opens the metadata for the current database and returns the table size.

Parameters:

in - input stream

Throws:

java.io.IOException - I/O Exception

write

public void write(DataOutput out)
           throws java.io.IOException

Writes the database to the specified path.

Parameters:

out - output stream

Throws:

java.io.IOException - IO Exception