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 java.lang.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(java.lang.String coordinates, java.lang.String coordinatesParam, java.lang.String fieldName, java.lang.String radius, java.lang.String radiusParam, java.lang.String units, java.lang.String unitsParam)
Constructor for the Geo filter configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCoordinates()
Returns the coordinates.java.lang.String
getCoordinatesParam()
Returns the name of the coordinates parameter.java.lang.String
getFieldName()
Returns the Solr field name storing the coordinates.java.lang.String
getRadius()
Returns the radius.java.lang.String
getRadiusParam()
Returns the name of the radius parameter.java.lang.String
getUnits()
Returns the units the search radius uses, either kilometers (km) or miles (mi).java.lang.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 Detail
-
CmsSearchConfigurationGeoFilter
public CmsSearchConfigurationGeoFilter()
Constructor for the Geo filter configuration.
-
CmsSearchConfigurationGeoFilter
public CmsSearchConfigurationGeoFilter(java.lang.String coordinates, java.lang.String coordinatesParam, java.lang.String fieldName, java.lang.String radius, java.lang.String radiusParam, java.lang.String units, java.lang.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 Detail
-
getCoordinates
public java.lang.String getCoordinates()
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the coordinates.- Specified by:
getCoordinates
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the coordinates
- See Also:
I_CmsSearchConfigurationGeoFilter.getCoordinates()
-
getCoordinatesParam
public java.lang.String 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:
I_CmsSearchConfigurationGeoFilter.getCoordinatesParam()
-
getFieldName
public java.lang.String 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:
I_CmsSearchConfigurationGeoFilter.getFieldName()
-
getRadius
public java.lang.String getRadius()
Description copied from interface:I_CmsSearchConfigurationGeoFilter
Returns the radius.- Specified by:
getRadius
in interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the radius
- See Also:
I_CmsSearchConfigurationGeoFilter.getRadius()
-
getRadiusParam
public java.lang.String 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:
I_CmsSearchConfigurationGeoFilter.getRadiusParam()
-
getUnits
public java.lang.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 interfaceI_CmsSearchConfigurationGeoFilter
- Returns:
- the search radius units
- See Also:
I_CmsSearchConfigurationGeoFilter.getUnits()
-
getUnitsParam
public java.lang.String 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:
I_CmsSearchConfigurationGeoFilter.getUnitsParam()
-
-