Class NotationValue

All Implemented Interfaces:
Serializable, PullEvent, SequenceIterable, GroundedValue, Item, ValueRepresentation, ConversionResult

public final class NotationValue extends QualifiedNameValue
An xs:NOTATION value.
See Also:
  • Constructor Details

    • NotationValue

      public NotationValue(String prefix, String uri, String localName, NameChecker checker) throws XPathException
      Constructor
      Parameters:
      prefix - The prefix part of the QName (not used in comparisons). Use null or "" to represent the default prefix.
      uri - The namespace part of the QName. Use null or "" to represent the null namespace.
      localName - The local part of the QName
      checker - Used for checking names against XML 1.0 or XML 1.1 syntax rules
      Throws:
      XPathException
    • NotationValue

      public NotationValue(String prefix, String uri, String localName)
      Constructor for a value that is known to be valid
      Parameters:
      prefix - The prefix part of the QName (not used in comparisons). Use null or "" to represent the default prefix.
      uri - The namespace part of the QName. Use null or "" to represent the null namespace.
      localName - The local part of the QName
    • NotationValue

      public NotationValue(String prefix, String uri, String localName, AtomicType typeLabel)
      Constructor for a value that is known to be valid
      Parameters:
      prefix - The prefix part of the QName (not used in comparisons). Use null or "" to represent the default prefix.
      uri - The namespace part of the QName. Use null or "" to represent the null namespace.
      localName - The local part of the QName
      typeLabel - A type derived from xs:NOTATION to be used for the new value
  • Method Details

    • 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
    • convertPrimitive

      public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
      Convert to target data type
      Specified by:
      convertPrimitive in class AtomicValue
      Parameters:
      requiredType - an integer identifying the required atomic type
      context - The XPath dynamic context
      validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.
      Returns:
      an AtomicValue, a value of the required type; or an ErrorValue
    • equals

      public boolean equals(Object other)
      Determine if two Notation values are equal. This comparison ignores the prefix part of the value.
      Specified by:
      equals in class AtomicValue
      Parameters:
      other - the other value
      Returns:
      true if the other operand is an atomic value and the two values are equal as defined by the XPath eq operator
      Throws:
      ClassCastException - if they are not comparable
      IllegalStateException - if the two QNames are in different name pools
    • getSchemaComparable

      public Comparable getSchemaComparable()
      Description copied from class: AtomicValue
      Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. An implementation must be provided for all atomic types.

      In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value Value.INDETERMINATE_ORDERING when there is no defined order relationship between two given values. This value is also returned when two values of different types are compared.

      Specified by:
      getSchemaComparable in class AtomicValue
      Returns:
      a Comparable that follows XML Schema comparison rules
    • toString

      public String toString()
      The toString() method returns the name in the form QName("uri", "local")
      Overrides:
      toString in class QualifiedNameValue
      Returns:
      the name in Clark notation: {uri}local