Class 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 pre-defined metadata structures for some commonly-used formats. A pre-defined 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:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • 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, since 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:
        cast­Or­Copy(Format)
    • Method Detail

      • 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, since 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.
      • setFormatSpecificationCitation

        public void setFormatSpecificationCitation​(Citation newValue)
        Sets the citation / URL of the specification format.
        Parameters:
        new­Value - the new specification format.
        Since:
        0.5
      • 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.
      • setMedia

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

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