Enum FilterOperator

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      ELEMENT_MATCH
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      EQUAL
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      EXISTS
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      GEO_NEAR
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      GEO_WITHIN
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      GREATER_THAN
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      GREATER_THAN_OR_EQUAL
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      IN
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      INTERSECTS
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      LESS_THAN
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      LESS_THAN_OR_EQUAL
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      MOD
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NEAR
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NEAR_SPHERE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NOT
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NOT_EQUAL
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      NOT_IN
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      SIZE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      TYPE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      WHERE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      WITHIN_BOX
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      WITHIN_CIRCLE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      WITHIN_CIRCLE_SPHERE
      Deprecated, for removal: This API element is subject to removal in a future version.
       
    • Enum Constant Detail

      • WITHIN_CIRCLE

        public static final FilterOperator WITHIN_CIRCLE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • WITHIN_CIRCLE_SPHERE

        public static final FilterOperator WITHIN_CIRCLE_SPHERE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • WITHIN_BOX

        public static final FilterOperator WITHIN_BOX
        Deprecated, for removal: This API element is subject to removal in a future version.
      • EQUAL

        public static final FilterOperator EQUAL
        Deprecated, for removal: This API element is subject to removal in a future version.
      • NOT_EQUAL

        public static final FilterOperator NOT_EQUAL
        Deprecated, for removal: This API element is subject to removal in a future version.
      • GREATER_THAN

        public static final FilterOperator GREATER_THAN
        Deprecated, for removal: This API element is subject to removal in a future version.
      • GREATER_THAN_OR_EQUAL

        public static final FilterOperator GREATER_THAN_OR_EQUAL
        Deprecated, for removal: This API element is subject to removal in a future version.
      • LESS_THAN

        public static final FilterOperator LESS_THAN
        Deprecated, for removal: This API element is subject to removal in a future version.
      • LESS_THAN_OR_EQUAL

        public static final FilterOperator LESS_THAN_OR_EQUAL
        Deprecated, for removal: This API element is subject to removal in a future version.
      • EXISTS

        public static final FilterOperator EXISTS
        Deprecated, for removal: This API element is subject to removal in a future version.
      • TYPE

        public static final FilterOperator TYPE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • NOT

        public static final FilterOperator NOT
        Deprecated, for removal: This API element is subject to removal in a future version.
      • MOD

        public static final FilterOperator MOD
        Deprecated, for removal: This API element is subject to removal in a future version.
      • SIZE

        public static final FilterOperator SIZE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • IN

        public static final FilterOperator IN
        Deprecated, for removal: This API element is subject to removal in a future version.
      • NOT_IN

        public static final FilterOperator NOT_IN
        Deprecated, for removal: This API element is subject to removal in a future version.
      • ALL

        public static final FilterOperator ALL
        Deprecated, for removal: This API element is subject to removal in a future version.
      • ELEMENT_MATCH

        public static final FilterOperator ELEMENT_MATCH
        Deprecated, for removal: This API element is subject to removal in a future version.
      • WHERE

        public static final FilterOperator WHERE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • NEAR

        public static final FilterOperator NEAR
        Deprecated, for removal: This API element is subject to removal in a future version.
      • NEAR_SPHERE

        public static final FilterOperator NEAR_SPHERE
        Deprecated, for removal: This API element is subject to removal in a future version.
      • GEO_NEAR

        public static final FilterOperator GEO_NEAR
        Deprecated, for removal: This API element is subject to removal in a future version.
      • GEO_WITHIN

        public static final FilterOperator GEO_WITHIN
        Deprecated, for removal: This API element is subject to removal in a future version.
      • INTERSECTS

        public static final FilterOperator INTERSECTS
        Deprecated, for removal: This API element is subject to removal in a future version.
    • Method Detail

      • values

        public static FilterOperator[] values()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (FilterOperator c : FilterOperator.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static FilterOperator valueOf​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • fromString

        public static FilterOperator fromString​(String operator)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Creates a FilterOperator from a String
        Parameters:
        operator - the String to convert
        Returns:
        the FilterOperator
      • apply

        public abstract Filter apply​(String prop,
                                     Object value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Converts a FilterOperator to a Filter
        Parameters:
        prop - the document property name
        value - the value to apply to the filter
        Returns:
        the new Filter
        Developer note.
        This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
      • matches

        public boolean matches​(String filter)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns true if the given filter matches the filters on this FilterOperator
        Parameters:
        filter - the filter to check
        Returns:
        true if the given filter matches the filters on this FilterOperator
      • val

        public String val()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Returns:
        the value of this FilterOperator