net.sf.saxon.value

Class NotationValue

java.lang.Object

net.sf.saxon.value.AtomicValue

net.sf.saxon.value.QualifiedNameValue

net.sf.saxon.value.NotationValue

All Implemented Interfaces:

java.lang.Iterable<AtomicValue>, AtomicMatchKey, AtomicSequence, GroundedValue<AtomicValue>, IdentityComparable, Item<AtomicValue>, Sequence<AtomicValue>, ConversionResult

public final class NotationValue
extends QualifiedNameValue

An xs:NOTATION value.

Field Summary

Fields inherited from class net.sf.saxon.value.QualifiedNameValue

qName

Fields inherited from class net.sf.saxon.value.AtomicValue

typeLabel

Fields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey

NaN_MATCH_KEY

Constructor Summary

Constructors

Constructor and Description
NotationValue(java.lang.String prefix, java.lang.String uri, java.lang.String localName) Constructor for a value that is known to be valid
NotationValue(java.lang.String prefix, java.lang.String uri, java.lang.String localName, AtomicType typeLabel) Constructor for a value that is known to be valid
NotationValue(java.lang.String prefix, java.lang.String uri, java.lang.String localName, boolean check) Constructor
NotationValue(StructuredQName qName, AtomicType typeLabel) Constructor

Method Summary

Modifier and Type	Method and Description
AtomicValue	copyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type label
boolean	equals(java.lang.Object other) Determine if two Notation values are equal.
BuiltInAtomicType	getPrimitiveType() Determine the primitive type of the value.
java.lang.Comparable	getSchemaComparable() Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
java.lang.String	toString() The toString() method returns the name in the form QName("uri", "local")

Methods inherited from class net.sf.saxon.value.QualifiedNameValue

getClarkName, getLocalName, getNamespaceURI, getPrefix, getPrimitiveStringValue, getStructuredQName, getXPathComparable, hashCode, identityHashCode, isIdentical, makeQName, toJaxpQName

Methods inherited from class net.sf.saxon.value.AtomicValue

asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, effectiveBooleanValue, getCanonicalLexicalRepresentation, getCardinality, getComponent, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, isIdentical, isNaN, itemAt, iterate, iterator, process, setTypeLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey

asAtomic

Methods inherited from interface net.sf.saxon.om.Item

isStreamed, reduce, subsequence, toGroundedValue, toShortString

Methods inherited from interface net.sf.saxon.om.GroundedValue

asIterable, materialize

Methods inherited from interface net.sf.saxon.om.Sequence

makeRepeatable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NotationValue

public NotationValue(java.lang.String prefix,
                     java.lang.String uri,
                     java.lang.String localName,
                     boolean check)
              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

check - Used for request checking names against XML 1.0 or XML 1.1 syntax rules

Throws:

XPathException

NotationValue

public NotationValue(java.lang.String prefix,
                     java.lang.String uri,
                     java.lang.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(java.lang.String prefix,
                     java.lang.String uri,
                     java.lang.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

NotationValue

public NotationValue(StructuredQName qName,
                     AtomicType typeLabel)

Constructor

Parameters:

qName - the name as a StructuredQName

typeLabel - idenfies a subtype of xs:QName

Method Detail

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

equals

public boolean equals(java.lang.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:

java.lang.ClassCastException - if they are not comparable

java.lang.IllegalStateException - if the two QNames are in different name pools

getSchemaComparable

public java.lang.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 SequenceTool.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 interface AtomicSequence

Specified by:

getSchemaComparable in class AtomicValue

Returns:

a Comparable that follows XML Schema comparison rules

toString

public java.lang.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