Module org.opengis.geoapi

Package org.opengis.metadata.quality

Class ValueStructure

Object

CodeList<ValueStructure>

ValueStructure

All Implemented Interfaces:

Serializable, Comparable<ValueStructure>, ControlledVocabulary

@UML(identifier="DQM_ValueStructure",
     specification=ISO_19157)
public final class ValueStructure
extends CodeList<ValueStructure>

Structure for reporting a complex data quality result.

Since:

3.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final ValueStructure	BAG	Finite, unordered collection of related items that may be repeated.
static final ValueStructure	COVERAGE	Feature that acts as a function to return values from its range for any direct position within its spatial, temporal or spatiotemporal domain.
static final ValueStructure	MATRIX	Rectangular array of numbers.
static final ValueStructure	SEQUENCE	Finite, ordered collection of related items that may be repeated.
static final ValueStructure	SET	Unordered collection of related items with no repetition.
static final ValueStructure	TABLE	An arrangement of data in which each item may be identified by means of arguments or keys.

Method Summary

Modifier and Type	Method	Description
ValueStructure[]	family()	Returns the list of codes of the same kind as this code list element.
Optional<Class<?>>	toJavaType()	Returns the Java type corresponding to this code list value.
static Optional<ValueStructure>	valueOf(Class<?> type)	Returns the structure corresponding to the given class.
static ValueStructure	valueOf(String code, Class<?> type)	Returns the structure that matches the given string, or returns a new one if none match it.
static ValueStructure[]	values()	Returns the list of ValueStructures.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

BAG

@UML(identifier="bag",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure BAG

Finite, unordered collection of related items that may be repeated. The corresponding Java type is Collection.

SET

@UML(identifier="set",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure SET

Unordered collection of related items with no repetition. The corresponding Java type is Set.

SEQUENCE

@UML(identifier="sequence",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure SEQUENCE

Finite, ordered collection of related items that may be repeated. The corresponding Java type is List.

TABLE

@UML(identifier="table",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure TABLE

An arrangement of data in which each item may be identified by means of arguments or keys. The corresponding Java type is Map.

MATRIX

@UML(identifier="matrix",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure MATRIX

Rectangular array of numbers. The corresponding Java type is Matrix.

COVERAGE

@UML(identifier="coverage",
     obligation=CONDITIONAL,
     specification=ISO_19157)
public static final ValueStructure COVERAGE

Feature that acts as a function to return values from its range for any direct position within its spatial, temporal or spatiotemporal domain.

Method Details

values

public static ValueStructure[] values()

Returns the list of ValueStructures.

Returns:

the list of codes declared in the current JVM.

family

public ValueStructure[] family()

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<ValueStructure>

Returns:

all code values for this code list.

valueOf

public static ValueStructure valueOf(String code,
 Class<?> type)

Returns the structure that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

type - Java type corresponding to the value, or null if unspecified. This is used only if a new code list element is created.

Returns:

a code matching the given name.

valueOf

public static Optional<ValueStructure> valueOf(Class<?> type)

Returns the structure corresponding to the given class. The mapping between Java type and ValueStructure code list is as below:

Mapping from Java type to ValueStructure

Java or GeoAPI type	Code list value
Collection	BAG
Set	SET
List	SEQUENCE
Map	TABLE
Matrix	MATRIX

Parameters:

type - the Java type for which to get a structure, or null if unknown.

Returns:

structure for the given type, or an empty value if there is no value for the given type.

toJavaType

public Optional<Class<?>> toJavaType()

Returns the Java type corresponding to this code list value. The Java type is documented in each code list value.

Returns:

the Java type for this code list value.

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

Added for integration with the Java language.