Package org.opends.guitools.controlpanel.datamodel

Class IndexDescriptor

java.lang.Object

org.opends.guitools.controlpanel.datamodel.AbstractIndexDescriptor

org.opends.guitools.controlpanel.datamodel.IndexDescriptor

All Implemented Interfaces:

Comparable<AbstractIndexDescriptor>

public class IndexDescriptor
extends AbstractIndexDescriptor

The class used to describe the index configuration (the normal index: the one used to improve search performance on a given attribute).

Constructor Summary

Constructors

Constructor	Description
IndexDescriptor(String indexName)	Constructor of the index descriptor.
IndexDescriptor(String name, AttributeType attr, BackendDescriptor backend, Set<BackendIndexCfgDefn.IndexType> types, int entryLimit)	Constructor of the index descriptor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(AbstractIndexDescriptor o)
boolean	equals(Object o)
AttributeType	getAttributeType()	Returns the attribute type associated with the index attribute.
int	getEntryLimit()	Returns the entry limit of the index.
SortedSet<BackendIndexCfgDefn.IndexType>	getTypes()	Returns the type of indexes (equality, substring, etc.).
int	hashCode()
boolean	isDatabaseIndex()	Tells whether this is a database index or not.
protected void	recalculateHashCode()	Method used to minimize the times the hashcode is calculated.

Methods inherited from class org.opends.guitools.controlpanel.datamodel.AbstractIndexDescriptor

getBackend, getName, setBackend

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexDescriptor

public IndexDescriptor(String indexName)

Constructor of the index descriptor.

Parameters:

indexName - name of the index.

IndexDescriptor

public IndexDescriptor(String name,
                       AttributeType attr,
                       BackendDescriptor backend,
                       Set<BackendIndexCfgDefn.IndexType> types,
                       int entryLimit)

Constructor of the index descriptor.

Parameters:

name - name of the index.

attr - the attribute type associated with the index attribute.

backend - the backend where the index is defined.

types - the type of indexes (equality, substring, etc.).

entryLimit - the entry limit for the index.

Method Detail

getAttributeType

public AttributeType getAttributeType()

Returns the attribute type associated with the index attribute.

Returns:

the attribute type associated with the index attribute.

compareTo

public int compareTo(AbstractIndexDescriptor o)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypes

public SortedSet<BackendIndexCfgDefn.IndexType> getTypes()

Returns the type of indexes (equality, substring, etc.).

Returns:

the type of indexes (equality, substring, etc.).

isDatabaseIndex

public boolean isDatabaseIndex()

Tells whether this is a database index or not. Database indexes are not modifiable and for internal use only.

Returns:

true if this is a database index and false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getEntryLimit

public int getEntryLimit()

Returns the entry limit of the index.

Returns:

the entry limit of the index.

recalculateHashCode

protected void recalculateHashCode()

Description copied from class: AbstractIndexDescriptor

Method used to minimize the times the hashcode is calculated.

Specified by:

recalculateHashCode in class AbstractIndexDescriptor