Package org.apache.sis.metadata.iso.acquisition

Class DefaultEnvironmentalRecord

  • All Implemented Interfaces:
    Serializable, Emptiable, Lenient­Comparable, Identified­Object, Environmental­Record
    public class DefaultEnvironmentalRecord
extends ISOMetadata
implements EnvironmentalRecord
    Information about the environmental conditions during the acquisition. The following properties are mandatory in a well-formed metadata according ISO 19115:
    MI_Environmental­Record   ├─average­Air­Temperature…………… Average air temperature along the flight pass during the photo flight.   ├─max­Relative­Humidity………………… Maximum relative humidity along the flight pass during the photo flight.   ├─max­Altitude……………………………………… Maximum altitude during the photo flight.   └─meteorological­Conditions…… Meteorological conditions in the photo flight area, in particular clouds, snow and wind.

    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

      • DefaultEnvironmentalRecord

        public DefaultEnvironmentalRecord()
        Constructs an initially empty environmental record.

      • DefaultEnvironmentalRecord

        public DefaultEnvironmentalRecord​(EnvironmentalRecord 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.
        Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.
        Parameters:
        object - the metadata to copy values from, or null if none.
        See Also:
        cast­Or­Copy(Environmental­Record)

    • Method Detail

      • castOrCopy

        public static DefaultEnvironmentalRecord castOrCopy​(EnvironmentalRecord 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­Environmental­Record, then it is returned unchanged.
        • Otherwise a new Default­Environmental­Record 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.

      • getAverageAirTemperature

        public Double getAverageAirTemperature()
        Returns the average air temperature along the flight pass during the photo flight.
        Specified by:
        get­Average­Air­Temperature in interface Environmental­Record
        Returns:
        average air temperature along the flight pass during the photo flight, or null.

      • setAverageAirTemperature

        public void setAverageAirTemperature​(Double newValue)
        Sets the average air temperature along the flight pass during the photo flight.
        Parameters:
        new­Value - the new average air temperature value.

      • setMaxRelativeHumidity

        public void setMaxRelativeHumidity​(Double newValue)
        Sets the maximum relative humidity along the flight pass during the photo flight.
        Parameters:
        new­Value - the new maximum relative humidity, or null.
        Throws:
        Illegal­Argument­Exception - if the given value is out of range.

      • getMaxAltitude

        public Double getMaxAltitude()
        Returns the maximum altitude during the photo flight.
        Specified by:
        get­Max­Altitude in interface Environmental­Record
        Returns:
        maximum altitude during the photo flight, or null.

      • setMaxAltitude

        public void setMaxAltitude​(Double newValue)
        Sets the maximum altitude value.
        Parameters:
        new­Value - the new maximum altitude value.

      • setMeteorologicalConditions

        public void setMeteorologicalConditions​(InternationalString newValue)
        Sets the meteorological conditions in the photo flight area, in particular clouds, snow and wind.
        Parameters:
        new­Value - the meteorological conditions value.