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
FieldsModifier and TypeFieldDescriptionstatic final String
The default name of the coordinates parameter.static final String
The default name of the Solr field where coordinates are stored.static final String
The default name of the radius parameter.static final String
The default units of the search radius.static final String
The default name of the units parameter. -
Method Summary
Modifier and TypeMethodDescriptionReturns the coordinates.Returns the name of the coordinates parameter.Returns the Solr field name storing the coordinates.Returns the radius.Returns the name of the radius parameter.getUnits()
Returns the units the search radius uses, either kilometers (km) or miles (mi).Returns the name of the units parameter.default boolean
Returns whether this Geo filter configuration has a valid Geo filter set.
-
Field Details
-
DEFAULT_COORDINATES_PARAM
The default name of the coordinates parameter.- See Also:
-
DEFAULT_FIELD_NAME
The default name of the Solr field where coordinates are stored.- See Also:
-
DEFAULT_RADIUS_PARAM
The default name of the radius parameter.- See Also:
-
DEFAULT_UNITS
The default units of the search radius.- See Also:
-
DEFAULT_UNITS_PARAM
The default name of the units parameter.- See Also:
-
-
Method Details
-
getCoordinates
Returns the coordinates.- Returns:
- the coordinates
-
getCoordinatesParam
Returns the name of the coordinates parameter.- Returns:
- the name of the coordinates parameter
-
getFieldName
Returns the Solr field name storing the coordinates.- Returns:
- the Solr field name storing the coordinates
-
getRadius
Returns the radius.- Returns:
- the radius
-
getRadiusParam
Returns the name of the radius parameter.- Returns:
- the name of the radius parameter
-
getUnits
Returns the units the search radius uses, either kilometers (km) or miles (mi).- Returns:
- the search radius units
-
getUnitsParam
Returns the name of the units parameter.- Returns:
- the name of the units parameter
-
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
-