org.sixdml.excelon
Class xlnSixdmlIndex

java.lang.Object
  |
  +--org.sixdml.excelon.xlnSixdmlIndex

All Implemented Interfaces:

org.sixdml.SixdmlConstants, org.sixdml.dbmanagement.SixdmlIndex

public class xlnSixdmlIndex

extends java.lang.Object

implements org.sixdml.dbmanagement.SixdmlIndex, org.sixdml.SixdmlConstants

  
 xlnSixdmlIndex.java

 A database index. 
 
 Created: Sun Jan 13 15:58:50 2002

 

Fields inherited from interface org.sixdml.SixdmlConstants

SIXDML_NS, SIXDML_VERSION

Method Summary

boolean	equals(java.lang.Object obj) Compares two objects of this class.
com.exln.dxe.filesystem.XlnIndex	getIndex() Returns this objects underlying eXcelon DXE XlnIndex object, if non-exists because this class instance was created in an ad-hoc manner then a new XlnIndex object will be created.
java.util.HashMap	getIndexFields() Returns a hash table containing various characteristics of the index depending on its type.
java.lang.String	getName() Get the name of the index.
org.sixdml.dbmanagement.SixdmlIndexType	getType() Returns the type of the index.
org.w3c.dom.Node	getXMLAsNode() Creates an XML representation of this object that conforms to the following DTD as a DOM node.
java.lang.String	getXMLAsString() Creates an XML representation of this object that conforms to the following DTD as a string.

Methods inherited from class java.lang.Object

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

Method Detail

getIndex

public com.exln.dxe.filesystem.XlnIndex getIndex()

Returns this objects underlying eXcelon DXE XlnIndex object, if non-exists because this class instance was created in an ad-hoc manner then a new XlnIndex object will be created.

getName

public java.lang.String getName()

Get the name of the index.

Specified by:

getName in interface org.sixdml.dbmanagement.SixdmlIndex

Returns:

Value of name.

getType

public org.sixdml.dbmanagement.SixdmlIndexType getType()

Returns the type of the index.

Specified by:

getType in interface org.sixdml.dbmanagement.SixdmlIndex

Returns:

type of the index.

getIndexFields

public java.util.HashMap getIndexFields()

Returns a hash table containing various characteristics of the index depending on its type. All eXcelon DXE indexes will have an entry for "indexKey", "indexElement", "options" and "type". Both the "options" and "type" fields will be integer values that will be one of a range of values defined as static ints in the XlnIndex, XlnTextIndex and XlnValueIndex classes.

Specified by:

getIndexFields in interface org.sixdml.dbmanagement.SixdmlIndex

Returns:

a hash table containing the relevant data about the index. The hashtable returned is a COPY of the one used by this class internally.

getXMLAsNode

public org.w3c.dom.Node getXMLAsNode()

Creates an XML representation of this object that conforms to the following DTD as a DOM node.

 <!ELEMENT index(indexKey, indexElement, options, type, tokenizer?)> 
 <!ATTLIST index name CDATA #REQUIRED >
 <!ELEMENT indexKey (#PCDATA)> 
 <!ELEMENT indexElement (#PCDATA)> 
 <!ELEMENT options (#PCDATA)> 
 <!ELEMENT type (#PCDATA)> 
 

Returns:

a DOM Node containing the XML representation of this class.

getXMLAsString

public java.lang.String getXMLAsString()

Creates an XML representation of this object that conforms to the following DTD as a string.

 <!ELEMENT index(indexKey, indexElement, options, type, tokenizer?)> 
 <!ATTLIST index name CDATA #REQUIRED >
 <!ELEMENT indexKey (#PCDATA)> 
 <!ELEMENT indexElement (#PCDATA)> 
 <!ELEMENT options (#PCDATA)> 
 <!ELEMENT type (#PCDATA)> 
 

Returns:

a string containing the XML representation of this class.

equals

public boolean equals(java.lang.Object obj)

Compares two objects of this class. Returns true if they have the same name and same values in their index fields.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare.

Returns:

true if they have the same name and values in their index fields, false otherwise.