public enum OXQEntityKind extends java.lang.Enum<OXQEntityKind>
resolved
. The enumeration provides entity kinds for the common types of entities: modules, schemas, collections, documents, xml entities, and external functions. A user may control how the XQuery processor obtains these resources by implementing a custom OXQEntityResolver
.OXQEntityResolver
Enum Constant and Description |
---|
COLLATION
The kind used to obtain a collation.
|
COLLECTION
The kind used to obtain the documents that comprise a collection (used when there is a call to
fn:collection ). |
DOCUMENT
The kind used to obtain a document for the
fn:doc or fn:collection function. |
DOCUMENT_TYPE
The kind used to obtain a document type for the
fn:doc function. |
DOM_FACTORY
The kind used to obtain an implementation of the DOM factory:
javax.xml.parsers.DocumentBuilderFactory |
ENVIRONMENT_VARIABLE
The kind used to obtain environment variable names and values for
fn:available-environment-variables and fn:environment-variable functions. |
EXTERNAL_FUNCTION
The kind used to obtain an external function binding.
|
MODULE
The kind used to resolve an XQuery module import.
|
SCHEMA
The kind used to resolve an XML Schema import.
|
TEXT
The kind used to obtain unparsed text for the
fn:unparsed-text function. |
UPD_PUT
The kind used to obtain an implementation for the
fn:put function. |
URI_COLLECTION
The kind used to obtain the URIs that will be returned by a call to
fn:uri-collection . |
XML_ENTITY
The kind used when an internal XML parser needs to resolve an XML resource.
|
XML_PARSER_FACTORY
The kind used to obtain an implementation of the StAX parser factory:
XMLInputFactory |
Modifier and Type | Method and Description |
---|---|
static OXQEntityKind |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static OXQEntityKind[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared.
|
public static final OXQEntityKind MODULE
OXQEntityResolver
may return one or more modules.public static final OXQEntityKind SCHEMA
OXQEntityResolver
may return one or more schemas.public static final OXQEntityKind DOCUMENT_TYPE
fn:doc
function.public static final OXQEntityKind DOCUMENT
fn:doc
or fn:collection
function. In the case of fn:collection
, it is used for each document in the collection.public static final OXQEntityKind COLLECTION
fn:collection
).public static final OXQEntityKind URI_COLLECTION
fn:uri-collection
.public static final OXQEntityKind XML_ENTITY
public static final OXQEntityKind EXTERNAL_FUNCTION
public static final OXQEntityKind UPD_PUT
fn:put
function. (more precisely, the put primitive)public static final OXQEntityKind XML_PARSER_FACTORY
XMLInputFactory
public static final OXQEntityKind DOM_FACTORY
javax.xml.parsers.DocumentBuilderFactory
public static final OXQEntityKind COLLATION
public static final OXQEntityKind TEXT
fn:unparsed-text
function.public static final OXQEntityKind ENVIRONMENT_VARIABLE
fn:available-environment-variables
and fn:environment-variable
functions.public static OXQEntityKind[] values()
for (OXQEntityKind c : OXQEntityKind.values()) System.out.println(c);
public static OXQEntityKind valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null