Package org.opencms.jsp.search.result

Class CmsSearchResourceBean

java.lang.Object

org.opencms.jsp.search.result.CmsSearchResourceBean

All Implemented Interfaces:

I_CmsSearchResourceBean

public class CmsSearchResourceBean
extends Object
implements I_CmsSearchResourceBean

JSP EL friendly wrapper class for a single search result (document).

Constructor Summary

Constructors

Constructor	Description
CmsSearchResourceBean(CmsSearchResource searchResource, CmsObject cms)	Constructor taking the search resource to wrap.

Method Summary

Modifier and Type	Method	Description
Map<String,Date>	getDateFields()	Returns the map from field names to field values for date fields.
Map<String,String>	getFields()	Returns the map from field names to field values for string fields.
Map<String,List<String>>	getMultiValuedFields()	Returns the map from field names to field values for multi-valued (string) fields.
CmsSearchResource	getSearchResource()	Returns the wrapped CmsSearchResource (to access the CmsResource).
CmsJspContentAccessBean	getXmlContent()	Reads the resource and allows content access in the current request language - in case of an XML content.
Map<String,CmsJspContentAccessBean>	getXmlContentInLocale()	Reads the resource and allows content access in the specified language - in case of an XML content.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSearchResourceBean

public CmsSearchResourceBean(CmsSearchResource searchResource,
 CmsObject cms)

Constructor taking the search resource to wrap.

Parameters:

searchResource - The search resource to wrap.

cms - The Cms object, used to read resources.

Method Details

getDateFields

public Map<String,Date> getDateFields()

Description copied from interface: I_CmsSearchResourceBean

Returns the map from field names to field values for date fields.

Specified by:

getDateFields in interface I_CmsSearchResourceBean

Returns:

The map from field names to field values for date fields.

See Also:

• I_CmsSearchResourceBean.getDateFields()

getFields

public Map<String,String> getFields()

Description copied from interface: I_CmsSearchResourceBean

Returns the map from field names to field values for string fields.

Specified by:

getFields in interface I_CmsSearchResourceBean

Returns:

The map from field names to field values for string fields.

See Also:

• I_CmsSearchResourceBean.getFields()

getMultiValuedFields

public Map<String,List<String>> getMultiValuedFields()

Description copied from interface: I_CmsSearchResourceBean

Returns the map from field names to field values for multi-valued (string) fields.

Specified by:

getMultiValuedFields in interface I_CmsSearchResourceBean

Returns:

The map from field names to field values for multi-valued (string) fields.

See Also:

• I_CmsSearchResourceBean.getMultiValuedFields()

getSearchResource

public CmsSearchResource getSearchResource()

Description copied from interface: I_CmsSearchResourceBean

Returns the wrapped CmsSearchResource (to access the CmsResource).

Specified by:

getSearchResource in interface I_CmsSearchResourceBean

Returns:

The wrapped CmsSearchResource.

See Also:

• I_CmsSearchResourceBean.getSearchResource()

getXmlContent

public CmsJspContentAccessBean getXmlContent()

Description copied from interface: I_CmsSearchResourceBean

Reads the resource and allows content access in the current request language - in case of an XML content. If the resource is not an XML content, it returns null.

Specified by:

getXmlContent in interface I_CmsSearchResourceBean

Returns:

The XML content or null.

See Also:

• I_CmsSearchResourceBean.getXmlContent()

getXmlContentInLocale

public Map<String,CmsJspContentAccessBean> getXmlContentInLocale()

Description copied from interface: I_CmsSearchResourceBean

Reads the resource and allows content access in the specified language - in case of an XML content. If the resource is not an XML content, it returns null.

Specified by:

getXmlContentInLocale in interface I_CmsSearchResourceBean

Returns:

The XML content or null.

See Also:

• I_CmsSearchResourceBean.getXmlContentInLocale()