EqualityIndexer.java revision 8ac57ee1cd50fcc3d02b36bea4ab1335924f1d7a
/*
* 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
* or http://forgerock.org/license/CDDLv1.0.html.
* 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 2006-2010 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.backends.jeb;
import java.util.Collection;
import org.forgerock.opendj.ldap.ByteSequence;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.DecodeException;
import org.forgerock.opendj.ldap.schema.MatchingRule;
import org.forgerock.opendj.ldap.schema.Schema;
import org.forgerock.opendj.ldap.spi.Indexer;
import org.opends.server.types.AttributeType;
/**
* An implementation of an Indexer for attribute equality.
*/
public class EqualityIndexer implements Indexer
{
/**
* The attribute type equality matching rule which is also the
* comparator for the index keys generated by this class.
*/
private final MatchingRule equalityRule;
/**
* Create a new attribute equality indexer for the given index configuration.
* @param attributeType The attribute type for which an indexer is
* required.
*/
public EqualityIndexer(AttributeType attributeType)
{
this.equalityRule = attributeType.getEqualityMatchingRule();
}
/** {@inheritDoc} */
@Override
public String getIndexID()
{
return "equality";
}
/** {@inheritDoc} */
@Override
public void createKeys(Schema schema, ByteSequence value, Collection<ByteString> keys) throws DecodeException
{
keys.add(equalityRule.normalizeAttributeValue(value));
}
}