org.sixdml.dbmanagement
Interface SixdmlIndex

All Known Implementing Classes:

xlnSixdmlIndex

public interface SixdmlIndex

SixdmlIndex.java This interface should be implemented by classes that represent indexes into the XML documents be they structural, text, or value indexes. Created: Thu Jan 10 06:27:40 2002

Version:

1.0

Author:

Dare Obasanjo

Field Summary

static org.sixdml.dbmanagement.SixdmlIndexType	STRUCTURE_INDEX Represents a structure index.
static org.sixdml.dbmanagement.SixdmlIndexType	TEXT_INDEX Represents a text index.
static org.sixdml.dbmanagement.SixdmlIndexType	UNKNOWN Represents an unknown type of index.
static org.sixdml.dbmanagement.SixdmlIndexType	VALUE_INDEX Represents a value index.

Method Summary

HashMap	getIndexFields() Returns a hash table containing various characteristics of the index depending on its type.
String	getName() Get the name of the index.
org.sixdml.dbmanagement.SixdmlIndexType	getType() Returns the type of the index.

Field Detail

VALUE_INDEX

public static final org.sixdml.dbmanagement.SixdmlIndexType VALUE_INDEX

Represents a value index.

TEXT_INDEX

public static final org.sixdml.dbmanagement.SixdmlIndexType TEXT_INDEX

Represents a text index.

STRUCTURE_INDEX

public static final org.sixdml.dbmanagement.SixdmlIndexType STRUCTURE_INDEX

Represents a structure index.

UNKNOWN

public static final org.sixdml.dbmanagement.SixdmlIndexType UNKNOWN

Represents an unknown type of index.

Method Detail

getName

public String getName()

Get the name of the index.

Returns:

Value of name.

getType

public org.sixdml.dbmanagement.SixdmlIndexType getType()

Returns the type of the index.

Returns:

type of the index.

getIndexFields

public HashMap getIndexFields()

Returns a hash table containing various characteristics of the index depending on its type. If the index is of type STRUCTURE_INDEX then the hash table could contain the following pairs {"key", <XPath-expression>} and {"index", >XPath-expression<}. The actual contents of the hash table will vary from database to database depending on what is standardized on.

Returns:

a hash table containing the relevant data about the index.