net.sf.saxon.value

Class NotationValue

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

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 class net.sf.saxon.value.Value

EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

NotationValue(String prefix, String uri, String localName)
Constructor for a value that is known to be valid
NotationValue(String prefix, String uri, String localName, NameChecker checker)
Constructor
NotationValue(String prefix, String uri, String localName, AtomicType typeLabel)
Constructor for a value that is known to be valid

Method Summary

ConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
AtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
boolean
equals(Object other)
Determine if two Notation values are equal.
BuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.
Comparable
getSchemaComparable()
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
String
toString()
The toString() method returns the name in the form QName("uri", "local")

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

allocateNameCode, convertToJava, getClarkName, getLocalName, getNamespaceURI, getPrefix, getStringValue, getXPathComparable, hashCode, makeQName, makeQName, toString

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

asAtomic, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

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

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Constructor Details

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,
                     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

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

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
Convert to target data type
Overrides:
convertPrimitive in interface AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
context - The XPath dynamic context
Returns:
an AtomicValue, a value of the required type; or an ErrorValue

copyAsSubType

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

equals

public boolean equals(Object other)
Determine if two Notation values are equal. This comparison ignores the prefix part of the value.
Overrides:
equals in interface AtomicValue

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.
Overrides:
getPrimitiveType in interface AtomicValue

getSchemaComparable

public Comparable getSchemaComparable()
Overrides:
getSchemaComparable in interface 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 interface QualifiedNameValue
Returns:
the name in Clark notation: {uri}local