Module org.opengis.geoapi

Package org.opengis.metadata.maintenance

Class ScopeCode

Object

CodeList<ScopeCode>

ScopeCode

All Implemented Interfaces:

Serializable, Comparable<ScopeCode>, ControlledVocabulary

@UML(identifier="MD_ScopeCode",
     specification=ISO_19115)
public final class ScopeCode
extends CodeList<ScopeCode>

Class of information to which the referencing entity applies.

Since:

2.0

See Also:

• Scope
• 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 ScopeCode	AGGREGATE	Information applies to an aggregate resource.
static final ScopeCode	APPLICATION	Information resource hosted on a specific set of hardware and accessible over network.
static final ScopeCode	ATTRIBUTE	Information applies to the attribute value.
static final ScopeCode	ATTRIBUTE_TYPE	Information applies to the characteristic of a feature.
static final ScopeCode	COLLECTION	Information applies to an unstructured set.
static final ScopeCode	COLLECTION_HARDWARE	Information applies to the collection hardware class.
static final ScopeCode	COLLECTION_SESSION	Information applies to the collection session.
static final ScopeCode	COVERAGE	Information applies to a coverage.
static final ScopeCode	DATASET	Information applies to a consistent spatial data product that can be provided by a data distributor.
static final ScopeCode	DIMENSION_GROUP	Information applies to a dimension group.
static final ScopeCode	DOCUMENT	Information applies to a document.
static final ScopeCode	FEATURE	Information applies to spatial constructs (features) that have a direct correspondence with a real world object.
static final ScopeCode	FEATURE_TYPE	Information applies to a group of spatial primitives (geometric objects) that have a common type.
static final ScopeCode	FIELD_SESSION	Information applies to a field session.
static final ScopeCode	INITIATIVE	Information applies to an initiative.
static final ScopeCode	METADATA	Information applies to metadata.
static final ScopeCode	MODEL	Information applies to a copy or imitation of an existing or hypothetical object.
static final ScopeCode	NON_GEOGRAPHIC_DATASET	Information applies to non-geographic data.
static final ScopeCode	PRODUCT	Metadata describing an ISO 19131 data product specification.
static final ScopeCode	PROPERTY_TYPE	Information applies to a property type.
static final ScopeCode	REPOSITORY	Information applies to a repository.
static final ScopeCode	SAMPLE	Information applies to a sample.
static final ScopeCode	SERIES	Information applies to a collection of spatial data which share similar characteristics of theme, source date, resolution, and methodology.
static final ScopeCode	SERVICE	Information applies to a capability which a service provider entity makes available to a service user entity through a set of interfaces that define a behaviour, such as a use case.
static final ScopeCode	SOFTWARE	Information applies to a computer program or routine.
static final ScopeCode	TILE	Information applies to a tile, a spatial subset of geographic data.

Method Summary

Modifier and Type	Method	Description
ScopeCode[]	family()	Returns the list of codes of the same kind as this code list element.
static ScopeCode	valueOf(String code)	Returns the scope code that matches the given string, or returns a new one if none match it.
static ScopeCode[]	values()	Returns the list of ScopeCodes.

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

COLLECTION_HARDWARE

