Package org.opencms.search.solr

Class CmsSolrField

java.lang.Object

org.opencms.search.fields.CmsSearchField

org.opencms.search.solr.CmsSolrField

All Implemented Interfaces:

java.io.Serializable

public class CmsSolrField
extends CmsSearchField

An individual field for the Solr search index.

Since:

8.5.0

See Also:

Serialized Form

Field Summary

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

FIELD_CATEGORY, FIELD_CATEGORY_EXACT, FIELD_CONTENT, FIELD_CONTENT_BLOB, FIELD_CONTENT_LOCALES, FIELD_DATE_CONTENT, FIELD_DATE_CREATED, FIELD_DATE_CREATED_LOOKUP, FIELD_DATE_EXPIRED, FIELD_DATE_LASTMODIFIED, FIELD_DATE_LASTMODIFIED_LOOKUP, FIELD_DATE_LOOKUP_SUFFIX, FIELD_DATE_RELEASED, FIELD_DEPENDENCY_TYPE, FIELD_DESCRIPTION, FIELD_DISPORDER, FIELD_DISPTITLE, FIELD_DYNAMIC_EXACT, FIELD_DYNAMIC_PROPERTIES, FIELD_DYNAMIC_PROPERTIES_DIRECT, FIELD_EXCERPT, FIELD_FILENAME, FIELD_GEOCOORDS, FIELD_ID, FIELD_INSTANCEDATE, FIELD_INSTANCEDATE_CURRENT_TILL, FIELD_INSTANCEDATE_END, FIELD_INSTANCEDATE_RANGE, FIELD_KEYWORDS, FIELD_LINK, FIELD_META, FIELD_MIMETYPE, FIELD_PARENT_FOLDERS, FIELD_PATH, FIELD_PATH_HIERARCHY, FIELD_PLACE, FIELD_POSTFIX_DATE, FIELD_POSTFIX_DATE_RANGE, FIELD_POSTFIX_DATE_RANGES, FIELD_POSTFIX_DATES, FIELD_POSTFIX_INT, FIELD_POSTFIX_LOC, FIELD_POSTFIX_SORT, FIELD_POSTFIX_STRING, FIELD_PREFIX_DEPENDENCY, FIELD_PREFIX_DYNAMIC, FIELD_PREFIX_TEXT, FIELD_PRIORITY, FIELD_RESOURCE_LOCALES, FIELD_SCORE, FIELD_SEARCH_CHANNEL, FIELD_SEARCH_EXCLUDE, FIELD_SERIESDATES, FIELD_SERIESDATES_CURRENT_TILL, FIELD_SERIESDATES_END, FIELD_SERIESDATES_TYPE, FIELD_SIZE, FIELD_SOLR_ID, FIELD_SORT_TITLE, FIELD_SPELL, FIELD_STATE, FIELD_SUFFIX, FIELD_TEXT, FIELD_TEXT_DE, FIELD_TEXT_EL, FIELD_TEXT_EN, FIELD_TEXT_ES, FIELD_TEXT_FR, FIELD_TEXT_HU, FIELD_TEXT_IT, FIELD_TIMESTAMP, FIELD_TITLE, FIELD_TITLE_UNSTORED, FIELD_TYPE, FIELD_USER_CREATED, FIELD_USER_LAST_MODIFIED, FIELD_VERSION

Constructor Summary

Constructors

Constructor	Description
CmsSolrField(java.lang.String targetField, java.util.List<java.lang.String> copyFields, java.util.Locale locale, java.lang.String defaultValue)	Public constructor.
CmsSolrField(CmsLuceneField luceneField)	Public constructor.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getCopyFields()	Returns the copy fields.
java.util.Locale	getLocale()	Returns the locale of this field or null if the field does not have a locale.
java.lang.String	getTargetField()	Returns the target field name.
void	setCopyFields(java.util.List<java.lang.String> copyFields)	Sets the copy field names.
void	setLocale(java.util.Locale locale)	Sets the locale.
void	setTargetField(java.lang.String targetField)	Sets the target field name.
java.lang.String	toString()

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

addMapping, addUninvertingMappings, equals, getDefaultValue, getIndexed, getMappings, getName, hashCode, isIndexed, isInExcerpt, isStored, setDefaultValue, setIndexed, setInExcerpt, setName, setStored

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSolrField

public CmsSolrField(CmsLuceneField luceneField)

Public constructor.

Parameters:

luceneField - the lucene field read from the configuration.

CmsSolrField

public CmsSolrField(java.lang.String targetField,
                    java.util.List<java.lang.String> copyFields,
                    java.util.Locale locale,
                    java.lang.String defaultValue)

Public constructor.

Parameters:

targetField - the target field name

copyFields - the field names to copy this field's value to

locale - the locale

defaultValue - the default value

Method Detail

getCopyFields

public java.util.List<java.lang.String> getCopyFields()

Returns the copy fields.

Returns:

the copy fields.

getLocale

public java.util.Locale getLocale()

Returns the locale of this field or null if the field does not have a locale.

Returns:

the locale of this field

getTargetField

public java.lang.String getTargetField()

Returns the target field name.

Returns:

the target field name

setCopyFields

public void setCopyFields(java.util.List<java.lang.String> copyFields)

Sets the copy field names.

Parameters:

copyFields - the field name to use as copy fields

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale.

Parameters:

locale - the locale to set

setTargetField

public void setTargetField(java.lang.String targetField)

Sets the target field name.

Parameters:

targetField - the name to set

toString

public java.lang.String toString()

Overrides:

toString in class CmsSearchField

See Also:

CmsSearchField.toString()