|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.basex.api.xqj.BXQItemType
public final class BXQItemType
Java XQuery API - Item type.
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 | |
---|---|
BXQItemType(int b)
Constructor. |
|
BXQItemType(Type t)
Constructor. |
|
BXQItemType(Type t,
javax.xml.namespace.QName n,
int b)
Constructor. |
|
BXQItemType(Type t,
javax.xml.namespace.QName n,
int b,
int o)
Constructor. |
Method Summary | |
---|---|
int |
getBaseType()
Returns the basic pre-defined 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. |
javax.xml.namespace.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 . |
java.lang.String |
getPIName()
Returns the name of the processing instruction type. |
java.net.URI |
getSchemaURI()
Returns the schema location URI of the schema that contains the item's element or type definition. |
Type |
getType()
Returns the item type. |
javax.xml.namespace.QName |
getTypeName()
Represents a type name (global or local). |
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. |
java.lang.String |
toString()
Returns a human-readable implementation-defined string representation of the item type. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.xml.xquery.XQItemType |
---|
equals, hashCode |
Constructor Detail |
---|
public BXQItemType(int b) throws org.basex.api.xqj.BXQException
b
- item type
BXQException
- exceptionpublic BXQItemType(Type t)
t
- typepublic BXQItemType(Type t, javax.xml.namespace.QName n, int b)
t
- typen
- nameb
- base typepublic BXQItemType(Type t, javax.xml.namespace.QName n, int b, int o)
t
- typen
- nameb
- base typeo
- occurrenceMethod Detail |
---|
public int getBaseType() throws org.basex.api.xqj.BXQException
XQItemType
XQBASETYPE_*
constants.
getBaseType
in interface XQItemType
XQBASETYPE_*
constants
indicating the basic type of the item
org.basex.api.xqj.BXQException
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 javax.xml.namespace.QName getNodeName() throws org.basex.api.xqj.BXQException
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
org.basex.api.xqj.BXQException
public java.lang.String getPIName() throws org.basex.api.xqj.BXQException
XQItemType
XQItemType
must be XQITEMKIND_PI
.
getPIName
in interface XQItemType
null
if it is a wildcard
org.basex.api.xqj.BXQException
public java.net.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 Type getType()
public javax.xml.namespace.QName getTypeName() throws org.basex.api.xqj.BXQException
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
org.basex.api.xqj.BXQException
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 java.lang.String toString()
XQItemType
toString
in interface XQItemType
toString
in interface XQSequenceType
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |