Package org.apache.sis.metadata.iso.identification

Class DefaultRepresentativeFraction

  • All Implemented Interfaces:
    Serializable, Cloneable, Emptiable, Identified­Object, Representative­Fraction
    public class DefaultRepresentativeFraction
extends Number
implements RepresentativeFraction, IdentifiedObject, Emptiable, Cloneable
    A scale defined as the inverse of a denominator. Scale is defined as a kind of Number. The following property is mandatory in a well-formed metadata according ISO 19115:
    MD_Representative­Fraction   └─denominator………………………… The number below the line in a vulgar fraction.
    In addition to the standard properties, SIS provides the following methods:
    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:
    Default­Resolution​.get­Equivalent­Scale(), Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • DefaultRepresentativeFraction

        public DefaultRepresentativeFraction()
        Creates a uninitialized representative fraction. The denominator is initially zero and the double value is NaN.

      • DefaultRepresentativeFraction

        public DefaultRepresentativeFraction​(long denominator)
        Creates a new representative fraction from the specified denominator.
        Parameters:
        denominator - the denominator as a positive number, or 0 if unspecified.
        Throws:
        Illegal­Argument­Exception - if the given value is negative.

      • DefaultRepresentativeFraction

        public DefaultRepresentativeFraction​(RepresentativeFraction object)
        Constructs a new representative fraction initialized to the value of the given object.
        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.

    • Method Detail

      • castOrCopy

        public static DefaultRepresentativeFraction castOrCopy​(RepresentativeFraction object)
        Returns a SIS metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the property values of the given object, using a shallow copy operation (i.e. properties are not cloned).
        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.

      • setDenominator

        public void setDenominator​(long denominator)
        Sets the denominator value.
        Parameters:
        denominator - the new denominator value, or 0 if none.
        Throws:
        Illegal­Argument­Exception - if the given value is negative.

      • setScale

        public void setScale​(double scale)
        Sets the denominator from a scale in the (0 … 1] range. The denominator is computed by round(1 / scale).

        The equivalent of a get­Scale() method is double­Value().

        Parameters:
        scale - the scale as a number between 0 exclusive and 1 inclusive, or NaN.
        Throws:
        Illegal­Argument­Exception - if the given scale is our of range.

      • floatValue

        public float floatValue()
        Returns the scale as a float type.
        Specified by:
        float­Value in class Number
        Returns:
        the scale.

      • longValue

        public long longValue()
        Returns 1 if the denominator is equals to 1, or 0 otherwise.
        Rational: This method is defined that way because scales smaller than 1 can only be casted to 0, and NaN values are also represented by 0.
        Specified by:
        long­Value in class Number
        Returns:
        1 if the denominator is 1, or 0 otherwise.

      • intValue

        public int intValue()
        Returns 1 if the denominator is equals to 1, or 0 otherwise.
        Rational: This method is defined that way because scales smaller than 1 can only be casted to 0, and NaN values are also represented by 0.
        Specified by:
        int­Value in class Number
        Returns:
        1 if the denominator is 1, or 0 otherwise.

      • isEmpty

        public boolean isEmpty()
        Returns true if no scale is defined. The following relationship shall hold: 
        assert isEmpty() == Double.isNaN(doubleValue());
        Specified by:
        is­Empty in interface Emptiable
        Returns:
        true if no scale is defined.
        Since:
        0.6
        See Also:
        double­Value(), float­Value()

      • clone

        public DefaultRepresentativeFraction clone()
        Returns a modifiable copy of this representative fraction.
        Overrides:
        clone in class Object
        Returns:
        a modifiable copy of this representative fraction.

      • equals

        public boolean equals​(Object object)
        Compares this object with the specified value for equality.
        Specified by:
        equals in interface Representative­Fraction
        Overrides:
        equals in class Object
        Parameters:
        object - the object to compare with.
        Returns:
        true if both objects are equal.

      • toString

        public String toString()
        Returns a string representation of this scale, or Na­N if undefined. If defined, the string representation uses the colon as in "1:20000".
        Overrides:
        to­String in class Object
        Returns:
        a string representation of this scale.

      • getIdentifierMap

        public IdentifierMap getIdentifierMap()
        Returns a map view of the identifiers collection as (authority, code) entries. That map is live: changes in the identifiers list will be reflected in the map, and conversely.
        Specified by:
        get­Identifier­Map in interface Identified­Object
        Returns:
        the identifiers as a map of (authority, code) entries, or an empty map if none.