Class DefaultStandardOrderProcess

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultStandardOrderProcess

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Standard­Order­Process

public class DefaultStandardOrderProcess
extends ISOMetadata
implements 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

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­Standard­Order­Process()	Constructs an initially empty standard order process.
Default­Standard­Order­Process(Standard­Order­Process object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Standard­Order­Process	cast­Or­Copy(Standard­Order­Process object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Currency	get­Currency()	Returns the monetary units of the fees (as specified in ISO 4217).
International­String	get­Fees()	Returns fees and terms for retrieving the resource.
International­String	get­Ordering­Instructions()	Returns general instructions, terms and services provided by the distributor.
Record	get­Order­Options()	Returns the request/purchase choices.
Record­Type	get­Order­Options­Type()	Returns the description of the order options record.
Temporal	get­Planned­Available­Date()	Returns the date and time when the dataset will be available.
Date	get­Planned­Available­Date­Time()	Deprecated. Replaced by get­Planned­Available­Date().
International­String	get­Turnaround()	Returns typical turnaround time for the filling of an order.
void	set­Currency(Currency new­Value)	Sets the monetary units of the fees (as specified in ISO 4217).
void	set­Fees(International­String new­Value)	Sets fees and terms for retrieving the resource.
void	set­Ordering­Instructions(International­String new­Value)	Sets general instructions, terms and services provided by the distributor.
void	set­Order­Options(Record new­Value)	Sets the request/purchase choices.
void	set­Order­Options­Type(Record­Type new­Value)	Sets the description of the order options record.
void	set­Planned­Available­Date(Temporal new­Value)	Sets the date and time when the dataset will be available.
void	set­Planned­Available­Date­Time(Date new­Value)	Deprecated. Replaced by set­Planned­Available­Date(Temporal).
void	set­Turnaround(International­String new­Value)	Sets typical turnaround time for the filling of an order.

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

DefaultStandardOrderProcess

public DefaultStandardOrderProcess()

Constructs an initially empty standard order process.

DefaultStandardOrderProcess

public DefaultStandardOrderProcess(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, or null if none.

See Also:

• cast­Or­Copy(Standard­Order­Process)

Method Details

castOrCopy

public static DefaultStandardOrderProcess castOrCopy(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 returns null.
• Otherwise if the given object is already an instance of Default­Standard­Order­Process, then it is returned unchanged.
• Otherwise a new Default­Standard­Order­Process 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.

getFees

public 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 with get­Currency().

Specified by:

get­Fees in interface Standard­Order­Process

Returns:

fees and terms for retrieving the resource, or null.

See Also:

• get­Currency()

setFees

public void setFees(InternationalString newValue)

Sets fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).

Parameters:

new­Value - the new fees.

See Also:

• set­Currency(Currency)

getCurrency

public Currency getCurrency()

Returns the monetary units of the fees (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 by get­Fees() 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:

• get­Fees()

setCurrency

public void setCurrency(Currency newValue)

Sets the monetary units of the fees (as specified in ISO 4217). Callers should ensure that the given currency is consistent with the currency in the fees text.

Parameters:

new­Value - the new currency.

Since:

0.5

See Also:

• set­Fees(International­String)

getPlannedAvailableDateTime

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

Deprecated.

Replaced by get­Planned­Available­Date().

Returns the date and time when the dataset will be available.

Specified by:

get­Planned­Available­Date­Time in interface Standard­Order­Process

Returns:

date and time when the dataset will be available, or null.

setPlannedAvailableDateTime

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

Deprecated.

Replaced by set­Planned­Available­Date(Temporal).

Sets the date and time when the dataset will be available.

Parameters:

new­Value - the new planned available time.

getPlannedAvailableDate

@UML(identifier="plannedAvailableDateTime",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Temporal getPlannedAvailableDate()

Returns the date and time when the dataset will be available.

Returns:

date and time when the dataset will be available, or null.

Since:

1.5

setPlannedAvailableDate

public void setPlannedAvailableDate(Temporal newValue)

Sets the date and time when the dataset will be available. 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 planned available time.

Since:

1.5

getOrderingInstructions

public InternationalString getOrderingInstructions()

Returns general instructions, terms and services provided by the distributor.

Specified by:

get­Ordering­Instructions in interface Standard­Order­Process

Returns:

general instructions, terms and services provided by the distributor, or null.

setOrderingInstructions

public void setOrderingInstructions(InternationalString newValue)

Sets general instructions, terms and services provided by the distributor.

Parameters:

new­Value - the new ordering instructions.

getTurnaround

public InternationalString getTurnaround()

Returns typical turnaround time for the filling of an order.

Specified by:

get­Turnaround in interface Standard­Order­Process

Returns:

typical turnaround time for the filling of an order, or null.

setTurnaround

public void setTurnaround(InternationalString newValue)

Sets typical turnaround time for the filling of an order.

Parameters:

new­Value - the new turnaround.

getOrderOptionsType

@UML(identifier="orderOptionsType",
     obligation=OPTIONAL,
     specification=ISO_19115)
public 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:

• Default­Record.get­Record­Type()

setOrderOptionsType

public void setOrderOptionsType(RecordType newValue)

Sets the description of the order options record.

Parameters:

new­Value - new description of the order options record.

Since:

1.0

getOrderOptions

@UML(identifier="orderOptions",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Record getOrderOptions()

Returns the request/purchase choices.

Returns:

request/purchase choices.

Since:

0.5

"TODO:"

We presume that this record is filled by the vendor for describing the options chosen by the client when he ordered the resource. We presume that this is not a record to be filled by the user for new orders, otherwise this method would need to be a factory rather than a getter.

setOrderOptions

public void setOrderOptions(Record newValue)

Sets the request/purchase choices.

Parameters:

new­Value - the new request/purchase choices.

Since:

0.5