Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationGeoFilter

All Known Implementing Classes:

CmsSearchConfigurationGeoFilter

public interface I_CmsSearchConfigurationGeoFilter

The interface a Geo filter configuration must implement.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COORDINATES_PARAM	The default name of the coordinates parameter.
static final String	DEFAULT_FIELD_NAME	The default name of the Solr field where coordinates are stored.
static final String	DEFAULT_RADIUS_PARAM	The default name of the radius parameter.
static final String	DEFAULT_UNITS	The default units of the search radius.
static final String	DEFAULT_UNITS_PARAM	The default name of the units parameter.

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.
default boolean	hasGeoFilter()	Returns whether this Geo filter configuration has a valid Geo filter set.

Field Details

DEFAULT_COORDINATES_PARAM

static final String DEFAULT_COORDINATES_PARAM

The default name of the coordinates parameter.

See Also:

• Constant Field Values

DEFAULT_FIELD_NAME

static final String DEFAULT_FIELD_NAME

The default name of the Solr field where coordinates are stored.

See Also:

• Constant Field Values

DEFAULT_RADIUS_PARAM

static final String DEFAULT_RADIUS_PARAM

The default name of the radius parameter.

See Also:

• Constant Field Values

DEFAULT_UNITS

static final String DEFAULT_UNITS

The default units of the search radius.

See Also:

• Constant Field Values

DEFAULT_UNITS_PARAM

static final String DEFAULT_UNITS_PARAM

The default name of the units parameter.

See Also:

• Constant Field Values

Method Details

getCoordinates

String getCoordinates()

Returns the coordinates.

Returns:

the coordinates

getCoordinatesParam

String getCoordinatesParam()

Returns the name of the coordinates parameter.

Returns:

the name of the coordinates parameter

getFieldName

String getFieldName()

Returns the Solr field name storing the coordinates.

Returns:

the Solr field name storing the coordinates

getRadius

String getRadius()

Returns the radius.

Returns:

the radius

getRadiusParam

String getRadiusParam()

Returns the name of the radius parameter.

Returns:

the name of the radius parameter

getUnits

String getUnits()

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

Returns:

the search radius units

getUnitsParam

String getUnitsParam()

Returns the name of the units parameter.

Returns:

the name of the units parameter

hasGeoFilter

default boolean hasGeoFilter()

Returns whether this Geo filter configuration has a valid Geo filter set.

Returns:

whether this configuration has a valid Geo filter set or not