org.geotoolkit.metadata.iso.distribution
Class DefaultFormat

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultFormat

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Format

@ThreadSafe
public class DefaultFormat
extends MetadataEntity
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.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultFormat()
Constructs an initially empty format.

DefaultFormat(Format source)
Constructs a metadata entity initialized with the values from the specified metadata.

DefaultFormat(InternationalString name, InternationalString version)
Creates a format initialized to the given name.

Method Summary

static DefaultFormat	castOrCopy(Format object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
InternationalString	getAmendmentNumber() Returns the amendment number of the format version.
InternationalString	getFileDecompressionTechnique() Returns recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.
Collection<Distributor>	getFormatDistributors() Provides information about the distributor’s format.
InternationalString	getName() Returns the name of the data transfer format(s).
InternationalString	getSpecification() Returns the name of a subset, profile, or product specification of the format.
InternationalString	getVersion() Returne the version of the format (date, number, etc.).
void	setAmendmentNumber(InternationalString newValue) Sets the amendment number of the format version.
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.
void	setFormatDistributors(Collection<? extends Distributor> newValues) Sets information about the distributor’s format.
void	setName(InternationalString newValue) Sets the name of the data transfer format(s).
void	setSpecification(InternationalString newValue) Sets the name of a subset, profile, or product specification of the format.
void	setVersion(InternationalString newValue) Sets the version of the format (date, number, etc.).

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultFormat

public DefaultFormat()

Constructs an initially empty format.

DefaultFormat

public DefaultFormat(Format source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

DefaultFormat

public DefaultFormat(InternationalString name,
                     InternationalString version)

Creates a format initialized to the given name.

Parameters:

name - The name of the data transfer format(s).

version - The version of the format (date, number, etc.).

Method Detail

castOrCopy

public static DefaultFormat castOrCopy(Format object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getName

public InternationalString getName()

Returns the name of the data transfer format(s).

Specified by:

getName in interface Format

setName

public void setName(InternationalString newValue)

Sets the name of the data transfer format(s).

Parameters:

newValue - The new name.

getVersion

public InternationalString getVersion()

Returne the version of the format (date, number, etc.).

Specified by:

getVersion in interface Format

setVersion

public void setVersion(InternationalString newValue)

Sets the version of the format (date, number, etc.).

Parameters:

newValue - The new version.

getAmendmentNumber

public InternationalString getAmendmentNumber()

Returns the amendment number of the format version.

Specified by:

getAmendmentNumber in interface Format

setAmendmentNumber

public void setAmendmentNumber(InternationalString newValue)

Sets the amendment number of the format version.

Parameters:

newValue - The new amendment number.

getSpecification

public InternationalString getSpecification()

Returns the name of a subset, profile, or product specification of the format.

Specified by:

getSpecification in interface Format

setSpecification

public void setSpecification(InternationalString newValue)

Sets the name of a subset, profile, or product specification of the format.

Parameters:

newValue - The new specification.

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:

getFileDecompressionTechnique in interface Format

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:

newValue - The new file decompression technique.

getFormatDistributors

public Collection<Distributor> getFormatDistributors()

Provides information about the distributor’s format.

Specified by:

getFormatDistributors in interface Format

setFormatDistributors

public void setFormatDistributors(Collection<? extends Distributor> newValues)

Sets information about the distributor’s format.

Parameters:

newValues - The new format distributors.