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 -
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.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 coordinatescoordinatesParam
- the name of the coordinates parameter used by the search formfieldName
- the Solr field where coordinates are storedradius
- the radiusradiusParam
- the name of the radius parameter used by the search formunits
- the units of the radiusunitsParam
- the name of the units parameter used by the search form
-
-
Method Details
-
getCoordinates
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the coordinates.- Specified by:
getCoordinates
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the coordinates
- See Also:
-
getCoordinatesParam
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the name of the coordinates parameter.- Specified by:
getCoordinatesParam
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the name of the coordinates parameter
- See Also:
-
getFieldName
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the Solr field name storing the coordinates.- Specified by:
getFieldName
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the Solr field name storing the coordinates
- See Also:
-
getRadius
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the radius.- Specified by:
getRadius
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the radius
- See Also:
-
getRadiusParam
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the name of the radius parameter.- Specified by:
getRadiusParam
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the name of the radius parameter
- See Also:
-
getUnits
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the units the search radius uses, either kilometers (km) or miles (mi).- Specified by:
getUnits
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the search radius units
- See Also:
-
getUnitsParam
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the name of the units parameter.- Specified by:
getUnitsParam
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the name of the units parameter
- See Also:
-