Class DefaultAlgorithm
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.lineage.DefaultAlgorithm
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.lineage.Algorithm
Details of the methodology by which geographic information was derived from the instrument readings.
The following properties are mandatory in a well-formed metadata according ISO 19115:
LE_Algorithm
├─citation…………………………
Information identifying the algorithm and version or date.
│ ├─title………………………
Name by which the cited resource is known.
│ └─date…………………………
Reference date for the cited resource.
└─description…………………
Information describing the algorithm used to generate the data.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
Information identifying the algorithm and version or date.private org.opengis.util.InternationalString
Information describing the algorithm used to generate the data.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 algorithm.DefaultAlgorithm
(org.opengis.metadata.lineage.Algorithm object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultAlgorithm
castOrCopy
(org.opengis.metadata.lineage.Algorithm object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.citation.Citation
Returns the information identifying the algorithm and version or date.org.opengis.util.InternationalString
Returns the information describing the algorithm used to generate the data.void
setCitation
(org.opengis.metadata.citation.Citation newValue) Sets the information identifying the algorithm and version or date.void
setDescription
(org.opengis.util.InternationalString newValue) Sets the information describing the algorithm used to generate the data.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:
-
citation
private org.opengis.metadata.citation.Citation citationInformation identifying the algorithm and version or date. -
description
private org.opengis.util.InternationalString descriptionInformation describing the algorithm used to generate the data.
-
-
Constructor Details
-
DefaultAlgorithm
public DefaultAlgorithm()Constructs an initially empty algorithm. -
DefaultAlgorithm
public DefaultAlgorithm(org.opengis.metadata.lineage.Algorithm 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
DefaultAlgorithm
, then it is returned unchanged. - Otherwise a new
DefaultAlgorithm
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 information identifying the algorithm and version or date.- Specified by:
getCitation
in interfaceorg.opengis.metadata.lineage.Algorithm
- Returns:
- algorithm and version or date, or
null
.
-
setCitation
public void setCitation(org.opengis.metadata.citation.Citation newValue) Sets the information identifying the algorithm and version or date.- Parameters:
newValue
- the new citation value.
-
getDescription
public org.opengis.util.InternationalString getDescription()Returns the information describing the algorithm used to generate the data.- Specified by:
getDescription
in interfaceorg.opengis.metadata.lineage.Algorithm
- Returns:
- algorithm used to generate the data, or
null
.
-
setDescription
public void setDescription(org.opengis.util.InternationalString newValue) Sets the information describing the algorithm used to generate the data.- Parameters:
newValue
- the new description value.
-