Interface IndexerService
- All Known Implementing Classes:
DefaultIndexerService
public interface IndexerService
Implementations of this interface should be responsible for indexing operations.
-
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteFromIndex(FacetSearchConfig facetSearchConfig) Removes some items from the index.voiddeleteFromIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) Same asdeleteFromIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.voiddeleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Removes some items from the index for a specific type.voiddeleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks) Removes some items from the index for a specific type.voiddeleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks, Map<String, String> indexerHints) Same asdeleteTypeIndex(FacetSearchConfig, IndexedType, List)but allows to pass the indexer hints as parameter.voiddeleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Map<String, String> indexerHints) Same asdeleteTypeIndex(FacetSearchConfig, IndexedType)but allows to pass the indexer hints as parameter.voidperformFullIndex(FacetSearchConfig facetSearchConfig) Performs a full index operation which recreates the index.voidperformFullIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) Same asperformFullIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.voidupdateIndex(FacetSearchConfig facetSearchConfig) Updates some items on the index.voidupdateIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) Same asupdateIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.voidupdatePartialTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<IndexedProperty> indexedProperties, List<PK> pks) Updates some properties of some items on the index for a specific type.voidupdatePartialTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<IndexedProperty> indexedProperties, List<PK> pks, Map<String, String> indexerHints) Same asupdatePartialTypeIndex(FacetSearchConfig, IndexedType, Collection, List)but allows to pass the indexer hints as parameter.voidupdateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType) Updates some items on the index for a specific type.voidupdateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks) Updates some items on the index for a specific type.voidupdateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks, Map<String, String> indexerHints) Same asupdateTypeIndex(FacetSearchConfig, IndexedType, List)but allows to pass the indexer hints as parameter.voidupdateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Map<String, String> indexerHints) Same asupdateTypeIndex(FacetSearchConfig, IndexedType)but allows to pass the indexer hints as parameter.
-
Method Details
-
performFullIndex
Performs a full index operation which recreates the index. All the types associated with the facet search configuration are considered. Items to be indexed are selected based on the full index query.- Parameters:
facetSearchConfig- - configuration for indexer instance- Throws:
IndexerException- exception is thrown when full index query is missing in configuration or an unexpected error occurs during indexing.
-
performFullIndex
void performFullIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) throws IndexerExceptionSame asperformFullIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when full index query is missing in configuration or an unexpected error occurs during indexing.
-
updateIndex
Updates some items on the index. All the types associated with the facet search configuration are considered. Items to be updated are selected based on the update index query.- Parameters:
facetSearchConfig- - configuration for indexer instance- Throws:
IndexerException- exception is thrown when update index query is missing in configuration or an unexpected error occurs during indexing.
-
updateIndex
void updateIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) throws IndexerExceptionSame asupdateIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when update index query is missing in configuration or an unexpected error occurs during indexing.
-
updateTypeIndex
void updateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType) throws IndexerException Updates some items on the index for a specific type. Items to be updated are selected based on the update index query.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected type- Throws:
IndexerException- exception is thrown when update index query is missing in configuration or an unexpected error occurs during indexing.
-
updateTypeIndex
void updateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Map<String, String> indexerHints) throws IndexerExceptionSame asupdateTypeIndex(FacetSearchConfig, IndexedType)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typeindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when update index query is missing in configuration or an unexpected error occurs during indexing.
-
updateTypeIndex
void updateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks) throws IndexerException Updates some items on the index for a specific type.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typepks- - pks of items to be updated- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-
updateTypeIndex
void updateTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks, Map<String, String> indexerHints) throws IndexerExceptionSame asupdateTypeIndex(FacetSearchConfig, IndexedType, List)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typepks- - pks of items to be updatedindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-
updatePartialTypeIndex
void updatePartialTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<IndexedProperty> indexedProperties, List<PK> pks) throws IndexerException Updates some properties of some items on the index for a specific type.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typeindexedProperties- - properties to updatepks- - pks of items to be updated- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-
updatePartialTypeIndex
void updatePartialTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<IndexedProperty> indexedProperties, List<PK> pks, Map<String, String> indexerHints) throws IndexerExceptionSame asupdatePartialTypeIndex(FacetSearchConfig, IndexedType, Collection, List)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typeindexedProperties- - properties to updatepks- - pks of items to be updatedindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-
deleteFromIndex
Removes some items from the index. All the types associated with the facet search configuration are considered. Items to be removed are selected based on the delete index query.- Parameters:
facetSearchConfig- - configuration for indexer instance- Throws:
IndexerException- exception is thrown when delete index query is missing in configuration or an unexpected error occurs during indexing.
-
deleteFromIndex
void deleteFromIndex(FacetSearchConfig facetSearchConfig, Map<String, String> indexerHints) throws IndexerExceptionSame asdeleteFromIndex(FacetSearchConfig)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when delete index query is missing in configuration or an unexpected error occurs during indexing.
-
deleteTypeIndex
void deleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType) throws IndexerException Removes some items from the index for a specific type. Items to be removed are selected based on the delete index query.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected type- Throws:
IndexerException- exception is thrown when delete index query is missing in configuration or an unexpected error occurs during indexing.
-
deleteTypeIndex
void deleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Map<String, String> indexerHints) throws IndexerExceptionSame asdeleteTypeIndex(FacetSearchConfig, IndexedType)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typeindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when delete index query is missing in configuration or an unexpected error occurs during indexing.
-
deleteTypeIndex
void deleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks) throws IndexerException Removes some items from the index for a specific type.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typepks- - pks of items to be removed- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-
deleteTypeIndex
void deleteTypeIndex(FacetSearchConfig facetSearchConfig, IndexedType indexedType, List<PK> pks, Map<String, String> indexerHints) throws IndexerExceptionSame asdeleteTypeIndex(FacetSearchConfig, IndexedType, List)but allows to pass the indexer hints as parameter.- Parameters:
facetSearchConfig- - configuration for indexer instanceindexedType- - selected typepks- - pks of items to be removedindexerHints- - the indexer hints- Throws:
IndexerException- exception is thrown when an unexpected error occurs during indexing.
-