Interface IndexerContext
- All Known Implementing Classes:
DefaultIndexerContext
public interface IndexerContext
This interface represents a context valid for the duration of an indexer index operation, however it is not valid
inside an indexer batch (an indexer batch may run on a different thread or even on a different machine).
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionReturns a mutableMapthat can be used to store attributes associated with thisIndexerContext.Returns the facet search configuration.Returns all failure causing exceptions for thisIndexerContext.getIndex()Returns the index to use during the indexer operation.Returns the indexed properties to be indexed.Returns the indexed type.Returns a mutableMapthat can be used to store indexer hints.Returns the index operation.longReturns the index operation id.getPks()Returns the pks of the items to be indexed.Returns the current status for thisIndexerContextbooleanReturnstrueif the index operation is external.voidSets the index to use during the indexer operation.voidSets the pks of the items to be indexed.
-
Method Details
-
getIndexOperationId
long getIndexOperationId()Returns the index operation id.- Returns:
- the index operation id
-
getIndexOperation
IndexOperation getIndexOperation()Returns the index operation.- Returns:
- the index operation
-
isExternalIndexOperation
boolean isExternalIndexOperation()Returnstrueif the index operation is external. An external operation does not use a default indexer query.- Returns:
trueif the index operation is external,falseotherwise
-
getFacetSearchConfig
FacetSearchConfig getFacetSearchConfig()Returns the facet search configuration.- Returns:
- the facet search configuration
-
getIndexedType
IndexedType getIndexedType()Returns the indexed type.- Returns:
- the indexed type
-
getIndexedProperties
Collection<IndexedProperty> getIndexedProperties()Returns the indexed properties to be indexed.- Returns:
- the indexed properties to be indexed
-
getPks
Returns the pks of the items to be indexed.- Returns:
- pks of the items to be indexed
-
setPks
Sets the pks of the items to be indexed.- Parameters:
pks- - the pks of the items to be indexed- Throws:
IllegalStateException- if this method is called and the status is notIndexerContext.Status.CREATEDorIndexerContext.Status.STARTING
-
getIndex
Index getIndex()Returns the index to use during the indexer operation.- Returns:
- the index to use
-
setIndex
Sets the index to use during the indexer operation.- Parameters:
index- - the index to use
-
getIndexerHints
Returns a mutableMapthat can be used to store indexer hints.- Returns:
- the map containing the indexer hints
-
getAttributes
Returns a mutableMapthat can be used to store attributes associated with thisIndexerContext.- Returns:
- the map containing the attributes
-
getStatus
IndexerContext.Status getStatus()Returns the current status for thisIndexerContext- Returns:
- the current status
-
getFailureExceptions
Returns all failure causing exceptions for thisIndexerContext.
-