Class DefaultRequirement

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultRequirement

All Implemented Interfaces:

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

@TitleProperty(name="identifier")
public class DefaultRequirement
extends ISOMetadata
implements Requirement

Requirement to be satisfied by the planned data acquisition. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MI_Requirement ├─identifier……………………………………………………… Unique name, or code, for the requirement. │ └─code…………………………………………………………… Alphanumeric value identifying an instance in the namespace. ├─requestor………………………………………………………… Origin of requirement. │ ├─party………………………………………………………… Information about the parties. │ │ └─name………………………………………………… Name of the party. │ └─role…………………………………………………………… Function performed by the responsible party. ├─recipient………………………………………………………… Person(s), or body(ies), to receive results of requirement. ├─priority…………………………………………………………… Relative ordered importance, or urgency, of the requirement. ├─requested­Date……………………………………………… Required or preferred acquisition date and time. │ ├─requested­Date­Of­Collection…… Preferred date and time of collection. │ └─latest­Acceptable­Date………………… Latest date and time collection must be completed. └─expiry­Date……………………………………………………… Date and time after which collection is no longer valid.

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­Requirement()	Constructs an initially empty requirement.
Default­Requirement(Requirement object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Requirement	cast­Or­Copy(Requirement object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Citation	get­Citation()	Returns the identification of reference or guidance material for the requirement.
Date	get­Expiry­Date()	Returns the date and time after which collection is no longer valid.
Identifier	get­Identifier()	Returns the unique name, or code, for the requirement.
Priority	get­Priority()	Returns the relative ordered importance, or urgency, of the requirement.
Collection<Responsible­Party>	get­Recipients()	Returns the person(s), or body(ies), to receive results of requirement.
Requested­Date	get­Requested­Date()	Returns the required or preferred acquisition date and time.
Collection<Responsible­Party>	get­Requestors()	Returns the origin of requirement.
Collection<Plan>	get­Satisfied­Plans()	Returns the plan that identifies solution to satisfy the requirement.
void	set­Citation(Citation new­Value)	Sets the identification of reference or guidance material for the requirement.
void	set­Expiry­Date(Temporal new­Value)	Sets the date and time after which collection is no longer valid.
void	set­Expiry­Date(Date new­Value)	Deprecated. Replaced by set­Expiry­Date(Temporal).
void	set­Identifier(Identifier new­Value)	Sets the unique name, or code, for the requirement.
void	set­Priority(Priority new­Value)	Sets the relative ordered importance, or urgency, of the requirement.
void	set­Recipients(Collection<? extends Responsible­Party> new­Values)	Sets the Person(s), or body(ies), to receive results of requirement.
void	set­Requested­Date(Requested­Date new­Value)	Sets the required or preferred acquisition date and time.
void	set­Requestors(Collection<? extends Responsible­Party> new­Values)	Sets the origin of requirement.
void	set­Satisfied­Plans(Collection<? extends Plan> new­Values)	Sets the plan that identifies solution to satisfy the requirement.

Methods inherited from class ISOMetadata

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

Modifier and Type	Method	Description
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.

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

DefaultRequirement

public DefaultRequirement()

Constructs an initially empty requirement.

DefaultRequirement

public DefaultRequirement(Requirement 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(Requirement)

Method Details

castOrCopy

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

getCitation

public Citation getCitation()

Returns the identification of reference or guidance material for the requirement. null if unspecified.

Specified by:

get­Citation in interface Requirement

Returns:

identification of reference or guidance material, or null.

setCitation

public void setCitation(Citation newValue)

Sets the identification of reference or guidance material for the requirement.

Parameters:

new­Value - the new citation value.

getIdentifier

public Identifier getIdentifier()

Returns the unique name, or code, for the requirement.

Specified by:

get­Identifier in interface Requirement

Overrides:

get­Identifier in class ISOMetadata

Returns:

unique name or code, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique name, or code, for the requirement.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the new identifier value.

getRequestors

public Collection<ResponsibleParty> getRequestors()

Returns the origin of requirement.

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

Specified by:

get­Requestors in interface Requirement

Returns:

origin of requirement.

setRequestors

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

Sets the origin of requirement.

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

Parameters:

new­Values - the new requestors values.

getRecipients

public Collection<ResponsibleParty> getRecipients()

Returns the person(s), or body(ies), to receive results of requirement.

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

Specified by:

get­Recipients in interface Requirement

Returns:

person(s), or body(ies), to receive results.

setRecipients

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

Sets the Person(s), or body(ies), to receive results of requirement.

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

Parameters:

new­Values - the new recipients values.

getPriority

public Priority getPriority()

Returns the relative ordered importance, or urgency, of the requirement.

Specified by:

get­Priority in interface Requirement

Returns:

relative ordered importance, or urgency, or null.

setPriority

public void setPriority(Priority newValue)

Sets the relative ordered importance, or urgency, of the requirement.

Parameters:

new­Value - the new priority value.

getRequestedDate

public RequestedDate getRequestedDate()

Returns the required or preferred acquisition date and time.

Specified by:

get­Requested­Date in interface Requirement

Returns:

required or preferred acquisition date and time, or null.

setRequestedDate

public void setRequestedDate(RequestedDate newValue)

Sets the required or preferred acquisition date and time.

Parameters:

new­Value - the new requested date value.

getExpiryDate

public Date getExpiryDate()

Returns the date and time after which collection is no longer valid.

Upcoming API change
Date may be replaced by Temporal in GeoAPI 4.0.

Specified by:

get­Expiry­Date in interface Requirement

Returns:

date and time after which collection is no longer valid, or null.

setExpiryDate

public void setExpiryDate(Temporal newValue)

Sets the date and time after which collection is no longer valid. The specified value should be an instance of Local­Date, Local­Date­Time, Offset­Date­Time or Zoned­Date­Time, depending whether hours are defined and how the timezone (if any) is defined. But other types are also allowed.

Parameters:

new­Value - the new expiry date.

Since:

1.5

setExpiryDate

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

Deprecated.

Replaced by set­Expiry­Date(Temporal).

Sets the date and time after which collection is no longer valid.

Parameters:

new­Value - the new expiry date.

getSatisfiedPlans

public Collection<Plan> getSatisfiedPlans()

Returns the plan that identifies solution to satisfy the requirement.

Specified by:

get­Satisfied­Plans in interface Requirement

Returns:

plan that identifies solution to satisfy the requirement.

setSatisfiedPlans

public void setSatisfiedPlans(Collection<? extends Plan> newValues)

Sets the plan that identifies solution to satisfy the requirement.

Parameters:

new­Values - the new satisfied plans values.