Class DefaultAlgorithm

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Algorithm

    public class DefaultAlgorithm
    extends ISOMetadata
    implements 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
    See Also:
    Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultAlgorithm

        public DefaultAlgorithm()
        Constructs an initially empty algorithm.
      • DefaultAlgorithm

        public DefaultAlgorithm​(Algorithm object)
        Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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(Algorithm)
    • Method Detail

      • castOrCopy

        public static DefaultAlgorithm castOrCopy​(Algorithm 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­Algorithm, then it is returned unchanged.
        • Otherwise a new Default­Algorithm instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.
      • getCitation

        public Citation getCitation()
        Returns the information identifying the algorithm and version or date.
        Specified by:
        get­Citation in interface Algorithm
        Returns:
        algorithm and version or date, or null.
      • setCitation

        public void setCitation​(Citation newValue)
        Sets the information identifying the algorithm and version or date.
        Parameters:
        new­Value - the new citation value.
      • getDescription

        public InternationalString getDescription()
        Returns the information describing the algorithm used to generate the data.
        Specified by:
        get­Description in interface Algorithm
        Returns:
        algorithm used to generate the data, or null.
      • setDescription

        public void setDescription​(InternationalString newValue)
        Sets the information describing the algorithm used to generate the data.
        Parameters:
        new­Value - the new description value.