de.hybris.platform.solrfacetsearch.indexer.spi

Interface Indexer

All Known Implementing Classes:

DefaultIndexer

public interface Indexer

Indexer delivers functionality for storing and removing hybris items in indexer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Indexer.CommitType Deprecated. since 6.2, use SolrSearchProvider.CommitType instead

Method Summary

Modifier and Type	Method and Description
void	commit(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Index index, Indexer.CommitType commitType) Deprecated. since 6.2, use SolrSearchProvider.commit(Index, SolrSearchProvider.CommitType) instead
Collection<SolrInputDocument>	indexItems(Collection<ItemModel> items, FacetSearchConfig facetSearchConfig, IndexedType indexedType) Method send items to indexer.
Collection<SolrInputDocument>	indexItems(Collection<ItemModel> items, FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<IndexedProperty> indexedProperties) Method send items to indexer.
void	optimize(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Index index) Deprecated. since 6.2, use SolrSearchProvider.optimize(Index) instead
void	removeAllItems(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Index index) Deprecated. since 6.2, use SolrSearchProvider.deleteAllDocuments(Index) instead
Collection<String>	removeItems(Collection<ItemModel> items, FacetSearchConfig facetSearchConfig, IndexedType indexedType) Deprecated. since 6.3, use SolrSearchProvider#deleteDocumentsByPK(Index, List) instead
void	removeItemsByPk(Collection<PK> pks, FacetSearchConfig facetSearchConfig, IndexedType indexedType, Index index)
void	removeItemsByQuery(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Index index, String query) Deprecated. since 6.2, use SolrSearchProvider.deleteOldDocuments(Index, long) instead

Method Detail

indexItems

Collection<SolrInputDocument> indexItems(Collection<ItemModel> items,
                                         FacetSearchConfig facetSearchConfig,
                                         IndexedType indexedType)
                                  throws IndexerException,
                                         InterruptedException

Method send items to indexer.

Parameters:

items - items for send to indexer in one transaction

facetSearchConfig - configuration of facet search

indexedType - indexed type definition

Returns:

list of items converted to solrDocuments

Throws:

IndexerException - if an error occurs during indexing

InterruptedException - if any thread interrupted the current thread before before it completed indexing. The interrupted status of the current thread is cleared when this exception is thrown.

indexItems

Collection<SolrInputDocument> indexItems(Collection<ItemModel> items,
                                         FacetSearchConfig facetSearchConfig,
                                         IndexedType indexedType,
                                         Collection<IndexedProperty> indexedProperties)
                                  throws IndexerException,
                                         InterruptedException

Method send items to indexer.

Parameters:

items - items for send to indexer in one transaction

facetSearchConfig - configuration of facet search

indexedType - indexed type definition

indexedProperties - the properties to index

Returns:

list of items converted to solrDocuments

Throws:

IndexerException - if an error occurs during indexing

InterruptedException - if any thread interrupted the current thread before before it completed indexing. The interrupted status of the current thread is cleared when this exception is thrown.

removeItemsByPk

void removeItemsByPk(Collection<PK> pks,
                     FacetSearchConfig facetSearchConfig,
                     IndexedType indexedType,
                     Index index)
              throws IndexerException,
                     InterruptedException

Parameters:

pks - - list of pks to be removed

facetSearchConfig - - the facet search configuration

indexedType - - the indexed type

Throws:

InterruptedException - if any thread interrupted the current thread before before it completed indexing. The interrupted status of the current thread is cleared when this exception is thrown.

IndexerException

removeItems

@Deprecated
Collection<String> removeItems(Collection<ItemModel> items,
                                           FacetSearchConfig facetSearchConfig,
                                           IndexedType indexedType)
                                    throws IndexerException,
                                           InterruptedException

Deprecated. since 6.3, use SolrSearchProvider#deleteDocumentsByPK(Index, List) instead

Remove from index all items by indexer identifiers.

Parameters:

items - items for send to indexer in one transaction

facetSearchConfig - configuration of facet search

indexedType - indexed type definition

Returns:

collection of solrDocumentIds

Throws:

IndexerException - if an error occurs during indexing

InterruptedException - if any thread interrupted the current thread before before it completed indexing. The interrupted status of the current thread is cleared when this exception is thrown.

removeAllItems

@Deprecated
void removeAllItems(FacetSearchConfig facetSearchConfig,
                                IndexedType indexedType,
                                Index index)
                         throws IndexerException

Deprecated. since 6.2, use SolrSearchProvider.deleteAllDocuments(Index) instead

Remove all items from index

Parameters:

facetSearchConfig - facet search configuration

indexedType - indexed type definition

index - index

Throws:

IndexerException

removeItemsByQuery

@Deprecated
void removeItemsByQuery(FacetSearchConfig facetSearchConfig,
                                    IndexedType indexedType,
                                    Index index,
                                    String query)
                             throws IndexerException

Deprecated. since 6.2, use SolrSearchProvider.deleteOldDocuments(Index, long) instead

Removes items from the index based on a specific query.

Parameters:

facetSearchConfig - - the facet search configuration

indexedType - - the indexed type

index - - the index

query - - the raw query

Throws:

IndexerException

commit

@Deprecated
void commit(FacetSearchConfig facetSearchConfig,
                        IndexedType indexedType,
                        Index index,
                        Indexer.CommitType commitType)
                 throws IndexerException

Deprecated. since 6.2, use SolrSearchProvider.commit(Index, SolrSearchProvider.CommitType) instead

Performs a commit on the given index. An hard commit makes sure that indexed documents are persisted and visible, a soft commit makes sure indexed documents are visible.

Parameters:

facetSearchConfig - - the facet search configuration

indexedType - - the indexed type

index - - the index

commitType - - the commit type

Throws:

IndexerException - if an error occurs during the commit

optimize

@Deprecated
void optimize(FacetSearchConfig facetSearchConfig,
                          IndexedType indexedType,
                          Index index)
                   throws IndexerException

Deprecated. since 6.2, use SolrSearchProvider.optimize(Index) instead

Optimizes a given index. It does not wait for the operation to complete.

Parameters:

facetSearchConfig - - the facet search configuration

indexedType - - the indexed type

index - - the index

Throws:

IndexerException - if an error occurs during the commit