Class DefaultRequirement
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.acquisition.DefaultRequirement
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.acquisition.Requirement
public class DefaultRequirement
extends ISOMetadata
implements org.opengis.metadata.acquisition.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.
├─requestedDate………………………………………………
Required or preferred acquisition date and time.
│ ├─requestedDateOfCollection……
Preferred date and time of collection.
│ └─latestAcceptableDate…………………
Latest date and time collection must be completed.
└─expiryDate………………………………………………………
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
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.metadata.citation.Citation
Identification of reference or guidance material for the requirement.private long
Date and time after which collection is no longer valid, orLong.MIN_VALUE
if none.private org.opengis.metadata.acquisition.Priority
Relative ordered importance, or urgency, of the requirement.private Collection
<org.opengis.metadata.citation.ResponsibleParty> Person(s), or body(ies), to receive results of requirement.private org.opengis.metadata.acquisition.RequestedDate
Required or preferred acquisition date and time.private Collection
<org.opengis.metadata.citation.ResponsibleParty> Origin of requirement.private Collection
<org.opengis.metadata.acquisition.Plan> Plan that identifies solution to satisfy the requirement.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty requirement.DefaultRequirement
(org.opengis.metadata.acquisition.Requirement object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultRequirement
castOrCopy
(org.opengis.metadata.acquisition.Requirement object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.citation.Citation
Returns the identification of reference or guidance material for the requirement.Returns the date and time after which collection is no longer valid.org.opengis.metadata.Identifier
Returns the unique name, or code, for the requirement.org.opengis.metadata.acquisition.Priority
Returns the relative ordered importance, or urgency, of the requirement.Collection
<org.opengis.metadata.citation.ResponsibleParty> Returns the person(s), or body(ies), to receive results of requirement.org.opengis.metadata.acquisition.RequestedDate
Returns the required or preferred acquisition date and time.Collection
<org.opengis.metadata.citation.ResponsibleParty> Returns the origin of requirement.Collection
<org.opengis.metadata.acquisition.Plan> Returns the plan that identifies solution to satisfy the requirement.void
setCitation
(org.opengis.metadata.citation.Citation newValue) Sets the identification of reference or guidance material for the requirement.void
setExpiryDate
(Date newValue) Sets the date and time after which collection is no longer valid.void
setIdentifier
(org.opengis.metadata.Identifier newValue) Sets the unique name, or code, for the requirement.void
setPriority
(org.opengis.metadata.acquisition.Priority newValue) Sets the relative ordered importance, or urgency, of the requirement.void
setRecipients
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the Person(s), or body(ies), to receive results of requirement.void
setRequestedDate
(org.opengis.metadata.acquisition.RequestedDate newValue) Sets the required or preferred acquisition date and time.void
setRequestors
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the origin of requirement.void
setSatisfiedPlans
(Collection<? extends org.opengis.metadata.acquisition.Plan> newValues) Sets the plan that identifies solution to satisfy the requirement.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifierMap, getIdentifiers, getStandard, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
citation
private org.opengis.metadata.citation.Citation citationIdentification of reference or guidance material for the requirement. -
requestors
Origin of requirement. -
recipients
Person(s), or body(ies), to receive results of requirement. -
priority
private org.opengis.metadata.acquisition.Priority priorityRelative ordered importance, or urgency, of the requirement. -
requestedDate
private org.opengis.metadata.acquisition.RequestedDate requestedDateRequired or preferred acquisition date and time. -
expiryDate
private long expiryDateDate and time after which collection is no longer valid, orLong.MIN_VALUE
if none. -
satisfiedPlans
Plan that identifies solution to satisfy the requirement.
-
-
Constructor Details
-
DefaultRequirement
public DefaultRequirement()Constructs an initially empty requirement. -
DefaultRequirement
public DefaultRequirement(org.opengis.metadata.acquisition.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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull
. - Otherwise if the given object is already an instance of
DefaultRequirement
, then it is returned unchanged. - Otherwise a new
DefaultRequirement
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, ornull
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.
- If the given object is
-
getCitation
public org.opengis.metadata.citation.Citation getCitation()Returns the identification of reference or guidance material for the requirement.null
if unspecified.- Specified by:
getCitation
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- identification of reference or guidance material, or
null
.
-
setCitation
public void setCitation(org.opengis.metadata.citation.Citation newValue) Sets the identification of reference or guidance material for the requirement.- Parameters:
newValue
- the new citation value.
-
getIdentifier
public org.opengis.metadata.Identifier getIdentifier()Returns the unique name, or code, for the requirement.- Specified by:
getIdentifier
in interfaceorg.opengis.metadata.acquisition.Requirement
- Overrides:
getIdentifier
in classISOMetadata
- Returns:
- unique name or code, or
null
.
-
setIdentifier
public void setIdentifier(org.opengis.metadata.Identifier newValue) Sets the unique name, or code, for the requirement.- Overrides:
setIdentifier
in classISOMetadata
- Parameters:
newValue
- the new identifier value.
-
getRequestors
Returns the origin of requirement.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getRequestors
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- origin of requirement.
-
setRequestors
public void setRequestors(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the origin of requirement.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
newValues
- the new requestors values.
-
getRecipients
Returns the person(s), or body(ies), to receive results of requirement.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getRecipients
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- person(s), or body(ies), to receive results.
-
setRecipients
public void setRecipients(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the Person(s), or body(ies), to receive results of requirement.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
newValues
- the new recipients values.
-
getPriority
public org.opengis.metadata.acquisition.Priority getPriority()Returns the relative ordered importance, or urgency, of the requirement.- Specified by:
getPriority
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- relative ordered importance, or urgency, or
null
.
-
setPriority
public void setPriority(org.opengis.metadata.acquisition.Priority newValue) Sets the relative ordered importance, or urgency, of the requirement.- Parameters:
newValue
- the new priority value.
-
getRequestedDate
public org.opengis.metadata.acquisition.RequestedDate getRequestedDate()Returns the required or preferred acquisition date and time.- Specified by:
getRequestedDate
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- required or preferred acquisition date and time, or
null
.
-
setRequestedDate
public void setRequestedDate(org.opengis.metadata.acquisition.RequestedDate newValue) Sets the required or preferred acquisition date and time.- Parameters:
newValue
- the new requested date value.
-
getExpiryDate
Returns the date and time after which collection is no longer valid.- Specified by:
getExpiryDate
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- date and time after which collection is no longer valid, or
null
.
-
setExpiryDate
Sets the date and time after which collection is no longer valid.- Parameters:
newValue
- the new expiry date.
-
getSatisfiedPlans
Returns the plan that identifies solution to satisfy the requirement.- Specified by:
getSatisfiedPlans
in interfaceorg.opengis.metadata.acquisition.Requirement
- Returns:
- plan that identifies solution to satisfy the requirement.
-
setSatisfiedPlans
public void setSatisfiedPlans(Collection<? extends org.opengis.metadata.acquisition.Plan> newValues) Sets the plan that identifies solution to satisfy the requirement.- Parameters:
newValues
- the new satisfied plans values.
-