Package org.opengis.metadata.identification

Interface Identification

All Known Subinterfaces:

DataIdentification, ServiceIdentification

@Classifier(ABSTRACT)
@UML(identifier="MD_Identification",
     specification=ISO_19115)
public interface Identification

Basic information required to uniquely identify a resource or resources.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
InternationalString	getAbstract()	Brief narrative summary of the resource.
default Collection<? extends Citation>	getAdditionalDocumentations()	Other documentation associated with the resource.
default Collection<? extends AggregateInformation>	getAggregationInfo()	Deprecated. As of ISO 19115:2014, replaced by getAssociatedResources().
default Collection<? extends AssociatedResource>	getAssociatedResources()	Associated resource information.
Citation	getCitation()	Citation for the resource.
default Collection<String>	getCredits()	Recognition of those who contributed to the resource.
default Collection<? extends Keywords>	getDescriptiveKeywords()	Category keywords, their type, and reference source.
Collection<? extends Extent>	getExtents()	Spatial and temporal extent of the resource.
default Collection<? extends BrowseGraphic>	getGraphicOverviews()	Graphic that illustrates the resource(s) (should include a legend for the graphic).
default Collection<? extends ResponsibleParty>	getPointOfContacts()	Identification of, and means of communication with, person(s) and organisations associated with the resource(s).
default Identifier	getProcessingLevel()	Code that identifies the level of processing in the producers coding system of a resource.
default InternationalString	getPurpose()	Summary of the intentions with which the resource was developed.
default Collection<? extends Constraints>	getResourceConstraints()	Information about constraints which apply to the resource(s).
default Collection<? extends Format>	getResourceFormats()	Description of the format of the resource(s).
default Collection<? extends MaintenanceInformation>	getResourceMaintenances()	Information about the frequency of resource updates, and the scope of those updates.
default Collection<? extends Usage>	getResourceSpecificUsages()	Basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.
default Collection<SpatialRepresentationType>	getSpatialRepresentationTypes()	Methods used to spatially represent geographic information.
default Collection<? extends Resolution>	getSpatialResolutions()	Factor which provides a general understanding of the density of spatial data in the resource.
default Collection<Progress>	getStatus()	Status of the resource.
default Collection<? extends Duration>	getTemporalResolutions()	Smallest resolvable temporal period in a resource.
Collection<TopicCategory>	getTopicCategories()	Main theme(s) of the resource.

Method Detail

getCitation

@Profile(level=CORE)
@UML(identifier="citation",
     obligation=MANDATORY,
     specification=ISO_19115)
Citation getCitation()

Citation for the resource.

Returns:

citation for the resource.

getAbstract

@Profile(level=CORE)
@UML(identifier="abstract",
     obligation=MANDATORY,
     specification=ISO_19115)
InternationalString getAbstract()

Brief narrative summary of the resource.

Returns:

brief narrative summary of the resource.

getPurpose

