Package net.sf.saxon.value

Class FloatValue

java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.NumericValue
net.sf.saxon.value.FloatValue
All Implemented Interfaces:
Comparable<XPathComparable>, Iterable<AtomicValue>, AtomicMatchKey, XPathComparable, AtomicSequence, GroundedValue, IdentityComparable, Item, Sequence, ConversionResult, ContextFreeAtomicValue
public final class FloatValue extends NumericValue
A numeric (single precision floating point) value

  • Field Details

  • Constructor Details

    • FloatValue

      public FloatValue(float value)
      Constructor supplying a float
      Parameters:
      value - the value of the float

    • FloatValue

      public FloatValue(float value, AtomicType typeLabel)
      Constructor supplying a float and an AtomicType, for creating a value that belongs to a user-defined subtype of xs:float. It is the caller's responsibility to ensure that the supplied value conforms to the supplied type.
      Parameters:
      value - the value of the NumericValue
      typeLabel - the type of the value. This must be a subtype of xs:float, and the value must conform to this type. The method does not check these conditions.

  • Method Details

    • makeFloatValue

      public static FloatValue makeFloatValue(float value)
      Static factory method (for convenience in compiled bytecode)
      Parameters:
      value - the value of the float
      Returns:
      the FloatValue

    • copyAsSubType

      public AtomicValue copyAsSubType(AtomicType typeLabel)
      Create a copy of this atomic value, with a different type label
      Specified by:
      copyAsSubType in class AtomicValue
      Parameters:
      typeLabel - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.
      Returns:
      the copied value

    • getPrimitiveType

      public BuiltInAtomicType getPrimitiveType()
      Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
      Specified by:
      getPrimitiveType in class AtomicValue
      Returns:
      the primitive type

    • getFloatValue

      public float getFloatValue()
      Get the value
      Specified by:
      getFloatValue in class NumericValue
      Returns:
      a float representing this numeric value; NaN if it cannot be converted

    • getDoubleValue

      public double getDoubleValue()
      Description copied from class: NumericValue
      Get the numeric value as a double
      Specified by:
      getDoubleValue in class NumericValue
      Returns:
      A double representing this numeric value; NaN if it cannot be converted

    • getDecimalValue

      public BigDecimal getDecimalValue() throws ValidationException
      Get the numeric value converted to a decimal
      Specified by:
      getDecimalValue in class NumericValue
      Returns:
      a decimal representing this numeric value;
      Throws:
      ValidationException - if the value cannot be converted, for example if it is NaN or infinite

    • longValue

      public long longValue() throws XPathException
      Return the numeric value as a Java long.
      Specified by:
      longValue in class NumericValue
      Returns:
      the numeric value as a Java long. This performs truncation towards zero.
      Throws:
      XPathException - if the value cannot be converted

    • hashCode

      public int hashCode()
      Get the hashCode. This must conform to the rules for other NumericValue hashcodes
      Specified by:
      hashCode in class NumericValue
      Returns:
      the hash code of the numeric value
      See Also:

    • isNaN

      public boolean isNaN()
      Test whether the value is the double/float value NaN
      Overrides:
      isNaN in class AtomicValue
      Returns:
      true if the value is float NaN or double NaN or precisionDecimal NaN; otherwise false

    • effectiveBooleanValue

      public boolean effectiveBooleanValue()
      Get the effective boolean value
      Specified by:
      effectiveBooleanValue in interface GroundedValue
      Specified by:
      effectiveBooleanValue in class NumericValue
      Returns:
      true unless the value is zero or NaN

    • getPrimitiveStringValue

      public UnicodeString getPrimitiveStringValue()
      Get the value as a String
      Specified by:
      getPrimitiveStringValue in class AtomicValue
      Returns:
      a String representation of the value

    • getCanonicalLexicalRepresentation

      public UnicodeString getCanonicalLexicalRepresentation()
      Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For xs:float, the canonical representation always uses exponential notation.
      Specified by:
      getCanonicalLexicalRepresentation in interface AtomicSequence
      Overrides:
      getCanonicalLexicalRepresentation in class AtomicValue
      Returns:
      the value, represented as a string in exponential notation

    • floatToString

      public static UnicodeString floatToString(float value)
      Internal method used for conversion of a float to a string
      Parameters:
      value - the actual value
      Returns:
      the value converted to a string, according to the XPath casting rules.

    • negate

      public NumericValue negate()
      Negate the value
      Specified by:
      negate in class NumericValue
      Returns:
      a value, of the same type as the original, with its sign inverted

    • floor

      public NumericValue floor()
      Implement the XPath floor() function
      Specified by:
      floor in class NumericValue
      Returns:
      a value, of the same type as that supplied, rounded towards minus infinity

    • ceiling

      public NumericValue ceiling()
      Implement the XPath ceiling() function
      Specified by:
      ceiling in class NumericValue
      Returns:
      a value, of the same type as that supplied, rounded towards plus infinity

    • round

      public NumericValue round(int scale)
      Implement the XPath round() function
      Specified by:
      round in class NumericValue
      Parameters:
      scale - the number of decimal places required in the result (supply 0 for rounding to an integer)
      Returns:
      a value, of the same type as that supplied, rounded towards the nearest whole number (0.5 rounded up)

    • round

      public NumericValue round(int scale, Round.RoundingRule roundingRule)
      Implement the XPath round-to-half-even() function
      Specified by:
      round in class NumericValue
      Parameters:
      scale - the decimal position for rounding: e.g. 2 rounds to a multiple of 0.01, while -2 rounds to a multiple of 100
      roundingRule - the rule to be used for rounding (up, down, towards zero, etc)
      Returns:
      a value, of the same type as the original, rounded to a multiple of 10^(-scale), according to the rounding rules requested

    • signum

      public int signum()
      Determine whether the value is negative, zero, or positive
      Specified by:
      signum in class NumericValue
      Returns:
      -1 if negative, 0 if zero (including negative zero), +1 if positive, NaN if NaN

    • isNegativeZero

      public boolean isNegativeZero()
      Ask whether this value is negative zero
      Overrides:
      isNegativeZero in class NumericValue
      Returns:
      true if this value is float or double negative zero

    • isWholeNumber

      public boolean isWholeNumber()
      Determine whether the value is a whole number, that is, whether it compares equal to some integer
      Specified by:
      isWholeNumber in class NumericValue
      Returns:
      true if the value is a whole number

    • asSubscript

      public int asSubscript()
      Test whether a number is a possible subscript into a sequence, that is, a whole number greater than zero and less than 2^31
      Specified by:
      asSubscript in class NumericValue
      Returns:
      the number as an int if it is a possible subscript, or -1 otherwise

    • abs

      public NumericValue abs()
      Get the absolute value as defined by the XPath abs() function
      Specified by:
      abs in class NumericValue
      Returns:
      the absolute value
      Since:
      9.2

    • compareTo

      public int compareTo(XPathComparable other)
      Description copied from class: NumericValue
      Compare the value to another numeric value
      Specified by:
      compareTo in interface Comparable<XPathComparable>
      Overrides:
      compareTo in class NumericValue
      Parameters:
      other - The other numeric value
      Returns:
      -1 if this one is the lower, 0 if they are numerically equal, +1 if this one is the higher, or if either value is NaN. Where NaN values are involved, they should be handled by the caller before invoking this method.

    • compareTo

      public int compareTo(long other)
      Compare the value to a long
      Specified by:
      compareTo in class NumericValue
      Parameters:
      other - the value to be compared with
      Returns:
      -1 if this is less, 0 if this is equal, +1 if this is greater or if this is NaN

    • asMapKey

      public AtomicMatchKey asMapKey()
      Get a value whose equals() method follows the "same key" rules for comparing the keys of a map.
      Overrides:
      asMapKey in class AtomicValue
      Returns:
      a value with the property that the equals() and hashCode() methods follow the rules for comparing keys in maps.

    • isIdentical

      public boolean isIdentical(AtomicValue v)
      Determine whether two atomic values are identical, as determined by XML Schema rules. This is a stronger test than equality (even schema-equality); for example two dateTime values are not identical unless they are in the same timezone.

      Note that even this check ignores the type annotation of the value. The integer 3 and the short 3 are considered identical, even though they are not fully interchangeable. "Identical" means the same point in the value space, regardless of type annotation.

      NaN is identical to itself.

      Overrides:
      isIdentical in class AtomicValue
      Parameters:
      v - the other value to be compared with this one
      Returns:
      true if the two values are identical, false otherwise.

    • asAtomic

      public AtomicValue asAtomic()
      Description copied from class: AtomicValue
      Calling this method on a ConversionResult returns the AtomicValue that results from the conversion if the conversion was successful, and throws a ValidationException explaining the conversion error otherwise.

      Use this method if you are calling a conversion method that returns a ConversionResult, and if you want to throw an exception if the conversion fails.

      Specified by:
      asAtomic in interface AtomicMatchKey
      Specified by:
      asAtomic in interface ConversionResult
      Overrides:
      asAtomic in class AtomicValue
      Returns:
      the atomic value that results from the conversion if the conversion was successful