net.sf.saxon.value

Class QualifiedNameValue

Implemented Interfaces:
ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, Serializable, ValueRepresentation
Known Direct Subclasses:
NotationValue, QNameValue

public abstract class QualifiedNameValue
extends AtomicValue

A qualified name: this is an abstract superclass for QNameValue and NotationValue, representing the XPath primitive types xs:QName and xs:NOTATION respectively

Field Summary

protected StructuredQName
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

Method Summary

int
allocateNameCode(NamePool pool)
Allocate a nameCode for this QName in the NamePool
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
String
getClarkName()
Get the name in Clark notation, that is "{uri}local" if in a namespace, or "local" otherwise
String
getLocalName()
Get the local part
String
getNamespaceURI()
Get the namespace part.
String
getPrefix()
Get the prefix.
String
getStringValue()
Get the string value as a String.
Object
getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value.
int
hashCode()
static AtomicValue
makeQName(String prefix, String uri, String local, AtomicType targetType, CharSequence lexicalForm, Configuration config)
Factory method to construct either a QName or a NOTATION value, or a subtype of either of these.
Object
makeQName(Configuration config)
Temporary method to construct a javax.xml.namespace.QName without actually mentioning it by name (because the class is not available in JDK 1.4)
String
toString()
The toString() method returns the name in the form QName("uri", "local")

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

Field Details

qName

protected StructuredQName qName

Method Details

allocateNameCode

public int allocateNameCode(NamePool pool)
Allocate a nameCode for this QName in the NamePool
Parameters:
pool - the NamePool to be used
Returns:
the allocated nameCode

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface Value

getClarkName

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

getLocalName

public final String getLocalName()
Get the local part

getNamespaceURI

public final String getNamespaceURI()
Get the namespace part. Returns the empty string for a name in no namespace.

getPrefix

public final String getPrefix()
Get the prefix. Returns the empty string if the name is unprefixed.

getStringValue

public final String getStringValue()
Get the string value as a String. Returns the QName as a lexical QName, retaining the original prefix if available.
Specified by:
getStringValue in interface Item
getStringValue in interface ValueRepresentation
Overrides:
getStringValue in interface AtomicValue

getXPathComparable

public Object getXPathComparable(boolean ordered,
                                 StringCollator collator,
                                 XPathContext context)
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.
Overrides:
getXPathComparable in interface AtomicValue
Parameters:
ordered - true if an ordered comparison is required. In this case the result is null if the type is unordered; in other cases the returned value will be a Comparable.
collator -
context - the XPath dynamic evaluation context, used in cases where the comparison is context sensitive @return 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

hashCode

public int hashCode()

makeQName

public static AtomicValue makeQName(String prefix,
                                    String uri,
                                    String local,
                                    AtomicType targetType,
                                    CharSequence lexicalForm,
                                    Configuration config)
            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
config - the Saxon configuration
Returns:
the converted value
Throws:
XPathException - if the value cannot be converted.

makeQName

public Object makeQName(Configuration config)
Temporary method to construct a javax.xml.namespace.QName without actually mentioning it by name (because the class is not available in JDK 1.4)

toString

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