org.opencms.search.fields
Class CmsSearchFieldConfigurationOldCategories

java.lang.Object
  org.opencms.search.fields.CmsSearchFieldConfiguration
      org.opencms.search.fields.CmsLuceneFieldConfiguration
          org.opencms.search.fields.CmsSearchFieldConfigurationOldCategories

All Implemented Interfaces:

java.lang.Comparable<CmsSearchFieldConfiguration>

public class CmsSearchFieldConfigurationOldCategories
extends CmsLuceneFieldConfiguration

Describes a field configuration using the old (pre 8.0) logic for categories that depend on properties.

Configure this class for a search index field configuration in case you want the old behavior.

Since:

8.0.0

Field Summary

Fields inherited from class org.opencms.search.fields.CmsLuceneFieldConfiguration

DEFAULT_STANDARD, STR_STANDARD_DESCRIPTION

Fields inherited from class org.opencms.search.fields.CmsSearchFieldConfiguration

STR_STANDARD

Constructor Summary

CmsSearchFieldConfigurationOldCategories()
Default constructor.

Method Summary

protected I_CmsSearchDocument

appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.

Methods inherited from class org.opencms.search.fields.CmsLuceneFieldConfiguration

getAnalyzer, getExcerptFieldNames, getLuceneFields

Methods inherited from class org.opencms.search.fields.CmsSearchFieldConfiguration

addField, addFields, appendContentBlob, appendDates, appendFieldMapping, appendFieldMappings, appendFileSize, appendLocales, appendPath, appendProperties, appendType, compareTo, createDocument, equals, getDescription, getField, getFieldNames, getFields, getIndex, getLocaleExtendedName, getLocaleExtendedName, getName, getParentFolderTokens, hashCode, init, setBoost, setDescription, setIndex, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchFieldConfigurationOldCategories

public CmsSearchFieldConfigurationOldCategories()

Default constructor.

Method Detail

appendCategories

protected I_CmsSearchDocument appendCategories(I_CmsSearchDocument document,
                                               CmsObject cms,
                                               CmsResource resource,
                                               I_CmsExtractionResult extractionResult,
                                               java.util.List<CmsProperty> properties,
                                               java.util.List<CmsProperty> propertiesSearched)

Extends the given document by resource category information based on properties.

Overrides:

appendCategories in class CmsSearchFieldConfiguration

Parameters:

document - the document to extend

cms - the OpenCms context used for building the search index

resource - the resource that is indexed

extractionResult - the plain text extraction result from the resource

properties - the list of all properties directly attached to the resource (not searched)

propertiesSearched - the list of all searched properties of the resource

Returns:

the document extended by resource category information

See Also:

CmsSearchFieldConfiguration.appendCategories(org.opencms.search.I_CmsSearchDocument, org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)