Package com.broadleafcommerce.search.index.core.document

Interface DocumentBuilder<T>

Type Parameters:
T - The indexable documents type.
All Known Subinterfaces:
IndexableTypeDocumentBuilder<I,T>
All Known Implementing Classes:
AbstractDocumentBuilder
public interface DocumentBuilder<T>
Documents builder to be used when building data to be indexed.

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<T>
    buildDocuments(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)
     
    List<T>
    buildDocuments(List<? extends com.broadleafcommerce.search.api.domain.Indexable<?>> indexables)
    Build documents to be indexed by the search engine.

  • Method Details

    • buildDocuments

      List<T> buildDocuments(List<? extends com.broadleafcommerce.search.api.domain.Indexable<?>> indexables) throws com.broadleafcommerce.search.api.SearchIndexException
      Build documents to be indexed by the search engine. If the indexable has any trackable behavior, then the parameter indexables should include all objects sharing the same ID.
      Parameters:
      indexables - The indexables to be converted into documents.
      Returns:
      The documents to index, including IDs of any documents to be deleted from the index.
      Throws:
      com.broadleafcommerce.search.api.SearchIndexException - if an error occurs preventing indexing

    • buildDocuments

      default List<T> buildDocuments(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)