org.locationtech.geowave.core.index.text

Class TextIndexStrategy<E>

java.lang.Object

org.locationtech.geowave.core.index.text.TextIndexStrategy<E>

All Implemented Interfaces:

CustomIndexStrategy<E,TextConstraints>, Persistable

public class TextIndexStrategy<E>
extends Object
implements CustomIndexStrategy<E,TextConstraints>

Nested Class Summary

Nested classes/interfaces inherited from interface org.locationtech.geowave.core.index.CustomIndexStrategy

CustomIndexStrategy.PersistableBiPredicate<E,C extends Persistable>

Constructor Summary

Constructors

Constructor and Description
TextIndexStrategy()
TextIndexStrategy(EnumSet<TextSearchType> supportedSearchTypes, EnumSet<CaseSensitivity> supportedCaseSensitivity, int nCharacterGrams, TextIndexEntryConverter<E> converter)
TextIndexStrategy(EnumSet<TextSearchType> supportedSearchTypes, EnumSet<CaseSensitivity> caseSensitivity, TextIndexEntryConverter<E> converter)
TextIndexStrategy(TextIndexEntryConverter<E> converter)

Method Summary

Modifier and Type	Method and Description
protected String	entryToString(E entry)
void	fromBinary(byte[] bytes) Convert a stream of binary bytes to fields and data within an object.
protected void	fromBinary(ByteBuffer buf)
Class<TextConstraints>	getConstraintsClass()
TextIndexEntryConverter<E>	getEntryConverter()
CustomIndexStrategy.PersistableBiPredicate<E,TextConstraints>	getFilter(TextConstraints constraints) Optionally a custom index strategy can enable additional filtering beyond just the query ranges (termed "fine-grained" filtering in documentation).
InsertionIds	getInsertionIds(E entry) This is the function that is called on ingest to tell GeoWave how to index the entry within this custom index - the insertion IDs are a set of partition and sort keys, either of which could be empty or null as needed (with the understanding that each partition key represents a unique partition in the backend datastore)
QueryRanges	getQueryRanges(MultiDimensionalTextData textData)
QueryRanges	getQueryRanges(TextConstraints constraints) This is the function that is called on query, when given a query with the constraints type.
boolean	isSupported(CaseSensitivity caseSensitivity)
boolean	isSupported(TextSearchType searchType)
byte[]	toBinary() Convert fields and data within an object to binary form for transmission or storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextIndexStrategy

public TextIndexStrategy()

TextIndexStrategy

public TextIndexStrategy(TextIndexEntryConverter<E> converter)

TextIndexStrategy

public TextIndexStrategy(EnumSet<TextSearchType> supportedSearchTypes,
                         EnumSet<CaseSensitivity> caseSensitivity,
                         TextIndexEntryConverter<E> converter)

TextIndexStrategy

public TextIndexStrategy(EnumSet<TextSearchType> supportedSearchTypes,
                         EnumSet<CaseSensitivity> supportedCaseSensitivity,
                         int nCharacterGrams,
                         TextIndexEntryConverter<E> converter)

Method Detail

getEntryConverter

public TextIndexEntryConverter<E> getEntryConverter()

isSupported

public boolean isSupported(TextSearchType searchType)

isSupported

public boolean isSupported(CaseSensitivity caseSensitivity)

toBinary

public byte[] toBinary()

Description copied from interface: Persistable

Convert fields and data within an object to binary form for transmission or storage.

Specified by:

toBinary in interface Persistable

Returns:

an array of bytes representing a binary stream representation of the object.

fromBinary

public void fromBinary(byte[] bytes)

Description copied from interface: Persistable

Convert a stream of binary bytes to fields and data within an object.

Specified by:

fromBinary in interface Persistable

fromBinary

protected void fromBinary(ByteBuffer buf)

getInsertionIds

public InsertionIds getInsertionIds(E entry)

Description copied from interface: CustomIndexStrategy

This is the function that is called on ingest to tell GeoWave how to index the entry within this custom index - the insertion IDs are a set of partition and sort keys, either of which could be empty or null as needed (with the understanding that each partition key represents a unique partition in the backend datastore)

Specified by:

getInsertionIds in interface CustomIndexStrategy<E,TextConstraints>

Parameters:

entry - the entry to be indexed on ingest

Returns:

the insertion IDs representing how to index the entry

getQueryRanges

public QueryRanges getQueryRanges(TextConstraints constraints)

Description copied from interface: CustomIndexStrategy

This is the function that is called on query, when given a query with the constraints type. The constraints type can be any arbitrary type although should be persistable so that it can work outside of just client code (such as server-side filtering, map-reduce, or spark). The query ranges are a set of partition keys and ranges of sort keys that fully include all rows that may match the constraints.

Specified by:

getQueryRanges in interface CustomIndexStrategy<E,TextConstraints>

Parameters:

constraints - the query constraints

Returns:

query ranges that represent valid partition and ranges of sort keys that fully include all rows that may match the constraints

getQueryRanges

public QueryRanges getQueryRanges(MultiDimensionalTextData textData)

getFilter

public CustomIndexStrategy.PersistableBiPredicate<E,TextConstraints> getFilter(TextConstraints constraints)

Description copied from interface: CustomIndexStrategy

Optionally a custom index strategy can enable additional filtering beyond just the query ranges (termed "fine-grained" filtering in documentation). This requires reading rows from disk and evaluating a predicate so it is inherently slower than using query ranges but it is flexible enough to handle any additional evaluation criteria required.

Specified by:

getFilter in interface CustomIndexStrategy<E,TextConstraints>

Returns:

A predicate that should be used for "fine-grained" filter evaluation

entryToString

protected String entryToString(E entry)

getConstraintsClass

public Class<TextConstraints> getConstraintsClass()

Specified by:

getConstraintsClass in interface CustomIndexStrategy<E,TextConstraints>