001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2006-2010 Sun Microsystems, Inc. 025 * Portions Copyright 2014-2015 ForgeRock AS 026 */ 027package org.opends.server.backends.jeb; 028 029import java.util.Collection; 030 031import org.forgerock.opendj.ldap.ByteSequence; 032import org.forgerock.opendj.ldap.ByteString; 033import org.forgerock.opendj.ldap.DecodeException; 034import org.forgerock.opendj.ldap.schema.MatchingRule; 035import org.forgerock.opendj.ldap.schema.Schema; 036import org.forgerock.opendj.ldap.spi.Indexer; 037import org.opends.server.types.AttributeType; 038 039/** 040 * An implementation of an Indexer for attribute equality. 041 */ 042public class EqualityIndexer implements Indexer 043{ 044 045 /** 046 * The attribute type equality matching rule which is also the 047 * comparator for the index keys generated by this class. 048 */ 049 private final MatchingRule equalityRule; 050 051 /** 052 * Create a new attribute equality indexer for the given index configuration. 053 * @param attributeType The attribute type for which an indexer is 054 * required. 055 */ 056 public EqualityIndexer(AttributeType attributeType) 057 { 058 this.equalityRule = attributeType.getEqualityMatchingRule(); 059 } 060 061 /** {@inheritDoc} */ 062 @Override 063 public String getIndexID() 064 { 065 return "equality"; 066 } 067 068 /** {@inheritDoc} */ 069 @Override 070 public void createKeys(Schema schema, ByteSequence value, Collection<ByteString> keys) throws DecodeException 071 { 072 keys.add(equalityRule.normalizeAttributeValue(value)); 073 } 074 075}