Package org.opencms.search.fields

Class CmsSearchFieldMappingType

java.lang.Object

org.opencms.util.A_CmsModeIntEnumeration

org.opencms.search.fields.CmsSearchFieldMappingType

All Implemented Interfaces:

java.io.Serializable

public final class CmsSearchFieldMappingType
extends A_CmsModeIntEnumeration

Describes a possible mapping type for a piece of content used in building a search index.

The mapping type is responsible to select which content from the OpenCms resource is used for a field.

Since:

7.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static CmsSearchFieldMappingType	ATTRIBUTE	The "dynamic" mapping type, this is required if a special class is used to process the field mapping value.
static CmsSearchFieldMappingType	CONTENT	The "content" mapping type, maps the content of the resource (no parameters required).
static CmsSearchFieldMappingType	DYNAMIC	The "dynamic" mapping type, this is required if a special class is used to process the field mapping value.
static CmsSearchFieldMappingType	ITEM	The "item" mapping type, maps the selected content item of the content.
static CmsSearchFieldMappingType	PROPERTY	The "property" mapping type, maps the selected property value of the resource.
static CmsSearchFieldMappingType	PROPERTY_SEARCH	The "property-search" mapping type, maps the selected property value of the resource with search upwards.

Method Summary

Modifier and Type	Method	Description
java.lang.String	toString()
static CmsSearchFieldMappingType	valueOf(java.lang.String value)	Returns the matching field mapping type, or null if the given value is not a valid mapping type name.

Methods inherited from class org.opencms.util.A_CmsModeIntEnumeration

equals, getMode, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE

public static final CmsSearchFieldMappingType ATTRIBUTE

The "dynamic" mapping type, this is required if a special class is used to process the field mapping value.

CONTENT

public static final CmsSearchFieldMappingType CONTENT

The "content" mapping type, maps the content of the resource (no parameters required).

DYNAMIC

public static final CmsSearchFieldMappingType DYNAMIC

The "dynamic" mapping type, this is required if a special class is used to process the field mapping value.

ITEM

public static final CmsSearchFieldMappingType ITEM

The "item" mapping type, maps the selected content item of the content.

PROPERTY

public static final CmsSearchFieldMappingType PROPERTY

The "property" mapping type, maps the selected property value of the resource.

PROPERTY_SEARCH

public static final CmsSearchFieldMappingType PROPERTY_SEARCH

The "property-search" mapping type, maps the selected property value of the resource with search upwards.

Method Detail

valueOf

public static CmsSearchFieldMappingType valueOf(java.lang.String value)

Returns the matching field mapping type, or null if the given value is not a valid mapping type name.

Parameters:

value - the name of the mapping type

Returns:

the matching field mapping type

toString

public java.lang.String toString()

Overrides:

toString in class A_CmsModeIntEnumeration

See Also:

A_CmsModeIntEnumeration.toString()