org.geotoolkit.metadata.iso.identification
Class DefaultUsage

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultUsage

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Usage

@ThreadSafe
public class DefaultUsage
extends MetadataEntity
implements Usage

Brief description of ways in which the resource(s) is/are currently used.

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

DefaultUsage()
Constructs an initially empty usage.

DefaultUsage(InternationalString specificUsage, Collection<ResponsibleParty> userContactInfo)
Creates an usage initialized to the specified values.

DefaultUsage(Usage source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultUsage	castOrCopy(Usage object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
InternationalString	getSpecificUsage() Returns a brief description of the resource and/or resource series usage.
Date	getUsageDate() Returns the date and time of the first use or range of uses of the resource and/or resource series.
Collection<ResponsibleParty>	getUserContactInfo() Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).
InternationalString	getUserDeterminedLimitations() Returns applications, determined by the user for which the resource and/or resource series is not suitable.
void	setSpecificUsage(InternationalString newValue) Sets a brief description of the resource and/or resource series usage.
void	setUsageDate(Date newValue) Sets the date and time of the first use.
void	setUserContactInfo(Collection<? extends ResponsibleParty> newValues) Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).
void	setUserDeterminedLimitations(InternationalString newValue) Sets applications, determined by the user for which the resource and/or resource series is not suitable.

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

DefaultUsage

public DefaultUsage()

Constructs an initially empty usage.

DefaultUsage

public DefaultUsage(Usage 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

DefaultUsage

public DefaultUsage(InternationalString specificUsage,
                    Collection<ResponsibleParty> userContactInfo)

Creates an usage initialized to the specified values.

Parameters:

specificUsage - Brief description of the resource and/or resource series usage.

userContactInfo - Means of communicating with person(s) and organization(s).

Method Detail

castOrCopy

public static DefaultUsage castOrCopy(Usage 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

getSpecificUsage

public InternationalString getSpecificUsage()

Returns a brief description of the resource and/or resource series usage.

Specified by:

getSpecificUsage in interface Usage

setSpecificUsage

public void setSpecificUsage(InternationalString newValue)

Sets a brief description of the resource and/or resource series usage.

Parameters:

newValue - The new specific usage.

getUsageDate

public Date getUsageDate()

Returns the date and time of the first use or range of uses of the resource and/or resource series.

Specified by:

getUsageDate in interface Usage

setUsageDate

public void setUsageDate(Date newValue)

Sets the date and time of the first use.

Parameters:

newValue - The new usage date.

getUserDeterminedLimitations

public InternationalString getUserDeterminedLimitations()

Returns applications, determined by the user for which the resource and/or resource series is not suitable.

Specified by:

getUserDeterminedLimitations in interface Usage

setUserDeterminedLimitations

public void setUserDeterminedLimitations(InternationalString newValue)

Sets applications, determined by the user for which the resource and/or resource series is not suitable.

Parameters:

newValue - The new user determined limitations.

getUserContactInfo

public Collection<ResponsibleParty> getUserContactInfo()

Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).

Specified by:

getUserContactInfo in interface Usage

setUserContactInfo

public void setUserContactInfo(Collection<? extends ResponsibleParty> newValues)

Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).

Parameters:

newValues - The new user contact info.