Class DefaultAggregateInformation
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.DefaultAssociatedResource
org.apache.sis.metadata.iso.identification.DefaultAggregateInformation
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.identification.AggregateInformation
public class DefaultAggregateInformation
extends DefaultAssociatedResource
implements org.opengis.metadata.identification.AggregateInformation
Associated resource information.
The following properties are mandatory or conditional (i.e. mandatory under some circumstances)
in a well-formed metadata according ISO 19115:
According ISO 19115, at least one of name and
metadata reference shall be provided.
MD_AggregateInformation
├─associationType…………
Type of relation between the resources.
├─metadataReference……
Reference to the metadata of the associated resource.
│ ├─title…………………………
Name by which the cited resource is known.
│ └─date……………………………
Reference date for the cited resource.
└─name………………………………………
Citation information about the associated resource.Upcoming API change — renaming
As of ISO 19115:2014,
As of ISO 19115:2014,
AggregateInformation
has been renamed AssociatedResource
.
This class will be replaced by DefaultAssociatedResource
when GeoAPI will provide the
AssociatedResource
interface (tentatively in GeoAPI 3.1 or 4.0).
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 static final long
Serial number for compatibility with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty Aggregate dataset information.Constructs a new instance initialized with the values from the specified metadata object.DefaultAggregateInformation
(org.opengis.metadata.identification.AggregateInformation object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultAggregateInformation
castOrCopy
(org.opengis.metadata.identification.AggregateInformation object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.Identifier
Deprecated.private static org.opengis.metadata.Identifier
getAggregateDataSetIdentifier
(org.opengis.metadata.citation.Citation name) Returns the first identifier of the given citation.org.opengis.metadata.citation.Citation
Deprecated.As of ISO 19115:2014, replaced byDefaultAssociatedResource.getName()
.private org.opengis.metadata.identification.AssociationType
For (un)marshalling theassociationType
element at the location expected by ISO 19139:2007 schemas.private org.opengis.metadata.identification.InitiativeType
For (un)marshalling theinitiativeType
element at the location expected by ISO 19139:2007 schemas.void
setAggregateDataSetIdentifier
(org.opengis.metadata.Identifier newValue) Deprecated.As of ISO 19115:2014, replaced by an identifier ofgetAggregateDataSetName()
.void
setAggregateDataSetName
(org.opengis.metadata.citation.Citation newValue) Deprecated.As of ISO 19115:2014, replaced byDefaultAssociatedResource.setName(Citation)
.private void
setAssociation
(org.opengis.metadata.identification.AssociationType newValue) Must be declared together withgetAssociation()
.private void
setInitiative
(org.opengis.metadata.identification.InitiativeType newValue) Must be declared together withgetInitiative()
.Methods inherited from class org.apache.sis.metadata.iso.identification.DefaultAssociatedResource
getAssociationType, getInitiativeType, getMetadataReference, getName, setAssociationType, setInitiativeType, setMetadataReference, setName
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
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.metadata.identification.AggregateInformation
getAssociationType, getInitiativeType
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for compatibility with different versions.- See Also:
-
-
Constructor Details
-
DefaultAggregateInformation
public DefaultAggregateInformation()Constructs an initially empty Aggregate dataset information. -
DefaultAggregateInformation
DefaultAggregateInformation(DefaultAssociatedResource object) Constructs a new instance initialized with the values from the specified metadata object.- Parameters:
object
- The metadata to copy values from.
-
DefaultAggregateInformation
public DefaultAggregateInformation(org.opengis.metadata.identification.AggregateInformation 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.
-
-
Method Details
-
castOrCopy
public static DefaultAggregateInformation castOrCopy(org.opengis.metadata.identification.AggregateInformation 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 already an instance of
DefaultAggregateInformation
, then it is returned unchanged. - Otherwise a new
DefaultAggregateInformation
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
-
getAggregateDataSetName
Deprecated.As of ISO 19115:2014, replaced byDefaultAssociatedResource.getName()
.Citation information about the aggregate dataset.- Specified by:
getAggregateDataSetName
in interfaceorg.opengis.metadata.identification.AggregateInformation
- Returns:
- citation information about the aggregate dataset, or
null
.
-
setAggregateDataSetName
Deprecated.As of ISO 19115:2014, replaced byDefaultAssociatedResource.setName(Citation)
.Sets the citation information about the aggregate dataset.- Parameters:
newValue
- the new citation.
-
getAggregateDataSetIdentifier
Deprecated.As of ISO 19115:2014, replaced by the first identifier ofgetAggregateDataSetName()
.Identification information about aggregate dataset.- Specified by:
getAggregateDataSetIdentifier
in interfaceorg.opengis.metadata.identification.AggregateInformation
- Returns:
- identification information about aggregate dataset, or
null
.
-
getAggregateDataSetIdentifier
private static org.opengis.metadata.Identifier getAggregateDataSetIdentifier(org.opengis.metadata.citation.Citation name) Returns the first identifier of the given citation. -
setAggregateDataSetIdentifier
Deprecated.As of ISO 19115:2014, replaced by an identifier ofgetAggregateDataSetName()
.Sets the identification information about aggregate dataset.- Parameters:
newValue
- the new identifier.
-
getAssociation
private org.opengis.metadata.identification.AssociationType getAssociation()For (un)marshalling theassociationType
element at the location expected by ISO 19139:2007 schemas. We do not rely onorg.apache.sis.xml.TransformingWriter
reordering mechanism because this element is interleaved with other element to reorder (namely"topicCategory"
and"extent"
), and expandingTransformingWriter
to handle those cases would be complicated. -
setAssociation
private void setAssociation(org.opengis.metadata.identification.AssociationType newValue) Must be declared together withgetAssociation()
. -
getInitiative
private org.opengis.metadata.identification.InitiativeType getInitiative()For (un)marshalling theinitiativeType
element at the location expected by ISO 19139:2007 schemas. SeegetAssociation()
for more explanation. -
setInitiative
private void setInitiative(org.opengis.metadata.identification.InitiativeType newValue) Must be declared together withgetInitiative()
.
-
getAggregateDataSetName()
.