Package org.apache.sis.metadata.iso.identification

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:
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.
According ISO 19115, at least one of name and metadata reference shall be provided.
Upcoming API change — renaming
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:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial 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, or null 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 returns null.
      • 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, or null 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.

    • getAggregateDataSetName

      @Deprecated public org.opengis.metadata.citation.Citation getAggregateDataSetName()
      Deprecated.
      As of ISO 19115:2014, replaced by DefaultAssociatedResource.getName().
      Citation information about the aggregate dataset.
      Specified by:
      getAggregateDataSetName in interface org.opengis.metadata.identification.AggregateInformation
      Returns:
      citation information about the aggregate dataset, or null.

    • setAggregateDataSetName

      @Deprecated public void setAggregateDataSetName(org.opengis.metadata.citation.Citation newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by DefaultAssociatedResource.setName(Citation).
      Sets the citation information about the aggregate dataset.
      Parameters:
      newValue - the new citation.

    • getAggregateDataSetIdentifier

      @Deprecated public org.opengis.metadata.Identifier getAggregateDataSetIdentifier()
      Deprecated.
      As of ISO 19115:2014, replaced by the first identifier of getAggregateDataSetName().
      Identification information about aggregate dataset.
      Specified by:
      getAggregateDataSetIdentifier in interface org.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 public void setAggregateDataSetIdentifier(org.opengis.metadata.Identifier newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by an identifier of getAggregateDataSetName().
      Sets the identification information about aggregate dataset.
      Parameters:
      newValue - the new identifier.

    • getAssociation

      private org.opengis.metadata.identification.AssociationType getAssociation()
      For (un)marshalling the associationType element at the location expected by ISO 19139:2007 schemas. We do not rely on org.apache.sis.xml.TransformingWriter reordering mechanism because this element is interleaved with other element to reorder (namely "topicCategory" and "extent"), and expanding TransformingWriter to handle those cases would be complicated.

    • setAssociation

      private void setAssociation(org.opengis.metadata.identification.AssociationType newValue)
      Must be declared together with getAssociation().

    • getInitiative

      private org.opengis.metadata.identification.InitiativeType getInitiative()
      For (un)marshalling the initiativeType element at the location expected by ISO 19139:2007 schemas. See getAssociation() for more explanation.

    • setInitiative

      private void setInitiative(org.opengis.metadata.identification.InitiativeType newValue)
      Must be declared together with getInitiative().