Package org.opencms.jsp.search.config

Interface I_CmsSearchConfigurationGeoFilter

    • Field Summary

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

    • Method Summary

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

    • Method Detail

      • getCoordinates

        java.lang.String getCoordinates()
        Returns the coordinates.
        Returns:
        the coordinates

      • getCoordinatesParam

        java.lang.String getCoordinatesParam()
        Returns the name of the coordinates parameter.
        Returns:
        the name of the coordinates parameter

      • getFieldName

        java.lang.String getFieldName()
        Returns the Solr field name storing the coordinates.
        Returns:
        the Solr field name storing the coordinates

      • getRadius

        java.lang.String getRadius()
        Returns the radius.
        Returns:
        the radius

      • getRadiusParam

        java.lang.String getRadiusParam()
        Returns the name of the radius parameter.
        Returns:
        the name of the radius parameter

      • getUnits

        java.lang.String getUnits()
        Returns the units the search radius uses, either kilometers (km) or miles (mi).
        Returns:
        the search radius units

      • getUnitsParam

        java.lang.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