Interface ValueSet

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    AllOrNoneValueSet, EquatableValueSet, SortedRangeSet

    public interface ValueSet
    extends AutoCloseable
    Defines a construct that can be used to describe a set of values without containing all the individual values themselves. For example, 1,2,3,4,5,6,7,8,9,10 could be described by having the literal Integer values in a HashSet or you could describe them as the INT values between 1 and 10 inclusive.
    • Method Detail

      • getType

        org.apache.arrow.vector.types.pojo.ArrowType getType()
        The Arrow Type of the values represented in this ValueSet.
        Returns:
        The ArrowType of the values represented in this ValueSet.
        See Also:
        ValueSet
      • isNone

        boolean isNone()
        Conveys if no value can satisfy this ValueSet.
        Returns:
        True if no value can satisfy this ValueSet, false otherwise.
        See Also:
        ValueSet
      • isAll

        boolean isAll()
        Conveys if any value can satisfy this ValueSet.
        Returns:
        True if any value can satisfy this ValueSet, false otherwise.
        See Also:
        ValueSet
      • isSingleValue

        boolean isSingleValue()
        Conveys if this ValueSet contains a single value.
        Returns:
        True if this ValueSet contains only a single value.
      • getSingleValue

        Object getSingleValue()
        Attempts to return the single value contained in this ValueSet.
        Returns:
        The single value, if there is one, in this ValueSet.
      • isNullAllowed

        boolean isNullAllowed()
        Conveys if nulls should be allowed.
        Returns:
        True if NULLs are part of this ValueSet, False otherwise.
      • containsValue

        boolean containsValue​(Marker value)
        Used to test if the supplied value (in the form of a Marker) is contained in this ValueSet.
        Parameters:
        value - The value to test in the form of a Marker.
        Returns:
        True if the value is contained in the ValueSet, False otherwise.
      • containsValue

        boolean containsValue​(Object value)
      • getRanges

        default Ranges getRanges()
        Returns:
        range predicates for orderable Types