Enum JoinFeatureSet.Type

java.lang.Object
java.lang.Enum<JoinFeatureSet.Type>
org.apache.sis.storage.aggregate.JoinFeatureSet.Type
All Implemented Interfaces:
Serializable, Comparable<JoinFeatureSet.Type>, java.lang.constant.Constable
Enclosing class:
JoinFeatureSet

public static enum JoinFeatureSet.Type extends Enum<JoinFeatureSet.Type>
Specifies whether values on both sides are required (inner join), or only one side (outer join).
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Only records having a value on both side will be included.
    All records from the left side will be included.
    All records from the right side will be included.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) final boolean
    Whether to include all "main" feature instances even if there is no match in the other side.
    (package private) final boolean
    true if the "main" side is the right side instead of the left side.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Type(boolean isOuterJoin, boolean swapSides)
    Creates an enumeration.
  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) final int
    minimumOccurs(boolean right)
    Returns the minimum occurrences for properties on the left or right side.
    (package private) static JoinFeatureSet.Type
    valueOf(boolean isOuterJoin, boolean swapSides)
    Returns the enumeration value for the given characteristics.
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • INNER

      public static final JoinFeatureSet.Type INNER
      Only records having a value on both side will be included. The JoinFeatureSet "left" and "right" properties will never be null.
    • LEFT_OUTER

      public static final JoinFeatureSet.Type LEFT_OUTER
      All records from the left side will be included. If there is no matching feature on the right side, then the JoinFeatureSet "right" property will be null.
    • RIGHT_OUTER

      public static final JoinFeatureSet.Type RIGHT_OUTER
      All records from the right side will be included. If there is no matching feature on the left side, then the JoinFeatureSet "left" property will be null.
  • Field Details

    • isOuterJoin

      final boolean isOuterJoin
      Whether to include all "main" feature instances even if there is no match in the other side. This is true for outer joins and false for inner joins.
    • swapSides

      final boolean swapSides
      true if the "main" side is the right side instead of the left side. See JoinFeatureSet.Iterator for a definition of "main side".
  • Constructor Details

    • Type

      private Type(boolean isOuterJoin, boolean swapSides)
      Creates an enumeration.
  • Method Details

    • values

      public static JoinFeatureSet.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static JoinFeatureSet.Type valueOf(String name)
      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
    • minimumOccurs

      final int minimumOccurs(boolean right)
      Returns the minimum occurrences for properties on the left or right side.
      Parameters:
      right - false for the left side, or true for the right side.
    • valueOf

      static JoinFeatureSet.Type valueOf(boolean isOuterJoin, boolean swapSides)
      Returns the enumeration value for the given characteristics.