@UML(identifier="collectionHardware",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode COLLECTION_HARDWARE

Information applies to the collection hardware class.

COLLECTION_SESSION

@UML(identifier="collectionSession",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode COLLECTION_SESSION

Information applies to the collection session.

SERIES

@UML(identifier="series",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode SERIES

Information applies to a collection of spatial data which share similar characteristics of theme, source date, resolution, and methodology. The exact definition of what constitutes a series is determined by the data provider. Examples of data series metadata entries may include:

• A flight line of digital aerial photographs collected during a single flight with one camera and film type.
• A continuous scan swathe collected from a satellite using the same sensors on a single orbital pass.
• A collection of raster map data captured from a common series of paper maps.
• A collection of vector datasets depicting surface hydrography with associated attribution for multiple administrative areas within a country.

DATASET

@UML(identifier="dataset",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode DATASET

Information applies to a consistent spatial data product that can be provided by a data distributor. A dataset may be a member of a data series. A dataset may be composed of a set of feature types and instances, and attribute types and instances.

See Also:

• ScopeDescription.getDataset()

NON_GEOGRAPHIC_DATASET

@UML(identifier="nonGeographicDataset",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode NON_GEOGRAPHIC_DATASET

Information applies to non-geographic data.

DIMENSION_GROUP

@UML(identifier="dimensionGroup",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode DIMENSION_GROUP

Information applies to a dimension group.

FEATURE_TYPE

@UML(identifier="featureType",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode FEATURE_TYPE

Information applies to a group of spatial primitives (geometric objects) that have a common type. Example (compare with FEATURE):

• All bridges within a dataset.

Feature type metadata are grouped in datasets.

See Also:

• ScopeDescription.getFeatures()

FEATURE

@UML(identifier="feature",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode FEATURE

Information applies to spatial constructs (features) that have a direct correspondence with a real world object. Examples (compare with FEATURE_TYPE):

• The Sydney harbour bridge.
• The Golden Gate bridge, in San Francisco.

Feature instance metadata are grouped in datasets.

See Also:

• ScopeDescription.getFeatureInstances()

ATTRIBUTE_TYPE

@UML(identifier="attributeType",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode ATTRIBUTE_TYPE

Information applies to the characteristic of a feature. Attribute types are the digital parameters that describe a common aspect of grouped spatial primitives (geometric objects). Example (compare with ATTRIBUTE):

• Overhead clearance associated with a bridge.

Attribute type metadata are grouped in datasets.

See Also:

• ScopeDescription.getAttributes()

ATTRIBUTE

@UML(identifier="attribute",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode ATTRIBUTE

Information applies to the attribute value. Attribute instances are the digital parameters that describe an aspect of a feature instance. Example (compare with ATTRIBUTE_TYPE):

• The overhead clearance associated with a specific bridge across a road.

Attribute instance metadata are grouped in datasets.

See Also:

• ScopeDescription.getAttributeInstances()

PROPERTY_TYPE

@UML(identifier="propertyType",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode PROPERTY_TYPE

Information applies to a property type.

FIELD_SESSION

@UML(identifier="fieldSession",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode FIELD_SESSION

Information applies to a field session.

SOFTWARE

@UML(identifier="software",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode SOFTWARE

Information applies to a computer program or routine.

SERVICE

@UML(identifier="service",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode SERVICE

Information applies to a capability which a service provider entity makes available to a service user entity through a set of interfaces that define a behaviour, such as a use case.

MODEL

@UML(identifier="model",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode MODEL

Information applies to a copy or imitation of an existing or hypothetical object.

TILE

@UML(identifier="tile",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode TILE

Information applies to a tile, a spatial subset of geographic data.

METADATA

@UML(identifier="metadata",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode METADATA

Information applies to metadata.

Since:

3.1

INITIATIVE

@UML(identifier="initiative",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode INITIATIVE

Information applies to an initiative.

Since:

3.1

SAMPLE

@UML(identifier="sample",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode SAMPLE

Information applies to a sample.

Since:

3.1

DOCUMENT

@UML(identifier="document",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode DOCUMENT

Information applies to a document.

Since:

3.1

REPOSITORY

@UML(identifier="repository",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode REPOSITORY

Information applies to a repository.

Since:

3.1

AGGREGATE

@UML(identifier="aggregate",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode AGGREGATE

Information applies to an aggregate resource.

Since:

3.1

PRODUCT

@UML(identifier="product",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode PRODUCT

Metadata describing an ISO 19131 data product specification.

Since:

3.1

COLLECTION

@UML(identifier="collection",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode COLLECTION

Information applies to an unstructured set.

Since:

3.1

COVERAGE

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

Information applies to a coverage.

Since:

3.1

APPLICATION

@UML(identifier="application",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final ScopeCode APPLICATION

Information resource hosted on a specific set of hardware and accessible over network.

Since:

3.1

Method Details

values

public static ScopeCode[] values()

Returns the list of ScopeCodes.

Returns:

the list of codes declared in the current JVM.

family

public ScopeCode[] 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<ScopeCode>

Returns:

all code values for this code list.

valueOf

public static ScopeCode valueOf(String code)

Returns the scope code 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.

Returns:

a code matching the given name.