org.geotoolkit.metadata.iso.lineage
Class DefaultAlgorithm

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultAlgorithm

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Algorithm

@ThreadSafe
public class DefaultAlgorithm
extends MetadataEntity
implements Algorithm

Details of the methodology by which geographic information was derived from the instrument readings.

Since:

3.03

Version:

3.19

Author:

Cédric Briançon (Geomatys), Guilhem Legal (Geomatys), Martin Desruisseaux (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

DefaultAlgorithm()
Constructs an initially empty algorithm.

DefaultAlgorithm(Algorithm source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultAlgorithm	castOrCopy(Algorithm object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Citation	getCitation() Returns the information identifying the algorithm and version or date.
InternationalString	getDescription() Returns the information describing the algorithm used to generate the data.
void	setCitation(Citation newValue) Sets the information identifying the algorithm and version or date.
void	setDescription(InternationalString newValue) Sets the information describing the algorithm used to generate the data.

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

DefaultAlgorithm

public DefaultAlgorithm()

Constructs an initially empty algorithm.

DefaultAlgorithm

public DefaultAlgorithm(Algorithm source)

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

Parameters:

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

Method Detail

castOrCopy

public static DefaultAlgorithm castOrCopy(Algorithm 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

getCitation

public Citation getCitation()

Returns the information identifying the algorithm and version or date.

Specified by:

getCitation in interface Algorithm

setCitation

public void setCitation(Citation newValue)

Sets the information identifying the algorithm and version or date.

Parameters:

newValue - The new citation value.

getDescription

public InternationalString getDescription()

Returns the information describing the algorithm used to generate the data.

Specified by:

getDescription in interface Algorithm

setDescription

public void setDescription(InternationalString newValue)

Sets the information describing the algorithm used to generate the data.

Parameters:

newValue - The new description value.