Package org.codelibs.fess.job

Interface IndexExportFormatter

All Known Implementing Classes:
HtmlIndexExportFormatter, JsonIndexExportFormatter
public interface IndexExportFormatter
Strategy interface for formatting exported index documents.

  • Method Details

    • getFileExtension

      String getFileExtension()
      Returns the file extension for this format (e.g. ".html", ".json").
      Returns:
      the file extension including the leading dot

    • getIndexFileName

      String getIndexFileName()
      Returns the default index file name for this format (e.g. "index.html", "index.json").
      Returns:
      the index file name

    • format

      String format(Map<String,Object> source, Set<String> excludeFields)
      Formats a document source map into the target format string.
      Parameters:
      source - the document source map
      excludeFields - the set of field names to exclude from output
      Returns:
      the formatted string