org.hibernate.search.store.ShardIdentifierProvider Maven / Gradle / Ivy
Show all versions of hibernate-search-engine Show documentation
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.search.store;
import java.io.Serializable;
import java.util.Properties;
import java.util.Set;
import org.apache.lucene.document.Document;
import org.hibernate.search.filter.FullTextFilterImplementor;
import org.hibernate.search.spi.BuildContext;
/**
* Implementations provide the identifiers of those shards to be taken into account by the engine when working with
* specified entities or queries.
*
* Implementation notes:
*
* With exception of the {@link ShardIdentifierProvider#initialize(Properties, BuildContext)} method which is invoked
* only once at startup, all other methods could be invoked in parallel by independent threads; implementations must
* thus be thread-safe.
*
* Instead of implementing this interface directly, implementations should be derived from
* {@link ShardIdentifierProviderTemplate} as new methods might be added to this interface in future releases.
*
* @hsearch.experimental The exact method signatures are likely to change in future.
*
* @author Emmanuel Bernard
* @author Hardy Ferentschik
* @author Sanne Grinovero (C) 2013 Red Hat Inc.
*/
public interface ShardIdentifierProvider {
/**
* Initialize this provider.
*
* This method is invoked only once per instance and before any other method is invoked.
*
* @param properties The configuration properties
* @param buildContext The build context available during bootstrapping
*/
void initialize(Properties properties, BuildContext buildContext);
/**
* Determine the shard identifier for the given entity.
*
* Note: Implementations will usually inspect a specific fieldable of the document in order to determine the shard
* identifier, for example a customer id or a language code.
*
* Concurrency: this method could be invoked concurrently. That means you could have multiple invocations of
* {@link #getShardIdentifier(Class, Serializable, String, Document)}, {@link #getShardIdentifiersForQuery(FullTextFilterImplementor[])},
* {@link #getAllShardIdentifiers()}.
*
* @param entityType the type of the entity
* @param id the id of the entity
* @param idAsString the entity id transformed as string via the appropriate document id bridge
* @param document the Lucene document for the entity with the given id
*
* @return the shard identifier to which the entity specified by the given parameters belongs to.
*/
String getShardIdentifier(Class entityType, Serializable id, String idAsString, Document document);
/**
* Returns the set of shard identifiers for a query given the applied filters.
*
* The method allows to limit the shards a given query targets depending on the selected filters.
*
* Concurrency: this method could be invoked concurrently. That means you could have multiple invocations of
* {@link #getShardIdentifier(Class, Serializable, String, Document)}, {@link #getShardIdentifiersForQuery(FullTextFilterImplementor[])},
* {@link #getAllShardIdentifiers()}.
*
* @param fullTextFilters the filters which are applied to the current query
*
* @return the set of shard identifiers this query should target
*/
Set getShardIdentifiersForQuery(FullTextFilterImplementor[] fullTextFilters);
/**
* Returns the set of shard identifiers for a deletion.
*
* @param entity the type of the deleted entity
* @param id the id or null
* @param idInString the transformed id or null
* @return the target IndexManager for the deletion operation
*/
Set getShardIdentifiersForDeletion(Class entity, Serializable id, String idInString);
/**
* Returns the list of all currently known shard identifiers.
*
* Note: The list can vary between calls!
*
* Concurrency: this method could be invoked concurrently. That means you could have multiple invocations of
* {@link #getShardIdentifier(Class, Serializable, String, Document)}, {@link #getShardIdentifiersForQuery(FullTextFilterImplementor[])},
* {@link #getAllShardIdentifiers()}.
*
* @return the set of all currently known shard identifiers.
*/
Set getAllShardIdentifiers();
}