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

Class DefaultAggregateInformation

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultAssociatedResource
DefaultAggregateInformation
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Aggregate­Information
public class DefaultAggregateInformation extends DefaultAssociatedResource implements 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_Aggregate­Information   ├─association­Type………… Type of relation between the resources.   ├─metadata­Reference…… 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, Aggregate­Information has been renamed Associated­Resource. This class will be replaced by Default­Associated­Resource when GeoAPI will provide the Associated­Resource 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
See Also:

  • Constructor Details

    • DefaultAggregateInformation

      public DefaultAggregateInformation()
      Constructs an initially empty Aggregate dataset information.

    • DefaultAggregateInformation

      public DefaultAggregateInformation(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(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 Default­Aggregate­Information, then it is returned unchanged.
      • Otherwise a new Default­Aggregate­Information 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(since="1.0") public Citation getAggregateDataSetName()
      Deprecated.
      As of ISO 19115:2014, replaced by Default­Associated­Resource​.get­Name().
      Citation information about the aggregate dataset.
      Specified by:
      get­Aggregate­Data­Set­Name in interface Aggregate­Information
      Returns:
      citation information about the aggregate dataset, or null.

    • setAggregateDataSetName

      @Deprecated(since="1.0") public void setAggregateDataSetName(Citation newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by Default­Associated­Resource​.set­Name(Citation).
      Sets the citation information about the aggregate dataset.
      Parameters:
      new­Value - the new citation.

    • getAggregateDataSetIdentifier

      @Deprecated(since="1.0") public Identifier getAggregateDataSetIdentifier()
      Deprecated.
      As of ISO 19115:2014, replaced by the first identifier of get­Aggregate­Data­Set­Name().
      Identification information about aggregate dataset.
      Specified by:
      get­Aggregate­Data­Set­Identifier in interface Aggregate­Information
      Returns:
      identification information about aggregate dataset, or null.

    • setAggregateDataSetIdentifier

      @Deprecated(since="1.0") public void setAggregateDataSetIdentifier(Identifier newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by an identifier of get­Aggregate­Data­Set­Name().
      Sets the identification information about aggregate dataset.
      Parameters:
      new­Value - the new identifier.