Class AbstractIdentification
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.identification.AbstractIdentification
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.identification.Identification
- Direct Known Subclasses:
DefaultDataIdentification
,DefaultServiceIdentification
public class AbstractIdentification
extends ISOMetadata
implements org.opengis.metadata.identification.Identification
Basic information required to uniquely identify a resource or resources.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
MD_Identification
├─citation………………………………………
Citation data for the resource(s).
│ ├─title……………………………………
Name by which the cited resource is known.
│ └─date………………………………………
Reference date for the cited resource.
├─abstract………………………………………
Brief narrative summary of the content of the resource(s).
├─extent……………………………………………
Bounding polygon, vertical, and temporal extent of the dataset.
│ ├─description……………………
The spatial and temporal extent for the referring object.
│ ├─geographicElement……
Geographic component of the extent of the referring object.
│ ├─temporalElement…………
Temporal component of the extent of the referring object.
│ └─verticalElement…………
Vertical component of the extent of the referring object.
└─topicCategory…………………………
Main theme(s) of the dataset.Limitations
- Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
- Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases.
Serialization support is appropriate for short term storage or RMI between applications running the
same version of Apache SIS. For long term storage, use
XML
instead.
- Since:
- 0.3
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.util.InternationalString
Brief narrative summary of the resource(s).private Collection
<org.opengis.metadata.citation.Citation> Other documentation associated with the resource.private Collection
<DefaultAssociatedResource> Provides aggregate dataset information.private org.opengis.metadata.citation.Citation
Citation for the resource(s).private Collection
<String> Recognition of those who contributed to the resource(s).private Collection
<org.opengis.metadata.identification.Keywords> Provides category keywords, their type, and reference source.private Collection
<org.opengis.metadata.extent.Extent> Spatial and temporal extent of the resource.private Collection
<org.opengis.metadata.identification.BrowseGraphic> Provides a graphic that illustrates the resource(s) (should include a legend for the graphic).private Collection
<org.opengis.metadata.citation.ResponsibleParty> Identification of, and means of communication with, person(s) and organizations(s) associated with the resource(s).private org.opengis.metadata.Identifier
Code that identifies the level of processing in the producers coding system of a resource.private org.opengis.util.InternationalString
Summary of the intentions with which the resource(s) was developed.private Collection
<org.opengis.metadata.constraint.Constraints> Provides information about constraints which apply to the resource(s).private Collection
<org.opengis.metadata.distribution.Format> Provides a description of the format of the resource(s).private Collection
<org.opengis.metadata.maintenance.MaintenanceInformation> Provides information about the frequency of resource updates, and the scope of those updates.private Collection
<org.opengis.metadata.identification.Usage> Provides basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.private static final long
Serial number for compatibility with different versions.private Collection
<org.opengis.metadata.spatial.SpatialRepresentationType> Methods used to spatially represent geographic information.private Collection
<org.opengis.metadata.identification.Resolution> Factor which provides a general understanding of the density of spatial data in the resource(s).private Collection
<org.opengis.metadata.identification.Progress> Status of the resource(s).private Collection
<org.opengis.metadata.identification.TopicCategory> Main theme(s) of the resource.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty identification.AbstractIdentification
(org.opengis.metadata.citation.Citation citation, CharSequence abstracts) Creates an identification initialized to the specified values.AbstractIdentification
(org.opengis.metadata.identification.Identification object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic AbstractIdentification
castOrCopy
(org.opengis.metadata.identification.Identification object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.util.InternationalString
Returns a brief narrative summary of the resource(s).private Collection
<org.opengis.metadata.citation.Citation> Invoked by JAXB at both marshalling and unmarshalling time.Collection
<org.opengis.metadata.citation.Citation> Returns other documentation associated with the resource.Collection
<org.opengis.metadata.identification.AggregateInformation> Deprecated.private Collection
<DefaultAssociatedResource> Provides associated resource information.org.opengis.metadata.citation.Citation
Returns the citation for the resource(s).Returns the recognition of those who contributed to the resource(s).Collection
<org.opengis.metadata.identification.Keywords> Provides category keywords, their type, and reference source.Collection
<org.opengis.metadata.extent.Extent> Returns the spatial and temporal extent of the resource.Collection
<org.opengis.metadata.identification.BrowseGraphic> Provides a graphic that illustrates the resource(s) (should include a legend for the graphic).Collection
<org.opengis.metadata.citation.ResponsibleParty> Returns the identification of, and means of communication with, person(s) and organizations(s) associated with the resource(s).org.opengis.metadata.Identifier
Returns code(s) that identifies the level of processing in the producers coding system of a resource.org.opengis.util.InternationalString
Returns a summary of the intentions with which the resource(s) was developed.Collection
<org.opengis.metadata.constraint.Constraints> Provides information about constraints which apply to the resource(s).Collection
<org.opengis.metadata.distribution.Format> Provides a description of the format of the resource(s).Collection
<org.opengis.metadata.maintenance.MaintenanceInformation> Provides information about the frequency of resource updates, and the scope of those updates.Collection
<org.opengis.metadata.identification.Usage> Provides basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.Collection
<org.opengis.metadata.spatial.SpatialRepresentationType> Returns the methods used to spatially represent geographic information.Collection
<org.opengis.metadata.identification.Resolution> Returns the factor which provides a general understanding of the density of spatial data in the resource(s).Collection
<org.opengis.metadata.identification.Progress> Returns the status of the resource(s).Collection
<org.opengis.metadata.identification.TopicCategory> Returns the main theme(s) of the resource.void
setAbstract
(org.opengis.util.InternationalString newValue) Sets a brief narrative summary of the resource(s).void
setAdditionalDocumentations
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets other documentation associated with the resource.void
setAggregationInfo
(Collection<? extends org.opengis.metadata.identification.AggregateInformation> newValues) Deprecated.As of ISO 19115:2014, replaced bysetAssociatedResources(Collection)
.void
setAssociatedResources
(Collection<? extends DefaultAssociatedResource> newValues) Sets associated resource information.void
setCitation
(org.opengis.metadata.citation.Citation newValue) Sets the citation for the resource(s).void
setCredits
(Collection<? extends String> newValues) Sets the recognition of those who contributed to the resource(s).void
setDescriptiveKeywords
(Collection<? extends org.opengis.metadata.identification.Keywords> newValues) Sets category keywords, their type, and reference source.void
setExtents
(Collection<? extends org.opengis.metadata.extent.Extent> newValues) Sets the spatial and temporal extent of the resource.void
setGraphicOverviews
(Collection<? extends org.opengis.metadata.identification.BrowseGraphic> newValues) Sets a graphic that illustrates the resource(s).void
setPointOfContacts
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the means of communication with persons(s) and organizations(s) associated with the resource(s).void
setProcessingLevel
(org.opengis.metadata.Identifier newValue) Sets code that identifies the level of processing in the producers coding system of a resource.void
setPurpose
(org.opengis.util.InternationalString newValue) Sets a summary of the intentions with which the resource(s) was developed.void
setResourceConstraints
(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets information about constraints which apply to the resource(s).void
setResourceFormats
(Collection<? extends org.opengis.metadata.distribution.Format> newValues) Sets a description of the format of the resource(s).void
setResourceMaintenances
(Collection<? extends org.opengis.metadata.maintenance.MaintenanceInformation> newValues) Sets information about the frequency of resource updates, and the scope of those updates.void
setResourceSpecificUsages
(Collection<? extends org.opengis.metadata.identification.Usage> newValues) Sets basic information about specific application(s).void
setSpatialRepresentationTypes
(Collection<? extends org.opengis.metadata.spatial.SpatialRepresentationType> newValues) Sets the method used to spatially represent geographic information.void
setSpatialResolutions
(Collection<? extends org.opengis.metadata.identification.Resolution> newValues) Sets the factor which provides a general understanding of the density of spatial data in the resource(s).void
setStatus
(Collection<? extends org.opengis.metadata.identification.Progress> newValues) Sets the status of the resource(s).void
setTopicCategories
(Collection<? extends org.opengis.metadata.identification.TopicCategory> newValues) Sets the main theme(s) of the resource.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
citation
private org.opengis.metadata.citation.Citation citationCitation for the resource(s). -
abstracts
private org.opengis.util.InternationalString abstractsBrief narrative summary of the resource(s). -
purpose
private org.opengis.util.InternationalString purposeSummary of the intentions with which the resource(s) was developed. -
credits
Recognition of those who contributed to the resource(s). -
status
Status of the resource(s). -
pointOfContacts
Identification of, and means of communication with, person(s) and organizations(s) associated with the resource(s). -
spatialRepresentationTypes
private Collection<org.opengis.metadata.spatial.SpatialRepresentationType> spatialRepresentationTypesMethods used to spatially represent geographic information. -
spatialResolutions
Factor which provides a general understanding of the density of spatial data in the resource(s). -
topicCategories
Main theme(s) of the resource. -
extents
Spatial and temporal extent of the resource. -
additionalDocumentations
Other documentation associated with the resource. -
processingLevel
private org.opengis.metadata.Identifier processingLevelCode that identifies the level of processing in the producers coding system of a resource. -
resourceMaintenances
Provides information about the frequency of resource updates, and the scope of those updates. -
graphicOverviews
Provides a graphic that illustrates the resource(s) (should include a legend for the graphic). -
resourceFormats
Provides a description of the format of the resource(s). -
descriptiveKeywords
Provides category keywords, their type, and reference source. -
resourceSpecificUsages
Provides basic information about specific application(s) for which the resource(s) has/have been or is being used by different users. -
resourceConstraints
Provides information about constraints which apply to the resource(s). -
associatedResources
Provides aggregate dataset information.
-
-
Constructor Details
-
AbstractIdentification
public AbstractIdentification()Constructs an initially empty identification. -
AbstractIdentification
public AbstractIdentification(org.opengis.metadata.citation.Citation citation, CharSequence abstracts) Creates an identification initialized to the specified values.- Parameters:
citation
- the citation data for the resource(s), ornull
if none.abstracts
- a brief narrative summary of the content of the resource(s), ornull
if none.
-
AbstractIdentification
public AbstractIdentification(org.opengis.metadata.identification.Identification object) Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.- Parameters:
object
- the metadata to copy values from, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static AbstractIdentification castOrCopy(org.opengis.metadata.identification.Identification object) Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:- If the given object is
null
, then this method returnsnull
. - Otherwise if the given object is an instance of
DataIdentification
orServiceIdentification
, then this method delegates to thecastOrCopy(…)
method of the corresponding SIS subclass. Note that if the given object implements more than one of the above-cited interfaces, then thecastOrCopy(…)
method to be used is unspecified. - Otherwise if the given object is already an instance of
AbstractIdentification
, then it is returned unchanged. - Otherwise a new
AbstractIdentification
instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
- If the given object is
-
getCitation
public org.opengis.metadata.citation.Citation getCitation()Returns the citation for the resource(s).- Specified by:
getCitation
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- citation for the resource(s).
-
setCitation
public void setCitation(org.opengis.metadata.citation.Citation newValue) Sets the citation for the resource(s).- Parameters:
newValue
- the new citation.
-
getAbstract
public org.opengis.util.InternationalString getAbstract()Returns a brief narrative summary of the resource(s).- Specified by:
getAbstract
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- brief narrative summary of the resource(s).
-
setAbstract
public void setAbstract(org.opengis.util.InternationalString newValue) Sets a brief narrative summary of the resource(s).- Parameters:
newValue
- the new summary of resource(s).
-
getPurpose
public org.opengis.util.InternationalString getPurpose()Returns a summary of the intentions with which the resource(s) was developed.- Specified by:
getPurpose
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- the intentions with which the resource(s) was developed, or
null
.
-
setPurpose
public void setPurpose(org.opengis.util.InternationalString newValue) Sets a summary of the intentions with which the resource(s) was developed.- Parameters:
newValue
- the new summary of intention.
-
getCredits
Returns the recognition of those who contributed to the resource(s).Upcoming API change — generalization
The element type may be changed to theInternationalString
interface in GeoAPI 4.0.- Specified by:
getCredits
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- recognition of those who contributed to the resource(s).
-
setCredits
Sets the recognition of those who contributed to the resource(s).Upcoming API change — generalization
The element type may be changed to theInternationalString
interface in GeoAPI 4.0.- Parameters:
newValues
- the new credits.
-
getStatus
Returns the status of the resource(s).- Specified by:
getStatus
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- status of the resource(s), or
null
.
-
setStatus
Sets the status of the resource(s).- Parameters:
newValues
- the new status.
-
getPointOfContacts
Returns the identification of, and means of communication with, person(s) and organizations(s) associated with the resource(s).Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change may be applied in GeoAPI 4.0.- Specified by:
getPointOfContacts
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- means of communication with person(s) and organizations(s) associated with the resource(s).
- See Also:
-
setPointOfContacts
public void setPointOfContacts(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the means of communication with persons(s) and organizations(s) associated with the resource(s).Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change may be applied in GeoAPI 4.0.- Parameters:
newValues
- the new points of contacts.
-
getSpatialRepresentationTypes
@UML(identifier="spatialRepresentationType", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.spatial.SpatialRepresentationType> getSpatialRepresentationTypes()Returns the methods used to spatially represent geographic information.- Returns:
- methods used to spatially represent geographic information.
- Since:
- 0.5
-
setSpatialRepresentationTypes
public void setSpatialRepresentationTypes(Collection<? extends org.opengis.metadata.spatial.SpatialRepresentationType> newValues) Sets the method used to spatially represent geographic information.- Parameters:
newValues
- the new spatial representation types.- Since:
- 0.5
-
getSpatialResolutions
@UML(identifier="spatialResolution", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.identification.Resolution> getSpatialResolutions()Returns the factor which provides a general understanding of the density of spatial data in the resource(s). This element should be repeated when describing upper and lower range.- Returns:
- factor which provides a general understanding of the density of spatial data.
- Since:
- 0.5
-
setSpatialResolutions
public void setSpatialResolutions(Collection<? extends org.opengis.metadata.identification.Resolution> newValues) Sets the factor which provides a general understanding of the density of spatial data in the resource(s).- Parameters:
newValues
- the new spatial resolutions.- Since:
- 0.5
-
getTopicCategories
@UML(identifier="topicCategory", obligation=CONDITIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.identification.TopicCategory> getTopicCategories()Returns the main theme(s) of the resource.- Returns:
- main theme(s).
- Since:
- 0.5
-
setTopicCategories
public void setTopicCategories(Collection<? extends org.opengis.metadata.identification.TopicCategory> newValues) Sets the main theme(s) of the resource.- Parameters:
newValues
- the new topic categories.- Since:
- 0.5
-
getExtents
@UML(identifier="extent", obligation=CONDITIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.extent.Extent> getExtents()Returns the spatial and temporal extent of the resource.- Returns:
- spatial and temporal extent of the resource.
- Since:
- 0.5
-
setExtents
Sets the spatial and temporal extent of the resource.- Parameters:
newValues
- the new extents- Since:
- 0.5
-
getAdditionalDocumentations
@UML(identifier="additionalDocumentation", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.citation.Citation> getAdditionalDocumentations()Returns other documentation associated with the resource.- Returns:
- other documentation associated with the resource.
- Since:
- 0.5
-
setAdditionalDocumentations
public void setAdditionalDocumentations(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets other documentation associated with the resource.- Parameters:
newValues
- the documentation to associate with the resource.- Since:
- 0.5
-
getProcessingLevel
@UML(identifier="processingLevel", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.metadata.Identifier getProcessingLevel()Returns code(s) that identifies the level of processing in the producers coding system of a resource.- Returns:
- code(s) that identifies the level of processing in the producers coding system of a resource.
- Since:
- 0.5
-
setProcessingLevel
public void setProcessingLevel(org.opengis.metadata.Identifier newValue) Sets code that identifies the level of processing in the producers coding system of a resource.- Parameters:
newValue
- New code that identifies the level of processing.- Since:
- 0.5
-
getResourceMaintenances
public Collection<org.opengis.metadata.maintenance.MaintenanceInformation> getResourceMaintenances()Provides information about the frequency of resource updates, and the scope of those updates.- Specified by:
getResourceMaintenances
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- frequency and scope of resource updates.
-
setResourceMaintenances
public void setResourceMaintenances(Collection<? extends org.opengis.metadata.maintenance.MaintenanceInformation> newValues) Sets information about the frequency of resource updates, and the scope of those updates.- Parameters:
newValues
- the new resource maintenance info.
-
getGraphicOverviews
Provides a graphic that illustrates the resource(s) (should include a legend for the graphic).- Specified by:
getGraphicOverviews
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- a graphic that illustrates the resource(s).
-
setGraphicOverviews
public void setGraphicOverviews(Collection<? extends org.opengis.metadata.identification.BrowseGraphic> newValues) Sets a graphic that illustrates the resource(s).- Parameters:
newValues
- the new graphics overviews.
-
getResourceFormats
Provides a description of the format of the resource(s).- Specified by:
getResourceFormats
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- description of the format.
- See Also:
-
setResourceFormats
public void setResourceFormats(Collection<? extends org.opengis.metadata.distribution.Format> newValues) Sets a description of the format of the resource(s).- Parameters:
newValues
- the new resource format.- See Also:
-
getDescriptiveKeywords
Provides category keywords, their type, and reference source.- Specified by:
getDescriptiveKeywords
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- category keywords, their type, and reference source.
-
setDescriptiveKeywords
public void setDescriptiveKeywords(Collection<? extends org.opengis.metadata.identification.Keywords> newValues) Sets category keywords, their type, and reference source.- Parameters:
newValues
- the new descriptive keywords.
-
getResourceSpecificUsages
Provides basic information about specific application(s) for which the resource(s) has/have been or is being used by different users.- Specified by:
getResourceSpecificUsages
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- information about specific application(s) for which the resource(s) has/have been or is being used.
-
setResourceSpecificUsages
public void setResourceSpecificUsages(Collection<? extends org.opengis.metadata.identification.Usage> newValues) Sets basic information about specific application(s).- Parameters:
newValues
- the new resource specific usages.
-
getResourceConstraints
Provides information about constraints which apply to the resource(s).- Specified by:
getResourceConstraints
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- constraints which apply to the resource(s).
-
setResourceConstraints
public void setResourceConstraints(Collection<? extends org.opengis.metadata.constraint.Constraints> newValues) Sets information about constraints which apply to the resource(s).- Parameters:
newValues
- the new resource constraints.
-
getAssociatedResources
@UML(identifier="associatedResource", obligation=OPTIONAL, specification=ISO_19115) public Collection<DefaultAssociatedResource> getAssociatedResources()Provides associated resource information.Upcoming API change — generalization
The element type will be changed to theAssociatedResource
interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Returns:
- associated resource information.
- Since:
- 0.5
-
setAssociatedResources
Sets associated resource information.Upcoming API change — generalization
The element type will be changed to theAssociatedResource
interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).- Parameters:
newValues
- the new associated resources.- Since:
- 0.5
-
getAggregationInfo
@Deprecated public Collection<org.opengis.metadata.identification.AggregateInformation> getAggregationInfo()Deprecated.As of ISO 19115:2014, replaced bygetAssociatedResources()
.Provides aggregate dataset information.- Specified by:
getAggregationInfo
in interfaceorg.opengis.metadata.identification.Identification
- Returns:
- aggregate dataset information.
-
setAggregationInfo
@Deprecated public void setAggregationInfo(Collection<? extends org.opengis.metadata.identification.AggregateInformation> newValues) Deprecated.As of ISO 19115:2014, replaced bysetAssociatedResources(Collection)
.Sets aggregate dataset information.- Parameters:
newValues
- the new aggregation info.
-
getAdditionalDocumentation
Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute. -
getAssociatedResource
-
getAssociatedResources()
.