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

Class DefaultFormat

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultFormat
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Format
public class DefaultFormat extends ISOMetadata implements 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   └─format­Specification­Citation…… 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
See Also:

  • Constructor Details

    • DefaultFormat

      public DefaultFormat()
      Constructs an initially empty format.

    • DefaultFormat

      public DefaultFormat(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(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 Default­Format, then it is returned unchanged.
      • Otherwise a new Default­Format 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 Citation getFormatSpecificationCitation()
      Returns the citation / URL of the specification format.
      Returns:
      citation / URL of the specification format.
      Since:
      0.5

    • setFormatSpecificationCitation

      public void setFormatSpecificationCitation(Citation newValue)
      Sets the citation / URL of the specification format.
      Parameters:
      new­Value - the new specification format.
      Since:
      0.5

    • getSpecification

      @Deprecated(since="1.0") public InternationalString getSpecification()
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Title().
      Returns the name of a subset, profile, or product specification of the format.
      Specified by:
      get­Specification in interface Format
      Returns:
      name of a subset, profile, or product specification of the format, or null.

    • setSpecification

      @Deprecated(since="1.0") public void setSpecification(InternationalString newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Title(International­String).
      Sets the name of a subset, profile, or product specification of the format.
      Parameters:
      new­Value - the new specification.

    • getName

      @Deprecated(since="1.0") public InternationalString getName()
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Alternate­Titles(). Note that citation alternate titles are often used for abbreviations.
      Returns the name of the data transfer format(s).
      Specified by:
      get­Name in interface Format
      Returns:
      name of the data transfer format(s), or null.

    • setName

      @Deprecated(since="1.0") public void setName(InternationalString newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Alternate­Titles(Collection).
      Sets the name of the data transfer format(s).
      Parameters:
      new­Value - the new name.

    • getVersion

      @Deprecated(since="1.0") public InternationalString getVersion()
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Edition().
      Returns the version of the format (date, number, etc.).
      Specified by:
      get­Version in interface Format
      Returns:
      version of the format, or null.

    • setVersion

      @Deprecated(since="1.0") public void setVersion(InternationalString newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Edition(International­String).
      Sets the version of the format (date, number, etc.).
      Parameters:
      new­Value - the new version.

    • getAmendmentNumber

      public InternationalString getAmendmentNumber()
      Returns the amendment number of the format version.
      Specified by:
      get­Amendment­Number in interface Format
      Returns:
      amendment number of the format version, or null.

    • setAmendmentNumber

      public void setAmendmentNumber(InternationalString newValue)
      Sets the amendment number of the format version.
      Parameters:
      new­Value - the new amendment number.

    • getFileDecompressionTechnique

      public 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:
      get­File­Decompression­Technique in interface Format
      Returns:
      processes that can be applied to read resources to which compression techniques have been applied, or null.

    • setFileDecompressionTechnique

      public void setFileDecompressionTechnique(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:
      new­Value - the new file decompression technique.

    • getMedia

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

    • setMedia

      public void setMedia(Collection<? extends Medium> newValues)
      Sets the media used by the format.
      Parameters:
      new­Values - the new media.
      Since:
      0.5

    • getFormatDistributors

      public Collection<Distributor> getFormatDistributors()
      Provides information about the distributor's format.
      Specified by:
      get­Format­Distributors in interface Format
      Returns:
      information about the distributor's format.

    • setFormatDistributors

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