org.compass.core.engine.subindex
Interface SubIndexHash

All Known Implementing Classes:

ConstantSubIndexHash, ModuloSubIndexHash

public interface SubIndexHash

Reprensetns a set of sub indexes, and knows how to map a single sub index value from an alias and a set of Property ids.

This allows to have different mappings from Resource to a specific sub index.

Author:

kimchy

Method Summary

String[]	getSubIndexes() Returns all the sub indexes that mapSubIndex(String,org.compass.core.Property[]) might be generating.
String	mapSubIndex(String alias, Property[] ids) Computes a sub index based on the given alias and ids.

Method Detail

getSubIndexes

String[] getSubIndexes()

Returns all the sub indexes that mapSubIndex(String,org.compass.core.Property[]) might be generating.

mapSubIndex

String mapSubIndex(String alias,
                   Property[] ids)
                   throws SearchEngineException

Computes a sub index based on the given alias and ids.

Parameters:

alias - The alias to compute the sub index by (optional)

ids - The set of ids to compute the sub index by (optional)

Returns:

The hashed sub index

Throws:

SearchEngineException