Package org.opencms.search.fields

Class CmsGeoCoordinateFieldMapping

java.lang.Object

org.opencms.search.fields.CmsGeoCoordinateFieldMapping

All Implemented Interfaces:

java.io.Serializable, I_CmsSearchFieldMapping

public class CmsGeoCoordinateFieldMapping
extends java.lang.Object
implements I_CmsSearchFieldMapping

Class extracting the Geo coordinates from a content field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_DEPTH	Maximum recursion depth for following links.

Constructor Summary

Constructors

Constructor	Description
CmsGeoCoordinateFieldMapping(CmsGeoMappingConfiguration config)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultValue()	Returns the default value used for this field mapping in case no content is available.
java.lang.String	getParam()	Returns the mapping parameter.
java.lang.String	getStringValue(int depth, CmsGeoMappingConfiguration mappingConfig, CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult)	Gets the mapped value.
java.lang.String	getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)	Returns the String value extracted form the provided data according to the rules of this mapping type.
CmsSearchFieldMappingType	getType()	Returns the mapping type.
void	setDefaultValue(java.lang.String defaultValue)	Sets the default value for this field mapping in case no content is available.
void	setParam(java.lang.String param)	Sets the mapping parameter.
void	setType(java.lang.String type)	Sets the mapping type as a String.
void	setType(CmsSearchFieldMappingType type)	Sets the mapping type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.search.fields.I_CmsSearchFieldMapping

setLocale

Field Detail

MAX_DEPTH

public static final int MAX_DEPTH

Maximum recursion depth for following links.

See Also:

Constant Field Values

Constructor Detail

CmsGeoCoordinateFieldMapping

public CmsGeoCoordinateFieldMapping(CmsGeoMappingConfiguration config)

Creates a new instance.

Parameters:

config - the configuration to use

Method Detail

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: I_CmsSearchFieldMapping

Returns the default value used for this field mapping in case no content is available.

Specified by:

getDefaultValue in interface I_CmsSearchFieldMapping

Returns:

the default value used for this field mapping in case no content is available

See Also:

I_CmsSearchFieldMapping.getDefaultValue()

getParam

public java.lang.String getParam()

Description copied from interface: I_CmsSearchFieldMapping

Returns the mapping parameter.

The parameter is used depending on the implementation of the rules of the selected CmsSearchFieldMappingType.

Specified by:

getParam in interface I_CmsSearchFieldMapping

Returns:

the mapping parameter

See Also:

I_CmsSearchFieldMapping.getParam()

getStringValue

public java.lang.String getStringValue(CmsObject cms,
                                       CmsResource res,
                                       I_CmsExtractionResult extractionResult,
                                       java.util.List<CmsProperty> properties,
                                       java.util.List<CmsProperty> propertiesSearched)

Description copied from interface: I_CmsSearchFieldMapping

Returns the String value extracted form the provided data according to the rules of this mapping type.

Specified by:

getStringValue in interface I_CmsSearchFieldMapping

Parameters:

cms - the OpenCms context used for building the search index

res - 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 String value extracted form the provided data according to the rules of this mapping type

See Also:

I_CmsSearchFieldMapping.getStringValue(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.extractors.I_CmsExtractionResult, java.util.List, java.util.List)

getStringValue

public java.lang.String getStringValue(int depth,
                                       CmsGeoMappingConfiguration mappingConfig,
                                       CmsObject cms,
                                       CmsResource res,
                                       I_CmsExtractionResult extractionResult)

Gets the mapped value.

Parameters:

depth - the current recursion depth

mappingConfig - the mapping configuration to use

cms - the CMS context

res - the resource for which to get the value

extractionResult - the extraction result of the resource

Returns:

the mapped value

getType

public CmsSearchFieldMappingType getType()

Description copied from interface: I_CmsSearchFieldMapping

Returns the mapping type.

Specified by:

getType in interface I_CmsSearchFieldMapping

Returns:

the mapping type

See Also:

I_CmsSearchFieldMapping.getType()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Description copied from interface: I_CmsSearchFieldMapping

Sets the default value for this field mapping in case no content is available.

Specified by:

setDefaultValue in interface I_CmsSearchFieldMapping

Parameters:

defaultValue - the default value to set

See Also:

I_CmsSearchFieldMapping.setDefaultValue(java.lang.String)

setParam

public void setParam(java.lang.String param)

Description copied from interface: I_CmsSearchFieldMapping

Sets the mapping parameter.

The parameter is used depending on the implementation of the rules of the selected CmsSearchFieldMappingType.

Specified by:

setParam in interface I_CmsSearchFieldMapping

Parameters:

param - the parameter to set

See Also:

I_CmsSearchFieldMapping.setParam(java.lang.String)

setType

public void setType(CmsSearchFieldMappingType type)

Description copied from interface: I_CmsSearchFieldMapping

Sets the mapping type.

Specified by:

setType in interface I_CmsSearchFieldMapping

Parameters:

type - the type to set

See Also:

I_CmsSearchFieldMapping.setType(org.opencms.search.fields.CmsSearchFieldMappingType)

setType

public void setType(java.lang.String type)

Description copied from interface: I_CmsSearchFieldMapping

Sets the mapping type as a String.

Specified by:

setType in interface I_CmsSearchFieldMapping

Parameters:

type - the name of the type to set

See Also:

I_CmsSearchFieldMapping.setType(java.lang.String)