oracle.xml.xquery

Class OXQEntityLocator

java.lang.Object

oracle.xml.xquery.OXQEntityLocator

public abstract class OXQEntityLocator
extends java.lang.Object

The location of an entity to be resolved. The locator provides location attributes common to most entities. The semantics and availability of the attributes depend on the kind of entity that is being resolved.

Since:

12.1

See Also:

OXQEntityResolver

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Object	getExtension() Gets extended location information about the entity.
abstract java.lang.String	getNamespace() Gets the namespace of the entity.
abstract java.net.URI	getNamespaceAsURI() Retrieves the namespace of the entity as an instance of java.net.URI.
abstract java.lang.String	getPublicId() Gets the public identifier of the entity.
abstract java.net.URI	getPublicIdAsURI() Retrieves the public identifier of the entity as an instance of java.net.URI.
abstract java.lang.String	getSystemId() Gets the system identifier of the entity.
abstract java.net.URI	getSystemIdAsURI() Retrieves the system identifier of the entity as an instance of java.net.URI.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNamespace

public abstract java.lang.String getNamespace()

Gets the namespace of the entity. The following table describes what this will return for the standard entity kinds:

Standard entity kind	Value
MODULE	The target namespace of the module if the location is not specified in the import statement, otherwise null.
SCHEMA	The target namespace of the schema if the location is not specified in the import statement, otherwise null.
DOCUMENT_TYPE	null
DOCUMENT	null
COLLECTION	null
URI_COLLECTION	null
XML_ENTITY	The namespace of the entity to resolve.
EXTERNAL_FUNCTION	null
UPD_PUT	null
XML_PARSER_FACTORY	null
DOM_FACTORY	null
COLLATION	null
TEXT	null
ENVIRONMENT_VARIABLE	null

Returns:

the namespace of the entity

getNamespaceAsURI

public abstract java.net.URI getNamespaceAsURI()

Retrieves the namespace of the entity as an instance of java.net.URI.

Returns:

namespace URI. null if it was not set or couldn't be converted to java.net.URI

getSystemId

public abstract java.lang.String getSystemId()

Gets the system identifier of the entity. The following table describes what this will return for the standard entity kinds:

Standard entity kind	Value
MODULE	The absolute URI specified as location hint in the XQuery module import or null if no location hint was given. Note, the resolver will be called once per location hint if more than one was specified. The returned URI never contains a fragment component.
SCHEMA	The absolute URI specified as location hint in the XQuery schema import or null if no location hint was given. Note, the resolver will be called once per location hint if more than one was specified. The returned URI never contains a fragment component.
DOCUMENT_TYPE	The absolute URI that identifies the document, or null if the URI cannot be computed during static analysis phase.
DOCUMENT	The absolute URI that identifies the document.
COLLECTION	The absolute URI that identifies the collection.
URI_COLLECTION	The absolute URI that identifies the URI collection.
XML_ENTITY	The system identifier of the external entity being referenced.
EXTERNAL_FUNCTION	null
UPD_PUT	The absolute URI passed to the fn:put function.
XML_PARSER_FACTORY	null
DOM_FACTORY	null
COLLATION	The absolute URI that identifies the collation.
TEXT	The absolute URI that identifies the text resource.
ENVIRONMENT_VARIABLE	The name of the environment variable which value is requested by fn:environment-variable or null if names of all available environment variables are requested (by fn:available-environment-variables)

Returns:

the system identifier of the entity

getSystemIdAsURI

public abstract java.net.URI getSystemIdAsURI()

Retrieves the system identifier of the entity as an instance of java.net.URI.

Returns:

system identifier URI. null if it was not set or couldn't be converted to java.net.URI

getPublicId

public abstract java.lang.String getPublicId()

Gets the public identifier of the entity. The following table describes what this will return for the standard entity kinds:

Standard entity kind	Value
MODULE	null
SCHEMA	null
DOCUMENT_TYPE	null
DOCUMENT	null
COLLECTION	null
URI_COLLECTION	null
XML_ENTITY	The public identifier of the external entity being referenced, or null if none was supplied.
EXTERNAL_FUNCTION	null
UPD_PUT	null
XML_PARSER_FACTORY	null
DOM_FACTORY	null
COLLATION	null
TEXT	null
ENVIRONMENT_VARIABLE	null

Returns:

the public identifier of the entity

getPublicIdAsURI

public abstract java.net.URI getPublicIdAsURI()

Retrieves the public identifier of the entity as an instance of java.net.URI.

Returns:

public identifier URI. null if it was not set or couldn't be converted to java.net.URI

getExtension

public abstract java.lang.Object getExtension()

Gets extended location information about the entity. Certain entity kinds may require this additional information in order for a resolver to locate them. The following table describes what this will return for the standard entity kinds:

Standard entity kind	Value
MODULE	null
SCHEMA	null
DOCUMENT_TYPE	null
DOCUMENT	null
COLLECTION	null
URI_COLLECTION	null
XML_ENTITY	null
EXTERNAL_FUNCTION	OXQFunctionMetaData
UPD_PUT	null
XML_PARSER_FACTORY	null
DOM_FACTORY	null
COLLATION	null
TEXT	null
ENVIRONMENT_VARIABLE	null

Returns:

the locator extension