Package org.codelibs.fess.app.service

Class ElevateWordService

java.lang.Object
org.codelibs.fess.app.service.ElevateWordService
public class ElevateWordService extends Object
Service class for managing elevate words functionality. Elevate words are used to boost the relevance of documents containing specific terms in search results. This service provides CRUD operations, CSV import/export, and related functionality.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codelibs.fess.opensearch.config.exbhv.ElevateWordBhv
    elevateWordBhv
    Behavior handler for ElevateWord entity operations
    protected org.codelibs.fess.opensearch.config.exbhv.ElevateWordToLabelBhv
    elevateWordToLabelBhv
    Behavior handler for ElevateWordToLabel entity operations
    protected org.codelibs.fess.mylasta.direction.FessConfig
    fessConfig
    Configuration settings for Fess application
    protected org.codelibs.fess.opensearch.config.exbhv.LabelTypeBhv
    labelTypeBhv
    Behavior handler for LabelType entity operations
    protected SearchEngineClient
    searchEngineClient
    Client for interacting with the search engine

  • Constructor Summary

    Constructors
    Constructor
    Description
    ElevateWordService()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(org.codelibs.fess.opensearch.config.exentity.ElevateWord elevateWord)
    Deletes an elevate word from the system.
    void
    exportCsv(Writer writer)
    Exports elevate words to a CSV file.
    org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.ElevateWord>
    getElevateWord(String id)
    Retrieves a specific elevate word by its ID, including associated label type information.
    List<org.codelibs.fess.opensearch.config.exentity.ElevateWord>
    getElevateWordList(ElevateWordPager elevateWordPager)
    Retrieves a paginated list of elevate words based on the provided pager criteria.
    void
    importCsv(Reader reader)
    Imports elevate words from a CSV file.
    protected void
    setupListCondition(org.codelibs.fess.opensearch.config.cbean.ElevateWordCB cb, ElevateWordPager elevateWordPager)
    Sets up the condition builder for querying elevate words based on pager criteria.
    void
    store(org.codelibs.fess.opensearch.config.exentity.ElevateWord elevateWord)
    Stores (inserts or updates) an elevate word and manages its associated label type mappings.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • elevateWordToLabelBhv

      protected org.codelibs.fess.opensearch.config.exbhv.ElevateWordToLabelBhv elevateWordToLabelBhv
      Behavior handler for ElevateWordToLabel entity operations

    • elevateWordBhv

      protected org.codelibs.fess.opensearch.config.exbhv.ElevateWordBhv elevateWordBhv
      Behavior handler for ElevateWord entity operations

    • labelTypeBhv

      protected org.codelibs.fess.opensearch.config.exbhv.LabelTypeBhv labelTypeBhv
      Behavior handler for LabelType entity operations

    • fessConfig

      protected org.codelibs.fess.mylasta.direction.FessConfig fessConfig
      Configuration settings for Fess application

    • searchEngineClient

      protected SearchEngineClient searchEngineClient
      Client for interacting with the search engine

  • Constructor Details

    • ElevateWordService

      public ElevateWordService()
      Default constructor.

  • Method Details

    • getElevateWordList

      public List<org.codelibs.fess.opensearch.config.exentity.ElevateWord> getElevateWordList(ElevateWordPager elevateWordPager)
      Retrieves a paginated list of elevate words based on the provided pager criteria.
      Parameters:
      elevateWordPager - the pager containing pagination and filtering criteria
      Returns:
      list of elevate words matching the criteria

    • getElevateWord

      public org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.ElevateWord> getElevateWord(String id)
      Retrieves a specific elevate word by its ID, including associated label type information.
      Parameters:
      id - the unique identifier of the elevate word
      Returns:
      OptionalEntity containing the elevate word if found, or empty if not found

    • store

      public void store(org.codelibs.fess.opensearch.config.exentity.ElevateWord elevateWord)
      Stores (inserts or updates) an elevate word and manages its associated label type mappings.
      Parameters:
      elevateWord - the elevate word entity to store

    • delete

      public void delete(org.codelibs.fess.opensearch.config.exentity.ElevateWord elevateWord)
      Deletes an elevate word from the system.
      Parameters:
      elevateWord - the elevate word entity to delete

    • setupListCondition

      protected void setupListCondition(org.codelibs.fess.opensearch.config.cbean.ElevateWordCB cb, ElevateWordPager elevateWordPager)
      Sets up the condition builder for querying elevate words based on pager criteria.
      Parameters:
      cb - the condition builder to configure
      elevateWordPager - the pager containing search criteria

    • importCsv

      public void importCsv(Reader reader)
      Imports elevate words from a CSV file. Expected CSV format: SuggestWord, Reading, Permissions, Labels, Boost
      Parameters:
      reader - the Reader containing CSV data to import

    • exportCsv

      public void exportCsv(Writer writer)
      Exports elevate words to a CSV file. CSV format: SuggestWord, Reading, Permissions, Labels, Boost
      Parameters:
      writer - the Writer to output CSV data to