Package de.hybris.platform.solrfacetsearch.indexer

Interface IndexerBatchContext

All Known Implementing Classes:
DefaultIndexerBatchContext
public interface IndexerBatchContext
This interface represents a context valid for the duration of an indexer batch. Each batch runs on a separate thread and this context is only valid for the corresponding thread.

  • 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()
      Returns true if the index operation is external. An external operation does not use a default indexer query.
      Returns:
      true if the index operation is external, false otherwise

    • 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

      List<PK> getPks()
      Return the pks to be indexed in this batch.
      Returns:
      pks to be indexed in this batch.

    • setPks

      void setPks(List<PK> pks)
      Sets the pks to be indexed in this batch.
      Parameters:
      pks - - the pks to be indexed in this batch.

    • getItems

      List<ItemModel> getItems()
      Returns the items to be indexed in this batch.
      Returns:
      items to be indexed in this batch

    • setItems

      void setItems(List<ItemModel> items)
      Sets the items to be indexed in this batch.
      Parameters:
      items - - the items to be indexed in this batch
      Throws:
      IllegalStateException - if this method is called and the status is not IndexerBatchContext.Status.CREATED or IndexerBatchContext.Status.STARTING

    • getIndex

      Index getIndex()
      Returns the index to use during the indexer operation.
      Returns:
      the index to use

    • setIndex

      void setIndex(Index index)
      Sets the index to use during the indexer operation.
      Parameters:
      index - - the index to use

    • getIndexerHints

      Map<String,String> getIndexerHints()
      Returns a mutable Map that can be used to store indexer hints.
      Returns:
      the map containing the indexer hints

    • getAttributes

      Map<String,Object> getAttributes()
      Returns a mutable Map that can be used to store attributes associated with this IndexerBatchContext.
      Returns:
      the map containing the attributes

    • getInputDocuments

      List<InputDocument> getInputDocuments()
      Returns a mutable List that can be used to store attributes associated with this input documents.
      Returns:
      the map containing the indexed property values

    • getStatus

      IndexerBatchContext.Status getStatus()
      Returns the current status for this IndexerBatchContext
      Returns:
      the current status

    • getFailureExceptions

      List<Exception> getFailureExceptions()
      Returns all failure causing exceptions for this IndexerBatchContext.