Class DefaultRequirement
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultRequirement
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty requirement.DefaultRequirement(Requirement object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultRequirementcastOrCopy(Requirement object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the identification of reference or guidance material for the requirement.Returns the date and time after which collection is no longer valid.Returns the unique name, or code, for the requirement.Returns the relative ordered importance, or urgency, of the requirement.Returns the person(s), or body(ies), to receive results of requirement.Returns the required or preferred acquisition date and time.Returns the origin of requirement.Returns the plan that identifies solution to satisfy the requirement.voidsetCitation(Citation newValue) Sets the identification of reference or guidance material for the requirement.voidsetExpiryDate(Date newValue) Sets the date and time after which collection is no longer valid.voidsetIdentifier(Identifier newValue) Sets the unique name, or code, for the requirement.voidsetPriority(Priority newValue) Sets the relative ordered importance, or urgency, of the requirement.voidsetRecipients(Collection<? extends ResponsibleParty> newValues) Sets the Person(s), or body(ies), to receive results of requirement.voidsetRequestedDate(RequestedDate newValue) Sets the required or preferred acquisition date and time.voidsetRequestors(Collection<? extends ResponsibleParty> newValues) Sets the origin of requirement.voidsetSatisfiedPlans(Collection<? extends Plan> newValues) Sets the plan that identifies solution to satisfy the requirement.Methods inherited from class ISOMetadatagetIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultRequirementpublic DefaultRequirement()Constructs an initially empty requirement.
- 
DefaultRequirementConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultRequirementinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getCitationReturns the identification of reference or guidance material for the requirement.nullif unspecified.- Specified by:
- getCitationin interface- Requirement
- Returns:
- identification of reference or guidance material, or null.
 
- 
setCitationSets the identification of reference or guidance material for the requirement.- Parameters:
- newValue- the new citation value.
 
- 
getIdentifierReturns the unique name, or code, for the requirement.- Specified by:
- getIdentifierin interface- Requirement
- Overrides:
- getIdentifierin class- ISOMetadata
- Returns:
- unique name or code, or null.
 
- 
setIdentifierSets the unique name, or code, for the requirement.- Overrides:
- setIdentifierin class- ISOMetadata
- Parameters:
- newValue- the new identifier value.
 
- 
getRequestorsReturns the origin of requirement.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
- getRequestorsin interface- Requirement
- Returns:
- origin of requirement.
 
- 
setRequestorsSets the origin of requirement.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
- newValues- the new requestors values.
 
- 
getRecipientsReturns the person(s), or body(ies), to receive results of requirement.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
- getRecipientsin interface- Requirement
- Returns:
- person(s), or body(ies), to receive results.
 
- 
setRecipientsSets the Person(s), or body(ies), to receive results of requirement.Upcoming API change — generalization
 As of ISO 19115:2014,ResponsiblePartyis replaced by theResponsibilityparent interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
- newValues- the new recipients values.
 
- 
getPriorityReturns the relative ordered importance, or urgency, of the requirement.- Specified by:
- getPriorityin interface- Requirement
- Returns:
- relative ordered importance, or urgency, or null.
 
- 
setPrioritySets the relative ordered importance, or urgency, of the requirement.- Parameters:
- newValue- the new priority value.
 
- 
getRequestedDateReturns the required or preferred acquisition date and time.- Specified by:
- getRequestedDatein interface- Requirement
- Returns:
- required or preferred acquisition date and time, or null.
 
- 
setRequestedDateSets the required or preferred acquisition date and time.- Parameters:
- newValue- the new requested date value.
 
- 
getExpiryDateReturns the date and time after which collection is no longer valid.- Specified by:
- getExpiryDatein interface- Requirement
- Returns:
- date and time after which collection is no longer valid, or null.
 
- 
setExpiryDateSets the date and time after which collection is no longer valid.- Parameters:
- newValue- the new expiry date.
 
- 
getSatisfiedPlansReturns the plan that identifies solution to satisfy the requirement.- Specified by:
- getSatisfiedPlansin interface- Requirement
- Returns:
- plan that identifies solution to satisfy the requirement.
 
- 
setSatisfiedPlansSets the plan that identifies solution to satisfy the requirement.- Parameters:
- newValues- the new satisfied plans values.
 
 
-