Package org.opencms.jsp.search.config

Class CmsSearchConfigurationGeoFilter

java.lang.Object

org.opencms.jsp.search.config.CmsSearchConfigurationGeoFilter

All Implemented Interfaces:

I_CmsSearchConfigurationGeoFilter

public class CmsSearchConfigurationGeoFilter
extends Object
implements I_CmsSearchConfigurationGeoFilter

Search configuration for the Geo filter.

Field Summary

Fields inherited from interface org.opencms.jsp.search.config.I_CmsSearchConfigurationGeoFilter

DEFAULT_COORDINATES_PARAM, DEFAULT_FIELD_NAME, DEFAULT_RADIUS_PARAM, DEFAULT_UNITS, DEFAULT_UNITS_PARAM

Constructor Summary

Constructors

Constructor	Description
CmsSearchConfigurationGeoFilter()	Constructor for the Geo filter configuration.
CmsSearchConfigurationGeoFilter(String coordinates, String coordinatesParam, String fieldName, String radius, String radiusParam, String units, String unitsParam)	Constructor for the Geo filter configuration.

Method Summary

Modifier and Type	Method	Description
String	getCoordinates()	Returns the coordinates.
String	getCoordinatesParam()	Returns the name of the coordinates parameter.
String	getFieldName()	Returns the Solr field name storing the coordinates.
String	getRadius()	Returns the radius.
String	getRadiusParam()	Returns the name of the radius parameter.
String	getUnits()	Returns the units the search radius uses, either kilometers (km) or miles (mi).
String	getUnitsParam()	Returns the name of the units parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.search.config.I_CmsSearchConfigurationGeoFilter

hasGeoFilter

Constructor Details

CmsSearchConfigurationGeoFilter

public CmsSearchConfigurationGeoFilter()

Constructor for the Geo filter configuration.

CmsSearchConfigurationGeoFilter

public CmsSearchConfigurationGeoFilter(String coordinates,
 String coordinatesParam,
 String fieldName,
 String radius,
 String radiusParam,
 String units,
 String unitsParam)

Constructor for the Geo filter configuration.

Parameters:

coordinates - the coordinates

coordinatesParam - the name of the coordinates parameter used by the search form

fieldName - the Solr field where coordinates are stored

radius - the radius

radiusParam - the name of the radius parameter used by the search form

units - the units of the radius

unitsParam - the name of the units parameter used by the search form

Method Details

getCoordinates

public String getCoordinates()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the coordinates.

Specified by:

getCoordinates in interface I_CmsSearchConfigurationGeoFilter

Returns:

the coordinates

See Also:

• I_CmsSearchConfigurationGeoFilter.getCoordinates()

getCoordinatesParam

public String getCoordinatesParam()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the name of the coordinates parameter.

Specified by:

getCoordinatesParam in interface I_CmsSearchConfigurationGeoFilter

Returns:

the name of the coordinates parameter

See Also:

• I_CmsSearchConfigurationGeoFilter.getCoordinatesParam()

getFieldName

public String getFieldName()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the Solr field name storing the coordinates.

Specified by:

getFieldName in interface I_CmsSearchConfigurationGeoFilter

Returns:

the Solr field name storing the coordinates

See Also:

• I_CmsSearchConfigurationGeoFilter.getFieldName()

getRadius

public String getRadius()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the radius.

Specified by:

getRadius in interface I_CmsSearchConfigurationGeoFilter

Returns:

the radius

See Also:

• I_CmsSearchConfigurationGeoFilter.getRadius()

getRadiusParam

public String getRadiusParam()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the name of the radius parameter.

Specified by:

getRadiusParam in interface I_CmsSearchConfigurationGeoFilter

Returns:

the name of the radius parameter

See Also:

• I_CmsSearchConfigurationGeoFilter.getRadiusParam()

getUnits

public String getUnits()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the units the search radius uses, either kilometers (km) or miles (mi).

Specified by:

getUnits in interface I_CmsSearchConfigurationGeoFilter

Returns:

the search radius units

See Also:

• I_CmsSearchConfigurationGeoFilter.getUnits()

getUnitsParam

public String getUnitsParam()

Description copied from interface: I_CmsSearchConfigurationGeoFilter

Returns the name of the units parameter.

Specified by:

getUnitsParam in interface I_CmsSearchConfigurationGeoFilter

Returns:

the name of the units parameter

See Also:

• I_CmsSearchConfigurationGeoFilter.getUnitsParam()