net.sf.jso.schema
Class IndexDescriptor

java.lang.Object
  extended bynet.sf.jso.schema.IndexDescriptor
All Implemented Interfaces:
java.io.Serializable

public class IndexDescriptor
extends java.lang.Object
implements java.io.Serializable

Class for storable index descritptors. Index descriptors represent fields of Storable implementations as they should be stored in JSO schema.

See Also:
Serialized Form

Constructor Summary
IndexDescriptor()
          Constructs the index descriptor.
IndexDescriptor(java.lang.String aName, java.util.List aFieldList, boolean isUnique)
          Constructs the index descriptor.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other index descriptor is "equal to" this one.
 java.util.List getFields()
          Gets the indexe's list of fields.
 java.lang.String getName()
          Gets index's name.
 int hashCode()
          Returns a hash code value for the index descriptor.
 boolean isUnique()
          Indicates if the index is unique.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexDescriptor

public IndexDescriptor()
Constructs the index descriptor.


IndexDescriptor

public IndexDescriptor(java.lang.String aName,
                       java.util.List aFieldList,
                       boolean isUnique)
Constructs the index descriptor.

Parameters:
aName - The index's name.
aFieldList - List of fields of the index.
isUnique - Indicates if the index is unique.
Method Detail

getName

public java.lang.String getName()
Gets index's name.

Returns:
Index's name.

getFields

public java.util.List getFields()
Gets the indexe's list of fields.

Returns:
A list of fields.

isUnique

public boolean isUnique()
Indicates if the index is unique.

Returns:
true if the index is unique;; false otherwise.

equals

public boolean equals(java.lang.Object o)
Indicates whether some other index descriptor is "equal to" this one.

Parameters:
o - The object with which to compare.
Returns:
true if the index descriptor is the same as the index descriptor argument; false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the index descriptor.

Returns:
A hash code value for the index descriptor.