Package org.hibernate.search.backend.lucene.index.impl

Class ExplicitShardingStrategy

java.lang.Object

org.hibernate.search.backend.lucene.index.impl.ExplicitShardingStrategy

All Implemented Interfaces:

ShardingStrategy

public class ExplicitShardingStrategy
extends Object
implements ShardingStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
ExplicitShardingStrategy()

Method Summary

Modifier and Type	Method	Description
void	initialize(ShardingStrategyInitializationContext context)	Initializes the sharding strategy.
String	toShardIdentifier(String documentId, String routingKey)	Returns the shard identifier corresponding to the given document ID and routing key.
Set<String>	toShardIdentifiers(Set<String> routingKeys)	Returns all the shard identifiers that can be assigned to the given routing keys by ShardingStrategy.toShardIdentifier(String, String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ExplicitShardingStrategy

public ExplicitShardingStrategy()

Method Detail

initialize

public void initialize(ShardingStrategyInitializationContext context)

Description copied from interface: ShardingStrategy

Initializes the sharding strategy.

Specified by:

initialize in interface ShardingStrategy

Parameters:

context - The initialization context, giving access to configuration and environment. The sharding strategy is expected to call ShardingStrategyInitializationContext.shardIdentifiers(Set).

toShardIdentifier

public String toShardIdentifier(String documentId,
                                String routingKey)

Description copied from interface: ShardingStrategy

Returns the shard identifier corresponding to the given document ID and routing key.

Called in particular when indexing documents.

Specified by:

toShardIdentifier in interface ShardingStrategy

Parameters:

documentId - A document identifier. Never null.

routingKey - A routing key. Never null.

Returns:

A shard identifiers corresponding to the given document ID and routing key. Never null.

toShardIdentifiers

public Set<String> toShardIdentifiers(Set<String> routingKeys)

Description copied from interface: ShardingStrategy

Returns all the shard identifiers that can be assigned to the given routing keys by ShardingStrategy.toShardIdentifier(String, String).

Called in particular when searching.

Specified by:

toShardIdentifiers in interface ShardingStrategy

Parameters:

routingKeys - A set of routing keys. Never null, never empty.

Returns:

All the shard identifiers that can be assigned to the given routing keys.