Class DefaultStandardOrderProcess
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.distribution.DefaultStandardOrderProcess
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.distribution.StandardOrderProcess
public class DefaultStandardOrderProcess
extends ISOMetadata
implements org.opengis.metadata.distribution.StandardOrderProcess
Common ways in which the resource may be obtained or received, and related instructions
and fee information.
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 Currency
Thefees
currency, ornull
if unknown or unspecified.private org.opengis.util.InternationalString
Fees and terms for retrieving the resource.private org.opengis.util.InternationalString
General instructions, terms and services provided by the distributor.private org.opengis.util.Record
Request/purchase choices.private org.opengis.util.RecordType
Description of the order options record.private long
Date and time when the dataset will be available, in milliseconds elapsed since January 1st, 1970.private static final long
Serial number for inter-operability with different versions.private org.opengis.util.InternationalString
Typical turnaround time for the filling of an order.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty standard order process.DefaultStandardOrderProcess
(org.opengis.metadata.distribution.StandardOrderProcess object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultStandardOrderProcess
castOrCopy
(org.opengis.metadata.distribution.StandardOrderProcess object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the monetary units of thefees
(as specified in ISO 4217).org.opengis.util.InternationalString
getFees()
Returns fees and terms for retrieving the resource.org.opengis.util.InternationalString
Returns general instructions, terms and services provided by the distributor.org.opengis.util.Record
Returns the request/purchase choices.org.opengis.util.RecordType
Returns the description of the order options record.org.opengis.util.RecordType
Deprecated.Returns the date and time when the dataset will be available.org.opengis.util.InternationalString
Returns typical turnaround time for the filling of an order.void
setCurrency
(Currency newValue) Sets the monetary units of thefees
(as specified in ISO 4217).void
setFees
(org.opengis.util.InternationalString newValue) Sets fees and terms for retrieving the resource.void
setOrderingInstructions
(org.opengis.util.InternationalString newValue) Sets general instructions, terms and services provided by the distributor.void
setOrderOptions
(org.opengis.util.Record newValue) Sets the request/purchase choices.void
setOrderOptionsType
(org.opengis.util.RecordType newValue) Sets the description of the order options record.void
setOrderOptionType
(org.opengis.util.RecordType newValue) Deprecated.RenamedsetOrderOptionsType(RecordType)
for ISO 19115 conformance.void
setPlannedAvailableDateTime
(Date newValue) Sets the date and time when the dataset will be available.void
setTurnaround
(org.opengis.util.InternationalString newValue) Sets typical turnaround time for the filling of an order.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, 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:
-
fees
private org.opengis.util.InternationalString feesFees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217). -
currency
Thefees
currency, ornull
if unknown or unspecified. -
plannedAvailableDateTime
private long plannedAvailableDateTimeDate and time when the dataset will be available, in milliseconds elapsed since January 1st, 1970. -
orderingInstructions
private org.opengis.util.InternationalString orderingInstructionsGeneral instructions, terms and services provided by the distributor. -
turnaround
private org.opengis.util.InternationalString turnaroundTypical turnaround time for the filling of an order. -
orderOptionsType
private org.opengis.util.RecordType orderOptionsTypeDescription of the order options record. -
orderOptions
private org.opengis.util.Record orderOptionsRequest/purchase choices.
-
-
Constructor Details
-
DefaultStandardOrderProcess
public DefaultStandardOrderProcess()Constructs an initially empty standard order process. -
DefaultStandardOrderProcess
public DefaultStandardOrderProcess(org.opengis.metadata.distribution.StandardOrderProcess 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
public static DefaultStandardOrderProcess castOrCopy(org.opengis.metadata.distribution.StandardOrderProcess 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 returnsnull
. - Otherwise if the given object is already an instance of
DefaultStandardOrderProcess
, then it is returned unchanged. - Otherwise a new
DefaultStandardOrderProcess
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
-
getFees
public org.opengis.util.InternationalString getFees()Returns fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217). The monetary units may also be available withgetCurrency()
.- Specified by:
getFees
in interfaceorg.opengis.metadata.distribution.StandardOrderProcess
- Returns:
- fees and terms for retrieving the resource, or
null
. - See Also:
-
setFees
public void setFees(org.opengis.util.InternationalString newValue) Sets fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).- Parameters:
newValue
- the new fees.- See Also:
-
getCurrency
Returns the monetary units of thefees
(as specified in ISO 4217).Constraints
For ISO 19115 compatibility reasons, this method is not required to return a non-null value even if the text returned bygetFees()
contains a currency units. However if this method returns a non-null value, then that value is required to be consistent with the fees text.- Returns:
- the fees monetary units, or
null
if none or unknown. - Since:
- 0.5
- See Also:
-
setCurrency
Sets the monetary units of thefees
(as specified in ISO 4217). Callers should ensure that the given currency is consistent with the currency in the fees text.- Parameters:
newValue
- the new currency.- Since:
- 0.5
- See Also:
-
getPlannedAvailableDateTime
Returns the date and time when the dataset will be available.- Specified by:
getPlannedAvailableDateTime
in interfaceorg.opengis.metadata.distribution.StandardOrderProcess
- Returns:
- date and time when the dataset will be available, or
null
.
-
setPlannedAvailableDateTime
Sets the date and time when the dataset will be available.- Parameters:
newValue
- the new planned available time.
-
getOrderingInstructions
public org.opengis.util.InternationalString getOrderingInstructions()Returns general instructions, terms and services provided by the distributor.- Specified by:
getOrderingInstructions
in interfaceorg.opengis.metadata.distribution.StandardOrderProcess
- Returns:
- general instructions, terms and services provided by the distributor, or
null
.
-
setOrderingInstructions
public void setOrderingInstructions(org.opengis.util.InternationalString newValue) Sets general instructions, terms and services provided by the distributor.- Parameters:
newValue
- the new ordering instructions.
-
getTurnaround
public org.opengis.util.InternationalString getTurnaround()Returns typical turnaround time for the filling of an order.- Specified by:
getTurnaround
in interfaceorg.opengis.metadata.distribution.StandardOrderProcess
- Returns:
- typical turnaround time for the filling of an order, or
null
.
-
setTurnaround
public void setTurnaround(org.opengis.util.InternationalString newValue) Sets typical turnaround time for the filling of an order.- Parameters:
newValue
- the new turnaround.
-
getOrderOptionsType
@UML(identifier="orderOptionsType", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.RecordType getOrderOptionsType()Returns the description of the order options record.- Returns:
- description of the order options record, or
null
if none. - Since:
- 1.0
- See Also:
-
getOrderOptionType
public org.opengis.util.RecordType getOrderOptionType()Deprecated.RenamedgetOrderOptionsType()
for ISO 19115 conformance.- Returns:
- description of the order options record, or
null
if none. - Since:
- 0.5
-
setOrderOptionsType
public void setOrderOptionsType(org.opengis.util.RecordType newValue) Sets the description of the order options record.- Parameters:
newValue
- new description of the order options record.- Since:
- 1.0
-
setOrderOptionType
Deprecated.RenamedsetOrderOptionsType(RecordType)
for ISO 19115 conformance.- Parameters:
newValue
- new description of the order options record.- Since:
- 0.5
-
getOrderOptions
@UML(identifier="orderOptions", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.util.Record getOrderOptions()Returns the request/purchase choices.- Returns:
- request/purchase choices.
- Since:
- 0.5
-
setOrderOptions
public void setOrderOptions(org.opengis.util.Record newValue) Sets the request/purchase choices.- Parameters:
newValue
- the new request/purchase choices.- Since:
- 0.5
-
getOrderOptionsType()
for ISO 19115 conformance.