|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.xqj.SaxonXQItemType
public class SaxonXQItemType
Saxon implementation of the XQJ XQItemType interface
Field Summary |
---|
Fields inherited from interface javax.xml.xquery.XQSequenceType |
---|
OCC_EMPTY, OCC_EXACTLY_ONE, OCC_ONE_OR_MORE, OCC_ZERO_OR_MORE, OCC_ZERO_OR_ONE |
Constructor Summary | |
---|---|
protected |
SaxonXQItemType(ItemType itemType,
Configuration config)
|
protected |
SaxonXQItemType(NodeInfo node)
|
Method Summary | |
---|---|
boolean |
equals(Object obj)
Compares the specified object with this item type for equality. |
int |
getBaseType()
Returns the base type of the item. |
int |
getItemKind()
Returns the kind of the item. |
int |
getItemOccurrence()
Returns the occurrence indicator for the item type. |
XQItemType |
getItemType()
Returns the type of the item in the sequence type. |
QName |
getNodeName()
Returns the name of the node in case the item kind is an XQITEMKIND_DOCUMENT_ELEMENT , XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT ,
XQITEMKIND_ELEMENT , XQITEMKIND_SCHEMA_ELEMENT ,
XQITEMKIND_ATTRIBUTE , or XQITEMKIND_SCHEMA_ATTRIBUTE . |
String |
getPIName()
Returns the name of the processing instruction type. |
URI |
getSchemaURI()
Returns the schema location URI of the schema that contains the item's element or type definition. |
QName |
getTypeName()
Represents a type name (global or local). |
int |
hashCode()
Returns a hash code consistent with the definition of the equals method. |
boolean |
isAnonymousType()
Represents whether the item type is an anonymous type in the schema. |
boolean |
isElementNillable()
Returns whether the element type is nillable or not. |
String |
toString()
Returns a human-readable implementation-defined string representation of the item type. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected SaxonXQItemType(ItemType itemType, Configuration config)
protected SaxonXQItemType(NodeInfo node)
Method Detail |
---|
public int getBaseType() throws XQException
XQItemType
XQBASETYPE_*
constants.
getBaseType
in interface XQItemType
XQBASETYPE_*
constants
indicating the basic type of the item
XQException
- if the item kind is not one of:
XQITEMKIND_DOCUMENT_ELEMENT
,
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
,
XQITEMKIND_ELEMENT
,
XQITEMKIND_SCHEMA_ELEMENT
,
XQITEMKIND_ATTRIBUTE
,
XQITEMKIND_SCHEMA_ATTRIBUTE
, or
XQITEMKIND_ATOMIC
public int getItemKind()
XQItemType
XQITEMKIND_*
constants.
getItemKind
in interface XQItemType
XQITEMKIND_*
constants
indicating the basic kind of the itempublic int getItemOccurrence()
XQItemType
XQSequenceType.OCC_EXACTLY_ONE
.
getItemOccurrence
in interface XQItemType
getItemOccurrence
in interface XQSequenceType
public QName getNodeName() throws XQException
XQItemType
XQITEMKIND_DOCUMENT_ELEMENT
, XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
,
XQITEMKIND_ELEMENT
, XQITEMKIND_SCHEMA_ELEMENT
,
XQITEMKIND_ATTRIBUTE
, or XQITEMKIND_SCHEMA_ATTRIBUTE
.
For example, in the case of a type for element "foo"
this will return the QName foo
. For wildcard entries a
null
value will be returned.
getNodeName
in interface XQItemType
QName
for the name of the element,
attribute, or document element node. null
if it is a wildcard
XQException
- if the item kind is not one of:
XQITEMKIND_DOCUMENT_ELEMENT
,
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
,
XQITEMKIND_ELEMENT
,
XQITEMKIND_SCHEMA_ELEMENT
,
XQITEMKIND_ATTRIBUTE
, or
XQITEMKIND_SCHEMA_ATTRIBUTE
public String getPIName() throws XQException
XQItemType
XQItemType
must be XQITEMKIND_PI
.
getPIName
in interface XQItemType
null
if it is a wildcard
XQException
- if the item kind is not XQITEMKIND_PI
public URI getSchemaURI()
XQItemType
null
value if it does
not support retrieving the schema location URI.
If the item corresponds to a validated global element in a schema,
the result will be the schema location URI to the XMLSchema containing
the element definition. Otherwise if the item is a schema validated
node, the result will be the schema location URI of the XMLSchema
containing the type definition of that node. If the item is not schema
validated, the result is null
getSchemaURI
in interface XQItemType
URI
representing the schema
location URI of the XMLSchema containing the
global element definition or the type definition
of the current item. null
in case
the item is not schema validated or if the
implementation does not support retrieving the
schema URI.public String toString()
XQItemType
toString
in interface XQItemType
toString
in interface XQSequenceType
toString
in class Object
public QName getTypeName() throws XQException
XQItemType
QName
. If the return type is an
anonymous type, the actual QName
value returned is implementation
defined.
getTypeName
in interface XQItemType
QName
of the schema type in case of a
user defined or anonoymous types. For a built-in type,
returns a predefined type name as QName
(e.g.xs:anyType
, xs:decimal
,
etc). Cannot be null
XQException
- if the item kind is not one of:
XQITEMKIND_DOCUMENT_ELEMENT
,
XQITEMKIND_DOCUMENT_SCHEMA_ELEMENT
,
XQITEMKIND_ATOMIC
,
XQITEMKIND_ELEMENT
,
XQITEMKIND_SCHEMA_ELEMENT
,
XQITEMKIND_ATTRIBUTE
, or
XQITEMKIND_SCHEMA_ATTRIBUTE
public boolean isAnonymousType()
XQItemType
isAnonymousType
in interface XQItemType
true
if the item type is an anonymous
type in the schema, false
otherwisepublic boolean isElementNillable()
XQItemType
isElementNillable
in interface XQItemType
true
if the element type is nillable,
false
otherwisepublic XQItemType getItemType()
XQSequenceType
getItemType
in interface XQSequenceType
XQItemType
representing the
item type in the sequence. null
is returned in case of an empty sequence.public boolean equals(Object obj)
XQItemType
true
only if the argument is an item type object which
represents the same XQuery item type.
equals
and
hashCode
across different implementations the following
algorithm must be used. Return true
if and only if both
objects are XQItemType
and:
getItemKind()
is equalgetBaseType()
is supported for
the item kind, it must be equalgetNodeName()
is supported for
the item kind, it must be equalgetSchemaURI()
is equalgetTypeName()
is supported for
the item kind, it must be equalisAnonymousType()
is equalisElementNillable()
is equalgetPIName()
is supported for the
item kind, it must be equal
equals
in interface XQItemType
equals
in interface XQSequenceType
equals
in class Object
obj
- an XQItemType
object representing an XQuery
item type
true
if the input item type object represents
the same XQuery item type, false
otherwisepublic int hashCode()
XQItemType
equals
and
hashCode
across different implementations the following
algorithm must be used:
hashCode = this.getItemKind(); if this.getSchemaURI != null hashCode = 31*hashCode + this.getSchemaURI().hashCode(); if this.getBaseType() is supported for the item kind hashCode = 31*hashCode + this.getbaseType(); if this.getNodeName () is supported for the item kind and this.getNodeName() != null hashCode = 31*hashCode + this.getNodeName().hashCode() if this.getTypeName () is supported for the item kind hashCode = 31*hashCode + this.getTypeName().hashCode(); if this.getPIName () is supported for the item kind and this.getPIName () != null hashCode = 31*hashCode + this.getPIName().hashCode();
hashCode
in interface XQItemType
hashCode
in interface XQSequenceType
hashCode
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |