Class DefaultFormat
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultFormat
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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:
 
 Each 
   
 Above list may be expanded in any future SIS version.
 
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.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:
| 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 | 
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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty format.DefaultFormat(Format object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultFormatcastOrCopy(Format object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the amendment number of the format version.Returns recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.Provides information about the distributor's format.Returns the citation / URL of the specification format.Returns the media used by the format.getName()Deprecated.Deprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().getTitle().Deprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().getEdition().voidsetAmendmentNumber(InternationalString newValue) Sets the amendment number of the format version.voidSets recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.voidsetFormatDistributors(Collection<? extends Distributor> newValues) Sets information about the distributor's format.voidsetFormatSpecificationCitation(Citation newValue) Sets the citation / URL of the specification format.voidsetMedia(Collection<? extends Medium> newValues) Sets the media used by the format.voidsetName(InternationalString newValue) Deprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setAlternateTitles(Collection).voidsetSpecification(InternationalString newValue) Deprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setTitle(InternationalString).voidsetVersion(InternationalString newValue) Deprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setEdition(InternationalString).Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultFormatpublic DefaultFormat()Constructs an initially empty format.
- 
DefaultFormatConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 returnsnull.
- Otherwise if the given object is already an instance of
       DefaultFormat, then it is returned unchanged.
- Otherwise a new DefaultFormatinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
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
 
- 
setFormatSpecificationCitationSets the citation / URL of the specification format.- Parameters:
- newValue- the new specification format.
- Since:
- 0.5
 
- 
getSpecificationDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().getTitle().Returns the name of a subset, profile, or product specification of the format.- Specified by:
- getSpecificationin interface- Format
- Returns:
- name of a subset, profile, or product specification of the format, or null.
 
- 
setSpecificationDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setTitle(InternationalString).Sets the name of a subset, profile, or product specification of the format.- Parameters:
- newValue- the new specification.
 
- 
getNameDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().getAlternateTitles(). Note that citation alternate titles are often used for abbreviations.Returns the name of the data transfer format(s).
- 
setNameDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setAlternateTitles(Collection).Sets the name of the data transfer format(s).- Parameters:
- newValue- the new name.
 
- 
getVersionDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().getEdition().Returns the version of the format (date, number, etc.).- Specified by:
- getVersionin interface- Format
- Returns:
- version of the format, or null.
 
- 
setVersionDeprecated.As of ISO 19115:2014, replaced bygetFormatSpecificationCitation().setEdition(InternationalString).Sets the version of the format (date, number, etc.).- Parameters:
- newValue- the new version.
 
- 
getAmendmentNumberReturns the amendment number of the format version.- Specified by:
- getAmendmentNumberin interface- Format
- Returns:
- amendment number of the format version, or null.
 
- 
setAmendmentNumberSets the amendment number of the format version.- Parameters:
- newValue- the new amendment number.
 
- 
getFileDecompressionTechniqueReturns recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.- Specified by:
- getFileDecompressionTechniquein interface- Format
- Returns:
- processes that can be applied to read resources to which compression techniques have
         been applied, or null.
 
- 
setFileDecompressionTechniqueSets 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<Medium> getMedia()Returns the media used by the format.- Returns:
- media used by the format.
- Since:
- 0.5
 
- 
setMediaSets the media used by the format.- Parameters:
- newValues- the new media.
- Since:
- 0.5
 
- 
getFormatDistributorsProvides information about the distributor's format.- Specified by:
- getFormatDistributorsin interface- Format
- Returns:
- information about the distributor's format.
 
- 
setFormatDistributorsSets information about the distributor's format.- Parameters:
- newValues- the new format distributors.
 
 
- 
getFormatSpecificationCitation().getAlternateTitles().