Class DefaultFormat

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.distribution.Format

public class DefaultFormat extends ISOMetadata implements org.opengis.metadata.distribution.Format
Description of the computer language construct that specifies the representation of data objects in a record, file, message, storage device or transmission channel. The following properties are mandatory in a well-formed metadata according ISO 19115:
MD_Format   └─formatSpecificationCitation…… Citation/URL of the specification format.       ├─title…………………………………………………… Name by which the cited resource is known.       └─date……………………………………………………… Reference date for the cited resource.
Each Format instance should contain a reference to the format specification, for example "PNG (Portable Network Graphics) Specification". The specification often has an abbreviation (for example "PNG") which can be stored as an alternate title.

Apache SIS provides predefined metadata structures for some commonly-used formats. A predefined format can be obtained by a call to lookup(Format.class, abbreviation) where abbreviation can be one of the values listed below:

Specification titles for well-known format names
Abbreviation Specification title
CSV Common Format and MIME Type for Comma-Separated Values (CSV) Files
GeoTIFF GeoTIFF Coverage Encoding Profile
NetCDF NetCDF Classic and 64-bit Offset Format
PNG PNG (Portable Network Graphics) Specification
Above list may be expanded in any future SIS version.

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 inter-operability with different versions.
      See Also:
    • formatSpecificationCitation

      private org.opengis.metadata.citation.Citation formatSpecificationCitation
      Citation / URL of the specification format.
    • amendmentNumber

      private org.opengis.util.InternationalString amendmentNumber
      Amendment number of the format version.
    • fileDecompressionTechnique

      private org.opengis.util.InternationalString fileDecompressionTechnique
      Recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
    • media

      private Collection<org.opengis.metadata.distribution.Medium> media
      Media used by the format.
    • formatDistributors

      private Collection<org.opengis.metadata.distribution.Distributor> formatDistributors
      Provides information about the distributor's format.
  • Constructor Details

    • DefaultFormat

      public DefaultFormat()
      Constructs an initially empty format.
    • DefaultFormat

      public DefaultFormat(org.opengis.metadata.distribution.Format 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.
      See Also:
  • Method Details

    • castOrCopy

      public static DefaultFormat castOrCopy(org.opengis.metadata.distribution.Format 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 DefaultFormat, then it is returned unchanged.
      • Otherwise a new DefaultFormat 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.
    • getFormatSpecificationCitation

      @UML(identifier="formatSpecificationCitation", obligation=MANDATORY, specification=ISO_19115) public org.opengis.metadata.citation.Citation getFormatSpecificationCitation()
      Returns the citation / URL of the specification format.
      Returns:
      citation / URL of the specification format.
      Since:
      0.5
    • setFormatSpecificationCitation

      public void setFormatSpecificationCitation(org.opengis.metadata.citation.Citation newValue)
      Sets the citation / URL of the specification format.
      Parameters:
      newValue - the new specification format.
      Since:
      0.5
    • setFormatSpecificationCitation

      private <T> void setFormatSpecificationCitation(BiConsumer<DefaultCitation,T> setter, T value)
      Sets the specification title or version.
    • getSpecification

      @Deprecated public org.opengis.util.InternationalString getSpecification()
      Deprecated.
      As of ISO 19115:2014, replaced by getFormatSpecificationCitation().getTitle().
      Returns the name of a subset, profile, or product specification of the format.
      Specified by:
      getSpecification in interface org.opengis.metadata.distribution.Format
      Returns:
      name of a subset, profile, or product specification of the format, or null.
    • setSpecification

      @Deprecated public void setSpecification(org.opengis.util.InternationalString newValue)
      Deprecated.
      Sets the name of a subset, profile, or product specification of the format.
      Parameters:
      newValue - the new specification.
    • getName

      @Deprecated public org.opengis.util.InternationalString getName()
      Deprecated.
      As of ISO 19115:2014, replaced by getFormatSpecificationCitation().getAlternateTitles(). Note that citation alternate titles are often used for abbreviations.
      Returns the name of the data transfer format(s).
      Specified by:
      getName in interface org.opengis.metadata.distribution.Format
      Returns:
      name of the data transfer format(s), or null.
    • setName

      @Deprecated public void setName(org.opengis.util.InternationalString newValue)
      Deprecated.
      Sets the name of the data transfer format(s).
      Parameters:
      newValue - the new name.
    • getVersion

      @Deprecated public org.opengis.util.InternationalString getVersion()
      Deprecated.
      As of ISO 19115:2014, replaced by getFormatSpecificationCitation().getEdition().
      Returns the version of the format (date, number, etc.).
      Specified by:
      getVersion in interface org.opengis.metadata.distribution.Format
      Returns:
      version of the format, or null.
    • setVersion

      @Deprecated public void setVersion(org.opengis.util.InternationalString newValue)
      Deprecated.
      Sets the version of the format (date, number, etc.).
      Parameters:
      newValue - the new version.
    • getAmendmentNumber

      public org.opengis.util.InternationalString getAmendmentNumber()
      Returns the amendment number of the format version.
      Specified by:
      getAmendmentNumber in interface org.opengis.metadata.distribution.Format
      Returns:
      amendment number of the format version, or null.
    • setAmendmentNumber

      public void setAmendmentNumber(org.opengis.util.InternationalString newValue)
      Sets the amendment number of the format version.
      Parameters:
      newValue - the new amendment number.
    • getFileDecompressionTechnique

      public org.opengis.util.InternationalString getFileDecompressionTechnique()
      Returns recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
      Specified by:
      getFileDecompressionTechnique in interface org.opengis.metadata.distribution.Format
      Returns:
      processes that can be applied to read resources to which compression techniques have been applied, or null.
    • setFileDecompressionTechnique

      public void setFileDecompressionTechnique(org.opengis.util.InternationalString newValue)
      Sets recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
      Parameters:
      newValue - the new file decompression technique.
    • getMedia

      @UML(identifier="medium", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.distribution.Medium> getMedia()
      Returns the media used by the format.
      Returns:
      media used by the format.
      Since:
      0.5
    • setMedia

      public void setMedia(Collection<? extends org.opengis.metadata.distribution.Medium> newValues)
      Sets the media used by the format.
      Parameters:
      newValues - the new media.
      Since:
      0.5
    • getFormatDistributors

      public Collection<org.opengis.metadata.distribution.Distributor> getFormatDistributors()
      Provides information about the distributor's format.
      Specified by:
      getFormatDistributors in interface org.opengis.metadata.distribution.Format
      Returns:
      information about the distributor's format.
    • setFormatDistributors

      public void setFormatDistributors(Collection<? extends org.opengis.metadata.distribution.Distributor> newValues)
      Sets information about the distributor's format.
      Parameters:
      newValues - the new format distributors.