Module org.apache.sis.feature

Package org.apache.sis.feature

Enum Class FeatureFormat.Column

Object

Enum<FeatureFormat.Column>

Column

All Implemented Interfaces:

Serializable, Comparable<Feature­Format.Column>, Constable

Enclosing class:

Feature­Format

public static enum FeatureFormat.Column
extends Enum<FeatureFormat.Column>

Identifies the columns to include in the table formatted by Feature­Format. By default, all columns having at least one non-null value are shown. But a smaller set of columns can be specified to the Feature­Format.set­Allowed­Columns(Set) method for formatting narrower tables.

Since:

0.8

See Also:

• Feature­Format.set­Allowed­Columns(Set)

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
CARDINALITY	Cardinality (for attributes) or multiplicity (for attribute types).
CHARACTERISTICS	Other attributes that describes the attribute.
DESIGNATION	Natural language designator for the property.
NAME	Name of the property.
REMARKS	Whether a property is deprecated, or other remarks.
TYPE	Type of property values.
VALUE	Property value (for properties) or default value (for property types).

Method Summary

Modifier and Type	Method	Description
static Feature­Format.Column	value­Of(String name)	Returns the enum constant of this class with the specified name.
static Feature­Format.Column[]	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

DESIGNATION

public static final FeatureFormat.Column DESIGNATION

Natural language designator for the property. This is the character sequence returned by Abstract­Identified­Type.get­Designation(). This column is omitted if no property has a designation.

NAME

public static final FeatureFormat.Column NAME

Name of the property. This is the character sequence returned by Abstract­Identified­Type.get­Name().

TYPE

public static final FeatureFormat.Column TYPE

Type of property values. This is the type returned by Default­Attribute­Type.get­Value­Class() or Default­Association­Role.get­Value­Type().

CARDINALITY

public static final FeatureFormat.Column CARDINALITY

Cardinality (for attributes) or multiplicity (for attribute types). The cardinality is the actual number of attribute values. The multiplicity is the minimum and maximum occurrences of attribute values. The multiplicity is made from the numbers returned by Default­Attribute­Type.get­Minimum­Occurs() and Default­Attribute­Type.get­Maximum­Occurs().

VALUE

public static final FeatureFormat.Column VALUE

Property value (for properties) or default value (for property types). This is the value returned by Abstract­Attribute.get­Value(), Abstract­Association.get­Value() or Default­Attribute­Type.get­Default­Value().

CHARACTERISTICS

public static final FeatureFormat.Column CHARACTERISTICS

Other attributes that describes the attribute. This is made from the map returned by Abstract­Attribute.characteristics(). This column is omitted if no property has characteristics.

REMARKS

public static final FeatureFormat.Column REMARKS

Whether a property is deprecated, or other remarks. This column is omitted if no property has remarks.

Method Details

values

public static FeatureFormat.Column[] 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 FeatureFormat.Column 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