Package org.ametys.cms.indexing.solr

Interface AdditionalDataIndexer

All Known Subinterfaces:
AdditionalWebDataIndexer
All Known Implementing Classes:
AIAdditionalDataIndexer
public interface AdditionalDataIndexer
Index additional items on already indexed object (content, resources...).

  • Field Details

  • Method Details

    • getSupportedTypes

      Collection<String> getSupportedTypes()
      Get the object/document types supported by this indexer.
      Returns:
      The object or document types supported by this indexer.

    • indexAdditionalDocuments

      List<org.apache.solr.common.SolrInputDocument> indexAdditionalDocuments(AmetysObject object, org.apache.solr.common.SolrInputDocument document)
      Index additional object properties in the corresponding document.
      Parameters:
      object - The object to index.
      document - The destination document.
      Returns:
      Additional documents to index (can be empty).

    • getUnindexObjectQuery

      List<Query> getUnindexObjectQuery(String ametysObjectId) throws Exception
      The list of Solr queries that returns the documents to delete when unindexing the given ametys object
      Parameters:
      ametysObjectId - The id of the ametys object to unindex
      Returns:
      The list of Solr queries that returns the documents to delete
      Throws:
      Exception - If an error occurs while building the queries

    • getUnindexAllQuery

      Query getUnindexAllQuery(String type) throws Exception
      The solr query that returns the documents to delete when unindexing all items of the given type
      Parameters:
      type - The type of the items to unindex
      Returns:
      The solr query that returns the documents to delete. Can be null
      Throws:
      Exception - If an error occurs while building the queries

    • getSchemaDefinitions

      Collection<SchemaDefinition> getSchemaDefinitions()
      Get the schema definitions used by this indexer.
      Returns:
      The schema definitions used by this indexer.