Class DefaultAlgorithm
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultAlgorithm
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 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 algorithm.DefaultAlgorithm(Algorithm object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultAlgorithmcastOrCopy(Algorithm object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the information identifying the algorithm and version or date.Returns the information describing the algorithm used to generate the data.voidsetCitation(Citation newValue) Sets the information identifying the algorithm and version or date.voidsetDescription(InternationalString newValue) Sets the information describing the algorithm used to generate the data.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, 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- 
DefaultAlgorithmpublic DefaultAlgorithm()Constructs an initially empty algorithm.
- 
DefaultAlgorithmConstructs 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
       DefaultAlgorithm, then it is returned unchanged.
- Otherwise a new DefaultAlgorithminstance 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 information identifying the algorithm and version or date.- Specified by:
- getCitationin interface- Algorithm
- Returns:
- algorithm and version or date, or null.
 
- 
setCitationSets the information identifying the algorithm and version or date.- Parameters:
- newValue- the new citation value.
 
- 
getDescriptionReturns the information describing the algorithm used to generate the data.- Specified by:
- getDescriptionin interface- Algorithm
- Returns:
- algorithm used to generate the data, or null.
 
- 
setDescriptionSets the information describing the algorithm used to generate the data.- Parameters:
- newValue- the new description value.
 
 
-