Package org.codelibs.fess.ingest

Class Ingester

java.lang.Object
org.codelibs.fess.ingest.Ingester
public abstract class Ingester extends Object
Abstract base class for document ingesters that process and transform documents before they are indexed. Ingesters can be used to modify document content, extract additional metadata, or perform other transformations during the indexing process. Ingesters are processed in priority order, with lower numbers having higher priority.

  • Field Details

    • priority

      protected int priority
      Priority of this ingester (lower numbers = higher priority)

  • Constructor Details

    • Ingester

      public Ingester()
      Default constructor.

  • Method Details

    • getPriority

      public int getPriority()
      Gets the priority of this ingester. Lower numbers indicate higher priority.
      Returns:
      the priority value

    • setPriority

      public void setPriority(int priority)
      Sets the priority of this ingester. Lower numbers indicate higher priority.
      Parameters:
      priority - the priority value to set

    • register

      public void register()
      Registers this ingester with the ingest factory. This makes the ingester available for processing documents.

    • getIngestFactory

      protected IngestFactory getIngestFactory()
      Gets the ingest factory instance for managing ingesters.
      Returns:
      the ingest factory instance

    • process

      public org.codelibs.fess.crawler.entity.ResultData process(org.codelibs.fess.crawler.entity.ResultData target, org.codelibs.fess.crawler.entity.ResponseData responseData)
      Processes a result data object for web/file crawling. Default implementation returns the target unchanged.
      Parameters:
      target - the result data to process
      responseData - the response data from crawling
      Returns:
      the processed result data

    • process

      public Map<String,Object> process(Map<String,Object> target, org.codelibs.fess.crawler.entity.AccessResult<String> accessResult)
      Processes a document map for web/file crawling with access result. Default implementation delegates to the basic process method.
      Parameters:
      target - the document data to process
      accessResult - the access result from crawling
      Returns:
      the processed document data

    • process

      public Map<String,Object> process(Map<String,Object> target, DataStoreParams params)
      Processes a document map for datastore operations. Default implementation delegates to the basic process method.
      Parameters:
      target - the document data to process
      params - the data store parameters
      Returns:
      the processed document data

    • process

      protected Map<String,Object> process(Map<String,Object> target)
      Basic processing method that other process methods delegate to. Default implementation returns the target unchanged. Subclasses should override this method to implement specific processing logic.
      Parameters:
      target - the document data to process
      Returns:
      the processed document data