Class DefaultProcessing

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultProcessing

All Implemented Interfaces:

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

@TitleProperty(name="identifier")
public class DefaultProcessing
extends ISOMetadata
implements Processing

Comprehensive information about the procedure(s), process(es) and algorithm(s) applied in the process step. The following properties are mandatory in a well-formed metadata according ISO 19115:

LE_Processing └─identifier…… Information to identify the processing package that produced the data. └─code………… Alphanumeric value identifying an instance in the namespace.

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

Method Summary

Modifier and Type	Method	Description
static Default­Processing	cast­Or­Copy(Processing object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Algorithm>	get­Algorithms()	Returns the details of the methodology by which geographic information was derived from the instrument readings.
Collection<Citation>	get­Documentations()	Returns the reference to documentation describing the processing.
Identifier	get­Identifier()	Returns the information to identify the processing package that produced the data.
International­String	get­Procedure­Description()	Returns the additional details about the processing procedures.
International­String	get­Run­Time­Parameters()	Returns the parameters to control the processing operations, entered at run time.
Collection<Citation>	get­Software­References()	Returns the reference to document describing processing software.
void	set­Algorithms(Collection<? extends Algorithm> new­Values)	Sets the details of the methodology by which geographic information was derived from the instrument readings.
void	set­Documentations(Collection<? extends Citation> new­Values)	Sets the reference to documentation describing the processing.
void	set­Identifier(Identifier new­Value)	Sets the information to identify the processing package that produced the data.
void	set­Procedure­Description(International­String new­Value)	Sets the additional details about the processing procedures.
void	set­Run­Time­Parameters(International­String new­Value)	Sets the parameters to control the processing operations, entered at run time.
void	set­Software­References(Collection<? extends Citation> new­Values)	Sets the reference to document describing processing software.

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

DefaultProcessing

public DefaultProcessing()

Constructs an initially empty range element description.

DefaultProcessing

public DefaultProcessing(Processing 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(Processing)

Method Details

castOrCopy

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

getIdentifier

public Identifier getIdentifier()

Returns the information to identify the processing package that produced the data.

Specified by:

get­Identifier in interface Processing

Overrides:

get­Identifier in class ISOMetadata

Returns:

identifier of the processing package that produced the data, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the information to identify the processing package that produced the data.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the new identifier value.

getSoftwareReferences

public Collection<Citation> getSoftwareReferences()

Returns the reference to document describing processing software.

Specified by:

get­Software­References in interface Processing

Returns:

document describing processing software.

setSoftwareReferences

public void setSoftwareReferences(Collection<? extends Citation> newValues)

Sets the reference to document describing processing software.

Parameters:

new­Values - the new software references values.

getProcedureDescription

public InternationalString getProcedureDescription()

Returns the additional details about the processing procedures. null if unspecified.

Specified by:

get­Procedure­Description in interface Processing

Returns:

processing procedures, or null.

setProcedureDescription

public void setProcedureDescription(InternationalString newValue)

Sets the additional details about the processing procedures.

Parameters:

new­Value - the new procedure description value.

getDocumentations

public Collection<Citation> getDocumentations()

Returns the reference to documentation describing the processing.

Specified by:

get­Documentations in interface Processing

Returns:

documentation describing the processing.

setDocumentations

public void setDocumentations(Collection<? extends Citation> newValues)

Sets the reference to documentation describing the processing.

Parameters:

new­Values - the new documentations values.

getRunTimeParameters

public InternationalString getRunTimeParameters()

Returns the parameters to control the processing operations, entered at run time.

Specified by:

get­Run­Time­Parameters in interface Processing

Returns:

parameters to control the processing operations, or null.

setRunTimeParameters

public void setRunTimeParameters(InternationalString newValue)

Sets the parameters to control the processing operations, entered at run time.

Parameters:

new­Value - the new runtime parameter value.

getAlgorithms

public Collection<Algorithm> getAlgorithms()

Returns the details of the methodology by which geographic information was derived from the instrument readings.

Specified by:

get­Algorithms in interface Processing

Returns:

methodology by which geographic information was derived from the instrument readings.

setAlgorithms

public void setAlgorithms(Collection<? extends Algorithm> newValues)

Sets the details of the methodology by which geographic information was derived from the instrument readings.

Parameters:

new­Values - the new algorithms values.