Package org.opencms.xml.types

Class I_CmsXmlContentValue.CmsSearchContentConfig

java.lang.Object

org.opencms.xml.types.I_CmsXmlContentValue.CmsSearchContentConfig

Enclosing interface:

I_CmsXmlContentValue

public static class I_CmsXmlContentValue.CmsSearchContentConfig
extends Object

Search content configuration for the value. The configuration determines how the conent's value should be added to the indexed content fields.

Field Summary

Fields

Modifier and Type	Field	Description
static final I_CmsXmlContentValue.CmsSearchContentConfig	CONTENT	Configuration for adding the extraction of the content linked by the value to the content fields.
static final I_CmsXmlContentValue.CmsSearchContentConfig	FALSE	Configuration for not adding the value to the content fields.
static final I_CmsXmlContentValue.CmsSearchContentConfig	TRUE	Configuration for adding the value unchanged to the content fields.

Method Summary

Modifier and Type	Method	Description
static I_CmsXmlContentValue.CmsSearchContentConfig	get(I_CmsXmlContentValue.SearchContentType searchContentType)	Returns the configuration for the search content type.
static I_CmsXmlContentValue.CmsSearchContentConfig	get(I_CmsXmlContentValue.SearchContentType searchContentType, String adjustmentClass)	Returns the configuration for the combination of search content type and adjustment class.
String	getAdjustmentClass()
I_CmsXmlContentValue.SearchContentType	getSearchContentType()

Methods inherited from class java.lang.Object

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

Field Details

FALSE

public static final I_CmsXmlContentValue.CmsSearchContentConfig FALSE

Configuration for not adding the value to the content fields.

CONTENT

public static final I_CmsXmlContentValue.CmsSearchContentConfig CONTENT

Configuration for adding the extraction of the content linked by the value to the content fields.

TRUE

public static final I_CmsXmlContentValue.CmsSearchContentConfig TRUE

Configuration for adding the value unchanged to the content fields.

Method Details

get

public static I_CmsXmlContentValue.CmsSearchContentConfig get(I_CmsXmlContentValue.SearchContentType searchContentType)

Returns the configuration for the search content type.

Parameters:

searchContentType - the type to get the configuration for

Returns:

the configuration for the type

get

public static I_CmsXmlContentValue.CmsSearchContentConfig get(I_CmsXmlContentValue.SearchContentType searchContentType,
 String adjustmentClass)

Returns the configuration for the combination of search content type and adjustment class.

Parameters:

searchContentType - the type to get the configuration for

adjustmentClass - the adjustment class

Returns:

the configuration for the type/adjustment combination.

getAdjustmentClass

public String getAdjustmentClass()

Returns:

the adjustment class.

getSearchContentType

public I_CmsXmlContentValue.SearchContentType getSearchContentType()

Returns:

the search content type.