Package org.apache.sis.storage.aggregate
Enum JoinFeatureSet.Type
- All Implemented Interfaces:
Serializable
,Comparable<JoinFeatureSet.Type>
,java.lang.constant.Constable
- Enclosing class:
- JoinFeatureSet
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 ConstantsEnum ConstantDescriptionOnly 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
FieldsModifier and TypeFieldDescription(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
ConstructorsModifierConstructorDescriptionprivate
Type
(boolean isOuterJoin, boolean swapSides) Creates an enumeration. -
Method Summary
Modifier and TypeMethodDescription(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.static JoinFeatureSet.Type
Returns the enum constant of this type with the specified name.static JoinFeatureSet.Type[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
INNER
Only records having a value on both side will be included. TheJoinFeatureSet
"left"
and"right"
properties will never be null. -
LEFT_OUTER
All records from the left side will be included. If there is no matching feature on the right side, then theJoinFeatureSet
"right"
property will benull
. -
RIGHT_OUTER
All records from the right side will be included. If there is no matching feature on the left side, then theJoinFeatureSet
"left"
property will benull
.
-
-
Field Details
-
isOuterJoin
final boolean isOuterJoinWhether to include all "main" feature instances even if there is no match in the other side. This istrue
for outer joins andfalse
for inner joins. -
swapSides
final boolean swapSidestrue
if the "main" side is the right side instead of the left side. SeeJoinFeatureSet.Iterator
for a definition of "main side".
-
-
Constructor Details
-
Type
private Type(boolean isOuterJoin, boolean swapSides) Creates an enumeration.
-
-
Method Details
-
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
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 nameNullPointerException
- 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, ortrue
for the right side.
-
valueOf
Returns the enumeration value for the given characteristics.
-