Class LuceneCategorySearchEngine

java.lang.Object
com.jalios.jcms.search.LuceneDataSearchEngine
com.jalios.jcms.search.LuceneCategorySearchEngine
All Implemented Interfaces:
JcmsConstants, CategorySearchEngine, JaliosConstants

public class LuceneCategorySearchEngine extends LuceneDataSearchEngine implements CategorySearchEngine, JcmsConstants
This CategorySearchEngine is reponsible for the indexing and searching of JCMS content using lucene.

Architecture and notable points:
  • 1 lucene index per language: WEB-INF/data/lucene/CategoriesIndices/<lang>/.
  • 1 Document per indexed Category.
  • Indices' optimization occurs using schedule specified by property "search-engine.optimize-schedule" (jdring's AlarmEntry cron-like format)

Possible Hooks/Modification:
  • Specify analyzer for each language: Analyzer getAnalyzer(String lang);
Since:
jcms-5.5.0
  • Field Details

  • Constructor Details

    • LuceneCategorySearchEngine

      public LuceneCategorySearchEngine() throws Exception
      Initialize the Lucene Search Engine
      Throws:
      Exception - if error occurs during initialization
  • Method Details

    • add

      public void add(Category cat)
      Add given Category to this lucene search engine.
      Specified by:
      add in interface CategorySearchEngine
      Parameters:
      cat - the Category to index .
    • update

      public void update(Category cat)
      Update given Category in this lucene search engine.
      Specified by:
      update in interface CategorySearchEngine
      Parameters:
      cat - the Category to reindex .
    • delete

      public void delete(Category cat)
      Delete given Category from this lucene search engine.
      Specified by:
      delete in interface CategorySearchEngine
      Parameters:
      cat - the Category to reindex .
    • add

      public void add(Collection<Category> coll)
      Add given Collection of Category to this lucene search engine.
      Specified by:
      add in interface CategorySearchEngine
      Parameters:
      coll - the Collection of Category to index .
    • update

      public void update(Collection<Category> coll)
      Update given Collection of Category in this lucene search engine.
      Specified by:
      update in interface CategorySearchEngine
      Parameters:
      coll - the Collection of Category to reindex .
    • delete

      public void delete(Collection<Category> coll)
      Delete given Collection of Category from this lucene search engine.
      Specified by:
      delete in interface CategorySearchEngine
      Parameters:
      coll - the Collection of Category to reindex .
    • getIndexingDate

      public Date getIndexingDate(Category cat)
      Retrieve the Date at which the specified Category was indexed in the search engine.
      Specified by:
      getIndexingDate in interface CategorySearchEngine
      Parameters:
      cat - the Category for which to retrieve the indexing date.
      Returns:
      the indexing date of the category or null if was not indexed.
      Since:
      jcms-6.0.1
    • getReindexAllAction

      protected AdminSearchEnginesHandler.Action getReindexAllAction()
      Description copied from class: LuceneDataSearchEngine
      Returns the AdminSearchEnginesHandler.Action to use when starting an AdminSearchEngineProcess for a full reindex.
      Specified by:
      getReindexAllAction in class LuceneDataSearchEngine
    • search

      public boolean search(QueryHandler qh, HashSet<? extends Publication> pubSet, QueryResultSet resultSet)
      Description copied from interface: CategorySearchEngine
      Perform a full-text search.
      Specified by:
      search in interface CategorySearchEngine
      Parameters:
      qh - the Queryhandler in which to find search text and search options.
      pubSet - a HashSet containing all the Publication to search.
      if empty, search is not performed at all.
      if null, all Publication found will be returned.
      This set MUST NOT be modified by implementation.
      resultSet - the QueryResultSet that must be filled with matching Publication
      Returns:
      true if a search was performed in the CategorySearchEngine. Useful to differenciate a query returning zero result from a query not performed due to missing paramerters (text for example).
    • getMaximumResults

      public static int getMaximumResults()
      Retrieve the maximum number of results allowed to be return for a search.

      Can be configured using property query.lucene.cat.max-results

      Returns:
      a maximum number of result retrieve (result beyong this limit are ignored)
      Since:
      jcms-10.0.0
    • searchCategories

      public Collection<Category> searchCategories(QueryHandler qh)
      Find Category matching the specified QueryHandler search options (uses mainly the text search param)
      Parameters:
      qh - the QueryHandler used to store
      Returns:
      a collection of Category, ordered by relevance
      Since:
      jcms-7.1
    • searchCategories

      public Collection<Category> searchCategories(org.apache.lucene.search.Query query)
      Find Category matching the specified lucene Query
      Parameters:
      query - a Lucene Query
      Returns:
      a collection of Category, ordered by relevance
      Since:
      jcms-7.1
    • getLogger

      protected org.apache.log4j.Logger getLogger()
      Description copied from class: LuceneDataSearchEngine
      Returns the Logger used for all log messages emitted by this engine.
      Specified by:
      getLogger in class LuceneDataSearchEngine
      Returns:
      Logger of this engine.
    • getDataIterator

      protected DataIterator<Data> getDataIterator(LuceneDataSearchEngine.ReindexOptions options)
      Description copied from class: LuceneDataSearchEngine
      Returns a DataIterator over all Data objects to be indexed, filtered according to the given LuceneDataSearchEngine.ReindexOptions.
      Specified by:
      getDataIterator in class LuceneDataSearchEngine
      Parameters:
      options - reindex configuration
      Returns:
      a non-null DataIterator
    • indexData

      protected void indexData(org.apache.lucene.index.IndexWriter writer, Data data, String lang, boolean isFullReindexing) throws IOException
      This methods index the given Category in the given language, into the given index writer.
      Specified by:
      indexData in class LuceneDataSearchEngine
      Parameters:
      writer - target Lucene writer
      data - the Data to index
      lang - ISO-639 language code
      isFullReindexing - true if operation is for a full reindexing with a empty index, false if updating an existing index
      Throws:
      IOException - on I/O error
    • addUnStoredField

      protected void addUnStoredField(org.apache.lucene.document.Document doc, Category cat, String lang, String fieldName, String fieldValue, boolean applyBoost)
      This methods create a unstored Lucene Field with the given field's value of the given Category in the given language, and add into the given Document.
      Parameters:
      doc - the Lucene document
      cat - the category
      lang - the language
      fieldName - the field's name
      fieldValue - the field's value
      applyBoost - whether to apply the boost, useful for appendable field in which case the boost should only be applied for the first element.
    • addKeywordField

      protected void addKeywordField(org.apache.lucene.document.Document doc, Category cat, String lang, String fieldName, String fieldValue, boolean applyBoost)
      This methods create a unstored Lucene Field with the given field's value of the given Category in the given language, and add into the given Document.
      Parameters:
      doc - the Lucene document
      cat - the category
      lang - the language
      fieldName - the field's name
      fieldValue - the field's value
      applyBoost - whether to apply the boost, useful for appendable field in which case the boost should only be applied for the first element.