IndexDescriptor.java revision 866cc640d33ce92abbd907d35d4c1b62f2328959
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2008-2010 Sun Microsystems, Inc.
* Portions Copyright 2015 ForgeRock AS
*/
/**
* The class used to describe the index configuration (the normal index: the one
* used to improve search performance on a given attribute).
*/
public class IndexDescriptor extends AbstractIndexDescriptor
{
private static final String[] DATABASE_INDEXES = new String[] {"dn2id", "id2children", "id2subtree"};
private final boolean isDatabaseIndex;
private final int entryLimit;
private final AttributeType attr;
private int hashCode;
/**
* Constructor of the index descriptor.
*
* @param name
* name of the index.
* @param attr
* the attribute type associated with the index attribute.
* @param backend
* the backend where the index is defined.
* @param types
* the type of indexes (equality, substring, etc.).
* @param entryLimit
* the entry limit for the index.
*/
{
this.entryLimit = entryLimit;
}
/**
* Returns the attribute type associated with the index attribute.
*
* @return the attribute type associated with the index attribute.
*/
public AttributeType getAttributeType()
{
return attr;
}
public int compareTo(AbstractIndexDescriptor o)
{
}
public int hashCode()
{
return hashCode;
}
/**
* Returns the type of indexes (equality, substring, etc.).
*
* @return the type of indexes (equality, substring, etc.).
*/
{
}
/**
* Tells whether this is a database index or not. Database indexes are not
* modifiable and for internal use only.
*
* @return <CODE>true</CODE> if this is a database index and
* <CODE>false</CODE> otherwise.
*/
public boolean isDatabaseIndex()
{
return isDatabaseIndex;
}
/**
* Tells whether the provide index name corresponds to a database index or
* not. Database indexes are not modifiable and for internal use only.
*
* @return <CODE>true</CODE> if the provide index name corresponds to a
* database index and <CODE>false</CODE> otherwise.
*/
{
{
{
return true;
}
}
return false;
}
{
if (o == this)
{
return true;
}
if (!(o instanceof IndexDescriptor))
{
return false;
}
&& backendIdEqual(index);
}
{
return getBackend() != null
}
/**
* Returns the entry limit of the index.
*
* @return the entry limit of the index.
*/
public int getEntryLimit()
{
return entryLimit;
}
protected void recalculateHashCode()
{
for (final IndexTypeDescriptor t : types)
{
}
if (getBackend() != null)
{
}
}
}