Class DefaultFormat

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultFormat

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Format

@TitleProperty(name="formatSpecificationCitation")
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:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Format()	Constructs an initially empty format.
Default­Format(Format object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Format	cast­Or­Copy(Format object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Amendment­Number()	Returns the amendment number of the format version.
International­String	get­File­Decompression­Technique()	Returns recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
Collection<Distributor>	get­Format­Distributors()	Provides information about the distributor's format.
Citation	get­Format­Specification­Citation()	Returns the citation / URL of the specification format.
Collection<Medium>	get­Media()	Returns the media used by the format.
International­String	get­Name()	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Alternate­Titles().
International­String	get­Specification()	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Title().
International­String	get­Version()	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().get­Edition().
void	set­Amendment­Number(International­String new­Value)	Sets the amendment number of the format version.
void	set­File­Decompression­Technique(International­String new­Value)	Sets recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
void	set­Format­Distributors(Collection<? extends Distributor> new­Values)	Sets information about the distributor's format.
void	set­Format­Specification­Citation(Citation new­Value)	Sets the citation / URL of the specification format.
void	set­Media(Collection<? extends Medium> new­Values)	Sets the media used by the format.
void	set­Name(International­String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Alternate­Titles(Collection).
void	set­Specification(International­String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Title(International­String).
void	set­Version(International­String new­Value)	Deprecated. As of ISO 19115:2014, replaced by get­Format­Specification­Citation().set­Edition(International­String).

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

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:

• cast­Or­Copy(Format)

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.