@UML(identifier="purpose",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getPurpose()

Summary of the intentions with which the resource was developed.

Returns:

the intentions with which the resource was developed, or null.

getCredits

@UML(identifier="credit",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<String> getCredits()

Recognition of those who contributed to the resource.

Upcoming API change — internationalization
The return type will be changed to Collection<? extends InternationalString> in GeoAPI 4.0.

Returns:

recognition of those who contributed to the resource.

getStatus

@UML(identifier="status",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<Progress> getStatus()

Status of the resource.

Returns:

status of the resource.

getPointOfContacts

@Profile(level=CORE)
@UML(identifier="pointOfContact",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Collection<? extends ResponsibleParty> getPointOfContacts()

Identification of, and means of communication with, person(s) and organisations associated with the resource(s).

Upcoming API change — generalization
As of ISO 19115:2014, ResponsibleParty is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Returns:

means of communication with person(s) and organisations(s) associated with the resource.

See Also:

Metadata.getContacts()

getSpatialRepresentationTypes

@UML(identifier="spatialRepresentationType",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<SpatialRepresentationType> getSpatialRepresentationTypes()

Methods used to spatially represent geographic information.

Returns:

methods used to spatially represent geographic information.

Since:

3.1

getSpatialResolutions

@Profile(level=CORE)
@UML(identifier="spatialResolution",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Resolution> getSpatialResolutions()

Factor which provides a general understanding of the density of spatial data in the resource. May also describe the range of resolutions in which a digital resource may be used.

Note: This element should be repeated when describing upper and lower range.

Returns:

factor which provides a general understanding of the density of spatial resource.

Since:

3.1

getTemporalResolutions

@UML(identifier="temporalResolution",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Duration> getTemporalResolutions()

Smallest resolvable temporal period in a resource.

Returns:

smallest resolvable temporal period in a resource.

Since:

3.1

getTopicCategories

@Profile(level=CORE)
@UML(identifier="topicCategory",
     obligation=CONDITIONAL,
     specification=ISO_19115)
Collection<TopicCategory> getTopicCategories()

Main theme(s) of the resource.

Returns:

main theme(s).

Since:

3.1

Condition:

Mandatory if MetadataScope.getResourceScope() equals ScopeCode.DATASET or ScopeCode.SERIES.

getExtents

@Profile(level=CORE)
@UML(identifier="extent",
     obligation=CONDITIONAL,
     specification=ISO_19115)
Collection<? extends Extent> getExtents()

Spatial and temporal extent of the resource.

Returns:

spatial and temporal extent of the resource.

Since:

3.1

Condition:

Mandatory with either a geographic bounding box or a geographic description if MetadataScope.getResourceScope() equals ScopeCode.DATASET or ScopeCode.SERIES.

getAdditionalDocumentations

@UML(identifier="additionalDocumentation",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Citation> getAdditionalDocumentations()

Other documentation associated with the resource.

Example: related articles, publications, user guides, data dictionaries.

Returns:

other documentation associated with the resource.

Since:

3.1

getProcessingLevel

@UML(identifier="processingLevel",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Identifier getProcessingLevel()

Code that identifies the level of processing in the producers coding system of a resource.

Example: NOAA level 1B.

Returns:

code that identifies the level of processing in the producers coding system of a resource.

Since:

3.1

See Also:

CoverageDescription.getProcessingLevelCode()

getResourceMaintenances

@UML(identifier="resourceMaintenance",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends MaintenanceInformation> getResourceMaintenances()

Information about the frequency of resource updates, and the scope of those updates.

Returns:

frequency and scope of resource updates.

getGraphicOverviews

@UML(identifier="graphicOverview",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends BrowseGraphic> getGraphicOverviews()

Graphic that illustrates the resource(s) (should include a legend for the graphic).

Returns:

a graphic that illustrates the resource(s).

getResourceFormats

@UML(identifier="resourceFormat",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Format> getResourceFormats()

Description of the format of the resource(s).

Returns:

description of the format.

See Also:

Distribution.getDistributionFormats()

getDescriptiveKeywords

@UML(identifier="descriptiveKeywords",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Keywords> getDescriptiveKeywords()

Category keywords, their type, and reference source.

Returns:

category keywords, their type, and reference source.

getResourceSpecificUsages

@UML(identifier="resourceSpecificUsage",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Usage> getResourceSpecificUsages()

Basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.

Returns:

information about specific application(s) for which the resource(s) has/have been or is being used.

getResourceConstraints

@UML(identifier="resourceConstraints",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Constraints> getResourceConstraints()

Information about constraints which apply to the resource(s).

Returns:

constraints which apply to the resource(s).

getAssociatedResources

@UML(identifier="associatedResource",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends AssociatedResource> getAssociatedResources()

Associated resource information.

Returns:

associated resource information.

Since:

3.1

getAggregationInfo

@Deprecated
@UML(identifier="aggregationInfo",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2003)
default Collection<? extends AggregateInformation> getAggregationInfo()

Deprecated.

As of ISO 19115:2014, replaced by getAssociatedResources().

Aggregate dataset information.

Returns:

aggregate dataset information.