Module org.apache.sis.feature

Package org.apache.sis.feature.builder

Enum Class AttributeRole

Object

Enum<AttributeRole>

AttributeRole

All Implemented Interfaces:

Serializable, Comparable<Attribute­Role>, Constable

public enum AttributeRole
extends Enum<AttributeRole>

Roles that can be associated to some attributes for instructing Feature­Type­Builder how to generate predefined operations. Those predefined operations are:

• A compound operation for generating a unique identifier from an arbitrary number of attribute values.
• A link operation for referencing a geometry to be used as the default geometry.
• An operation for computing the bounding box of all geometries found in the feature. This operation is automatically added if the feature contains a default geometry.

This enumeration allows user code to specify which feature attribute to use for creating those operations.

Since:

0.8

See Also:

• Attribute­Type­Builder.add­Role(Attribute­Role)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.Enum­Desc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT_GEOMETRY	Attribute value will be flagged as the default geometry.
IDENTIFIER_COMPONENT	Attribute value will be part of a unique identifier for the feature instance.

Method Summary

Modifier and Type	Method	Description
static Attribute­Role	value­Of(String name)	Returns the enum constant of this class with the specified name.
static Attribute­Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compare­To, describe­Constable, equals, finalize, get­Declaring­Class, hash­Code, name, ordinal, to­String, value­Of

Methods inherited from class Object

get­Class, notify, notify­All, wait, wait, wait

Enum Constant Details

IDENTIFIER_COMPONENT

public static final AttributeRole IDENTIFIER_COMPONENT

Attribute value will be part of a unique identifier for the feature instance. An arbitrary number of attributes can be flagged as identifier components:

• If no attribute has this role, then no attribute is marked as feature identifier.
• If exactly one attribute has this role, then a synthetic attribute named "sis:identifier" will be created as a link to the flagged attribute.
• If more than one attribute have this role, then a synthetic attribute named "sis:identifier" will be created as a compound key made of all flagged attributes. The separator character can be modified by a call to Feature­Type­Builder.set­Identifier­Delimiters(String, String, String)

See Also:

• Feature­Type­Builder.set­Identifier­Delimiters(String, String, String)

DEFAULT_GEOMETRY

public static final AttributeRole DEFAULT_GEOMETRY

Attribute value will be flagged as the default geometry. Feature can have an arbitrary number of geometry attributes, but only one can be flagged as the default geometry.

Method Details

values

public static AttributeRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AttributeRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

Illegal­Argument­Exception - if this enum class has no constant with the specified name

Null­Pointer­Exception - if the argument is null