Module org.opengis.geoapi

Package org.opengis.util

Interface ControlledVocabulary

All Known Implementing Classes:

AssociationType, AxisDirection, BandDefinition, CellGeometry, CharacterSet, Classification, CodeList, ComparisonOperatorName, Configuration.Key, Context, CoordinateDataType, CouplingType, CoverageContentType, Datatype, DateType, DimensionNameType, DistanceOperatorName, DistributedComputingPlatform, EvaluationMethodType, GeometricObjectType, GeometryType, ImagingCondition, IndeterminateValue, InitiativeType, KeywordType, LogicalOperatorName, MaintenanceFrequency, MatchAction, MediumFormat, MediumName, ObjectiveType, Obligation, Obligation, OnLineFunction, OperationType, ParameterDirection, PixelInCell, PixelOrientation, PolarizationOrientation, PresentationForm, Priority, Progress, RangeMeaning, RealizationMethod, ReferenceSystemType, Restriction, Role, ScopeCode, Sequence, SortOrder, SpatialOperatorName, SpatialRepresentationType, TelephoneType, TemporalOperatorName, TopicCategory, TopologyLevel, TransferFunctionType, Trigger, ValueStructure, VersionAction, VerticalDatumType

public interface ControlledVocabulary

Common interface of all enumerations and code lists defined in GeoAPI. Enumerations are closed controlled vocabularies: it is not possible to add new members (except by releasing new versions of the library). By contrast, code lists are open vocabularies: they provide a basic set of members defined at compile-time, but users are free to add new members at runtime.

Since:

3.1

Departure from OGC/ISO standard for closer integration with the Java environment

Provided for allowing developers to handles Enum and CodeList in the same way for some common tasks.

Method Summary

Modifier and Type	Method	Description
ControlledVocabulary[]	family()	Returns the enumeration or list of codes of the same kind as this item.
default Optional<String>	identifier()	Returns the identifier declared in the UML annotation.
String	name()	Returns the name of this enumeration constant or code list value.
default String[]	names()	Returns all the names of this constant.
int	ordinal()	Returns the ordinal of this constant.

Method Details

name

String name()

Returns the name of this enumeration constant or code list value.

Returns:

the name of this enumeration constant or code list value.

names

default String[] names()

Returns all the names of this constant. The returned array contains the following elements, with duplicated values and null values removed:

• The programmatic name
• The UML identifier
• Any other special case, if any. Examples:
  • The legacy name of Restriction.LICENCE.
  • American spelling such as "cell center" as an alternative to "cell centre".

Those names are typically equal except for the case (programmatic names are upper case while UML names are lower case) and special characters like '-'.

Returns:

all names of this constant. This array is never null and never empty.

identifier

default Optional<String> identifier()

Returns the identifier declared in the UML annotation. The UML identifier shall be the ISO or OGC name for this enumeration or code list constant.

Returns:

the ISO/OGC identifier for this constant.

ordinal

int ordinal()

Returns the ordinal of this constant. This is its position in its elements declaration, where the initial constant is assigned an ordinal of zero.

Returns:

the position of this constants in elements declaration.

family

ControlledVocabulary[] family()

Returns the enumeration or list of codes of the same kind as this item. Invoking this method gives identical results than invoking the static values() methods provided in Enum and CodeList subclasses, except that family() does not require the class to be known at compile-time — provided that at leat one instance of the family is available.

Returns:

the enumeration or list of codes of the same kind as this item.