org.opencms.search.fields
Class CmsSearchFieldMapping

java.lang.Object
  org.opencms.search.fields.CmsSearchFieldMapping

public class CmsSearchFieldMapping
extends java.lang.Object

Describes a mapping of a piece of content from an OpenCms VFS resource to a field of a search index.

Since:

7.0.0

Version:

$Revision: 1.15 $

Author:

Alexander Kandzior

Constructor Summary

CmsSearchFieldMapping()
Public constructor for a new search field mapping.

CmsSearchFieldMapping(CmsSearchFieldMappingType type, java.lang.String param)
Public constructor for a new search field mapping.

Method Summary

boolean	equals(java.lang.Object obj) Two mappings are equal if the type and the parameter is equal.
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(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.
int	hashCode() The hash code depends on the type and the parameter.
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(CmsSearchFieldMappingType type) Sets the mapping type.
void	setType(java.lang.String type) Sets the mapping type as a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsSearchFieldMapping

public CmsSearchFieldMapping()

Public constructor for a new search field mapping.

CmsSearchFieldMapping

public CmsSearchFieldMapping(CmsSearchFieldMappingType type,
                             java.lang.String param)

Public constructor for a new search field mapping.

Parameters:

type - the type to use, see setType(CmsSearchFieldMappingType)

param - the mapping parameter, see setParam(String)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Two mappings are equal if the type and the parameter is equal.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getDefaultValue

public java.lang.String getDefaultValue()

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

Returns:

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

getParam

public java.lang.String getParam()

Returns the mapping parameter.

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

Returns:

the mapping parameter

getStringValue

public 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.

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

getType

public CmsSearchFieldMappingType getType()

Returns the mapping type.

Returns:

the mapping type

hashCode

public int hashCode()

The hash code depends on the type and the parameter.

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

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

Parameters:

defaultValue - the default value to set

setParam

public void setParam(java.lang.String param)

Sets the mapping parameter.

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

Parameters:

param - the parameter to set

setType

public void setType(CmsSearchFieldMappingType type)

Sets the mapping type.

Parameters:

type - the type to set

setType

public void setType(java.lang.String type)

Sets the mapping type as a String.

Parameters:

type - the name of the type to set