/*
|
* 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 2008-2009 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api;
|
|
import java.util.Collection;
|
import org.opends.server.types.ByteString;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.IndexConfig;
|
|
|
/**
|
* This class defines the set of methods and structures that must be
|
* implemented by a Directory Server module that implements an
|
* Extensible matching rule.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate=false,
|
mayExtend=true,
|
mayInvoke=false)
|
public abstract class ExtensibleMatchingRule extends MatchingRule
|
{
|
/**
|
* Returns a collection of extensible indexers associated with this
|
* matching rule.
|
* @param config The index configuration to be used by this
|
* matching rule.
|
* @return ExtensibleIndexer associated with this matching rule.
|
*/
|
public abstract Collection<ExtensibleIndexer> getIndexers(
|
IndexConfig config);
|
|
|
|
|
/**
|
* Queries the index using factory of type T and returns
|
* a query of type T for the provided assertion value.
|
* @param <T> The type of IndexQueryFactory.
|
* @param assertionValue An assertion value which needs to be
|
* queried.
|
* @param factory An IndexQueryFactory which will be used for
|
* creating queries.
|
* @return T The generated index query.
|
* @throws DirectoryException If an error occurs while generating
|
* the query.
|
*/
|
public abstract <T> T createIndexQuery(
|
ByteString assertionValue,
|
IndexQueryFactory<T> factory)
|
throws DirectoryException;
|
}
|
