Package net.sf.saxon.value

Class QualifiedNameValue

java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.QualifiedNameValue
All Implemented Interfaces:
Comparable<XPathComparable>, Iterable<AtomicValue>, AtomicMatchKey, XPathComparable, AtomicSequence, GroundedValue, IdentityComparable, Item, Sequence, ConversionResult
Direct Known Subclasses:
NotationValue, QNameValue
public abstract class QualifiedNameValue extends AtomicValue implements AtomicMatchKey, XPathComparable
A qualified name: this is an abstract superclass for QNameValue and NotationValue, representing the XPath primitive types xs:QName and xs:NOTATION respectively

  • Field Details

  • Constructor Details

  • Method Details

    • makeQName

      public static AtomicValue makeQName(String prefix, NamespaceUri uri, String local, AtomicType targetType, UnicodeString lexicalForm, ConversionRules rules) throws XPathException
      Factory method to construct either a QName or a NOTATION value, or a subtype of either of these. Note that it is the caller's responsibility to resolve the QName prefix into a URI
      Parameters:
      prefix - the prefix part of the value. Use "" or null for the empty prefix.
      uri - the namespace URI part of the value. Use "" or null for the non-namespace
      local - the local part of the value
      targetType - the target type, which must be xs:QName or a subtype of xs:NOTATION or xs:QName
      lexicalForm - the original lexical form of the value. This is needed in case there are facets such as pattern that check the lexical form
      rules - the conversion rules to be applied
      Returns:
      the converted value
      Throws:
      XPathException - if the value cannot be converted.

    • asMapKey

      public AtomicMatchKey asMapKey(int specVersion)
      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.

    • getPrimitiveStringValue

      public final UnicodeString getPrimitiveStringValue()
      Get the string value as a String. Returns the QName as a lexical QName, retaining the original prefix if available.
      Specified by:
      getPrimitiveStringValue in class AtomicValue
      Returns:
      the value converted to a string

    • getClarkName

      public final String getClarkName()
      Get the QName in Clark notation, that is "{uri}local" if in a namespace, or "local" otherwise
      Returns:
      the name in Clark notation

    • getEQName

      public final String getEQName()
      Get the QName in EQName notation, that is "Q{uri}local" if in a namespace, or "Q{}local" otherwise
      Returns:
      the name in EQName notation

    • getLocalName

      public final String getLocalName()
      Get the local part
      Returns:
      the local part of the name (the part after the colon)

    • getNamespaceURI

      public final NamespaceUri getNamespaceURI()
      Get the namespace part. Returns the empty string for a name in no namespace.
      Returns:
      the namespace URI component of the name, or "" for a no-namespace name

    • getPrefix

      public final String getPrefix()
      Get the prefix. Returns the empty string if the name is unprefixed.
      Returns:
      the prefix, or "" to indicate no prefix

    • getXPathMatchKey

      public AtomicMatchKey getXPathMatchKey(StringCollator collator, int implicitTimezone, int specVersion)
      Get an object value that implements the XPath equality and ordering comparison semantics for this value. If the ordered parameter is set to true, the result will be a Comparable and will support a compareTo() method with the semantics of the XPath lt/gt operator, provided that the other operand is also obtained using the getXPathComparable() method. In all cases the result will support equals() and hashCode() methods that support the semantics of the XPath eq operator, again provided that the other operand is also obtained using the getXPathComparable() method. A context argument is supplied for use in cases where the comparison semantics are context-sensitive, for example where they depend on the implicit timezone or the default collation.
      Specified by:
      getXPathMatchKey in class AtomicValue
      Parameters:
      collator - the collation to be used for the comparison
      implicitTimezone - the XPath dynamic evaluation context, used in cases where the comparison is context
      specVersion -
      Returns:
      an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable

    • getXPathComparable

      public XPathComparable getXPathComparable(StringCollator collator, int implicitTimezone, int specVersion) throws NoDynamicContextException
      Description copied from class: AtomicValue
      Get an object value that implements the XPath equality and ordering comparison semantics for this value. A collation is supplied for comparing strings, and an implicit timezone for comparing date/time values that have no saved timezone. An atomic value may return itself as the result, provided that its ordering rules are independent of the collation and timezone, and provided that it implements the XPathComparable interface: which means that its compareTo, equals, and hashCode methods must be compatible with the rules for XPath value comparisons.
      Specified by:
      getXPathComparable in class AtomicValue
      Parameters:
      collator - the collation to be used when comparing strings
      implicitTimezone - the implicit timezone in the dynamic context, used when comparing dates/times with and without timezone
      specVersion - the version of the XPath specification (31 for 3.1, 40 for 4.0)
      Returns:
      an Object that implements the XPath value comparison semantics with respect to this atomic value. For an atomic type that is not ordered (according to XPath rules), return null.
      Throws:
      NoDynamicContextException - if the supplied implicit timezone is "NO_TIMEZONE" (meaning unknown), and the implicit timezone is actually required because the value in question is a date/time value with no timezone. This can cause a failure to evaluate expressions statically (because the implicit timezone is not known statically), and it will then be caught, meaning that the expression has to be evaluated dynamically.

    • compareTo

      public int compareTo(XPathComparable o)
      Specified by:
      compareTo in interface Comparable<XPathComparable>

    • hashCode

      public int hashCode()
      Description copied from class: AtomicValue
      Returns a hash code value for the object.
      Overrides:
      hashCode in class AtomicValue

    • isIdentical

      public boolean isIdentical(AtomicValue v)
      Description copied from class: AtomicValue
      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.

    • identityHashCode

      public int identityHashCode()
      Get a hashCode that offers the guarantee that if A.isIdentical(B), then A.identityHashCode() == B.identityHashCode()
      Specified by:
      identityHashCode in interface IdentityComparable
      Overrides:
      identityHashCode in class AtomicValue
      Returns:
      a hashCode suitable for use when testing for identity.

    • show

      public String show()
      The show() method returns the name in the form QName("uri", "local")
      Overrides:
      show in class AtomicValue
      Returns:
      the name in in the form QName("uri", "local")

    • toJaxpQName

      public QName toJaxpQName()
      Construct a javax.xml.namespace.QName from this QualifiedNameValue
      Returns:
      an equivalent instance of the JAXP QName class

    • getStructuredQName

      public StructuredQName getStructuredQName()
      Get the equivalent StructuredQName
      Returns:
      the equivalent StructuredQName