/*
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* 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
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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-2008 Sun Microsystems, Inc.
* Portions copyright 2012 ForgeRock AS.
*/
package org.opends.server.backends.jeb;
import org.opends.server.types.Entry;
import org.opends.server.types.Modification;
import java.util.Comparator;
import java.util.Set;
import java.util.List;
import java.util.Map;
/**
* This class attempts to abstract the generation and comparison of keys
* for an index. It is subclassed for the specific type of indexing.
*/
public abstract class Indexer
{
/**
* Get the comparator that must be used to compare index keys
* generated by this class.
*
* @return A byte array comparator.
*/
public abstract Comparator<byte[]> getComparator();
/**
* Generate the set of index keys for an entry.
*
* @param entry The entry.
* @param keys The set into which the generated keys will be inserted.
*/
public abstract void indexEntry(Entry entry, Set<byte[]> keys);
/**
* Generate the set of index keys to be added and the set of index keys
* to be deleted for an entry that has been replaced.
*
* @param oldEntry The original entry contents.
* @param newEntry The new entry contents.
* @param modifiedKeys The map into which the modified keys will be inserted.
*/
public abstract void replaceEntry(Entry oldEntry, Entry newEntry,
Map<byte[], Boolean> modifiedKeys);
/**
* Generate the set of index keys to be added and the set of index keys
* to be deleted for an entry that was modified.
*
* @param oldEntry The original entry contents.
* @param newEntry The new entry contents.
* @param mods The set of modifications that were applied to the entry.
* @param modifiedKeys The map into which the modified keys will be inserted.
*/
public abstract void modifyEntry(Entry oldEntry, Entry newEntry,
List<Modification> mods,
Map<byte[], Boolean> modifiedKeys);
}