Class DefaultUsage

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultUsage

All Implemented Interfaces:

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

@TitleProperty(name="specificUsage")
public class DefaultUsage
extends ISOMetadata
implements Usage

Brief description of ways in which the resource(s) is/are currently or has been used. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Usage ├─specific­Usage………… Brief description of the resource and/or resource series usage. └─user­Contact­Info…… Identification of and means of communicating with person(s) and organisation(s). ├─party…………………… Information about the parties. │ └─name…………… Name of the party. └─role……………………… Function performed by the responsible party.

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­Usage()	Constructs an initially empty usage.
Default­Usage(Char­Sequence specific­Usage, Responsible­Party user­Contact­Info)	Creates an usage initialized to the specified values.
Default­Usage(Usage object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
void	add­Usage­Dates(Temporal beginning, Temporal ending)	Adds a period for the range of uses of the resource and/or resource series.
static Default­Usage	cast­Or­Copy(Usage object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	get­Additional­Documentation()	Publications that describe usage of data.
Collection<Citation>	get­Identified­Issues()	Citation of a description of known issues associated with the resource along with proposed solutions if available.
Collection<International­String>	get­Responses()	Responses to the user-determined limitations.
International­String	get­Specific­Usage()	Returns a brief description of the resource and/or resource series usage.
Date	get­Usage­Date()	Deprecated. Replaced by get­Usage­Dates().
Collection<Temporal­Primitive>	get­Usage­Dates()	Returns the date and time of the first use or range of uses of the resource and/or resource series.
Collection<Responsible­Party>	get­User­Contact­Info()	Returns identification of and means of communicating with person(s) and organization(s) using the resource(s).
International­String	get­User­Determined­Limitations()	Returns applications, determined by the user for which the resource and/or resource series is not suitable.
void	set­Additional­Documentation(Collection<? extends Citation> new­Values)	Sets the publications that describe usage of data.
void	set­Identified­Issues(Collection<? extends Citation> new­Values)	Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.
void	set­Responses(Collection<? extends International­String> new­Values)	Sets a new response to the user-determined limitations.
void	set­Specific­Usage(International­String new­Value)	Sets a brief description of the resource and/or resource series usage.
void	set­Usage­Date(Date new­Value)	Deprecated. Replaced by set­Usage­Dates(Collection).
void	set­Usage­Dates(Collection<Temporal­Primitive> new­Values)	Sets the date and time of the first use or range of uses of the resource and/or resource series.
void	set­User­Contact­Info(Collection<? extends Responsible­Party> new­Values)	Sets identification of and means of communicating with person(s) and organization(s) using the resource(s).
void	set­User­Determined­Limitations(International­String new­Value)	Sets applications, determined by the user for which the resource and/or resource series is not suitable.

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

DefaultUsage

public DefaultUsage()

Constructs an initially empty usage.

DefaultUsage

public DefaultUsage(CharSequence specificUsage,
 ResponsibleParty userContactInfo)

Creates an usage initialized to the specified values.

Parameters:

specific­Usage - brief description of the resource and/or resource series usage, or null if none.

user­Contact­Info - means of communicating with person(s) and organization(s), or null if none.

DefaultUsage

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

Method Details

castOrCopy

public static DefaultUsage castOrCopy(Usage 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­Usage, then it is returned unchanged.
• Otherwise a new Default­Usage 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.

getSpecificUsage

public InternationalString getSpecificUsage()

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

Specified by:

get­Specific­Usage in interface Usage

Returns:

description of the resource usage, or null.

setSpecificUsage

public void setSpecificUsage(InternationalString newValue)

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

Parameters:

new­Value - the new specific usage.

getUsageDate

@Deprecated(since="1.5")
public Date getUsageDate()

Deprecated.

Replaced by get­Usage­Dates().

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

Specified by:

get­Usage­Date in interface Usage

Returns:

date of the first use of the resource, or null.

setUsageDate

@Deprecated(since="1.5")
public void setUsageDate(Date newValue)

Deprecated.

Replaced by set­Usage­Dates(Collection).

Sets the date and time of the first use.

Parameters:

new­Value - the new usage date.

getUsageDates

@UML(identifier="usageDateTime",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<TemporalPrimitive> getUsageDates()

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

Returns:

date of the first use of the resource.

Since:

1.5

setUsageDates

public void setUsageDates(Collection<TemporalPrimitive> newValues)

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

Parameters:

new­Values - date of the first use of the resource.

Since:

1.5

addUsageDates

public void addUsageDates(Temporal beginning,
 Temporal ending)

Adds a period for the range of uses of the resource and/or resource series. This is a convenience method for adding a temporal period.

Parameters:

beginning - the begin instant (inclusive), or null.

ending - the end instant (inclusive), or null.

Since:

1.5

getUserDeterminedLimitations

public InternationalString getUserDeterminedLimitations()

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

Specified by:

get­User­Determined­Limitations in interface Usage

Returns:

applications for which the resource and/or resource series is not suitable, or null.

setUserDeterminedLimitations

public void setUserDeterminedLimitations(InternationalString newValue)

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

Parameters:

new­Value - 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).

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Specified by:

get­User­Contact­Info in interface Usage

Returns:

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

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).

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change may be applied in GeoAPI 4.0.

Parameters:

new­Values - the new user contact info.

getResponses

@UML(identifier="response",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<InternationalString> getResponses()

Responses to the user-determined limitations.

Returns:

response to the user-determined limitations.

Since:

0.5

setResponses

public void setResponses(Collection<? extends InternationalString> newValues)

Sets a new response to the user-determined limitations.

Parameters:

new­Values - the new response to the user-determined limitations.

Since:

0.5

getAdditionalDocumentation

@UML(identifier="additionalDocumentation",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getAdditionalDocumentation()

Publications that describe usage of data.

Returns:

publications that describe usage of data.

Since:

0.5

setAdditionalDocumentation

public void setAdditionalDocumentation(Collection<? extends Citation> newValues)

Sets the publications that describe usage of data.

Parameters:

new­Values - the new publications.

Since:

0.5

getIdentifiedIssues

@UML(identifier="identifiedIssues",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Collection<Citation> getIdentifiedIssues()

Citation of a description of known issues associated with the resource along with proposed solutions if available.

Returns:

citation of a description of known issues associated with the resource.

Since:

0.5

setIdentifiedIssues

public void setIdentifiedIssues(Collection<? extends Citation> newValues)

Sets a new citation of a description of known issues associated with the resource along with proposed solutions if available.

Parameters:

new­Values - the new citation of a description.

Since:

0.5