public interface

XMLSchemaDescription

implements XMLGrammarDescription
org.apache.xerces.xni.grammars.XMLSchemaDescription
Known Indirect Subclasses

Class Overview

All information specific to XML Schema grammars.

Summary

Constants
short CONTEXT_ATTRIBUTE Indicate that the parse of the current schema document is triggered by the occurrence of an attribute whose namespace is the target namespace of this schema document.
short CONTEXT_ELEMENT Indicate that the parse of the current schema document is triggered by the occurrence of an element whose namespace is the target namespace of this schema document.
short CONTEXT_IMPORT Indicate that the current schema document is <import>ed by another schema document.
short CONTEXT_INCLUDE Indicate that the current schema document is <include>d by another schema document.
short CONTEXT_INSTANCE Indicate that the parse of the current schema document is triggered by xsi:schemaLocation/noNamespaceSchemaLocation attribute(s) in the instance document.
short CONTEXT_PREPARSE Indicate that the current schema document is being preparsed.
short CONTEXT_REDEFINE Indicate that the current schema document is <redefine>d by another schema document.
short CONTEXT_XSITYPE Indicate that the parse of the current schema document is triggered by the occurrence of an "xsi:type" attribute, whose value (a QName) has the target namespace of this schema document as its namespace.
[Expand]
Inherited Constants
From interface org.apache.xerces.xni.grammars.XMLGrammarDescription
Public Methods
abstract XMLAttributes getAttributes()
If a call is triggered by an element/attribute/xsi:type in the instance, this call returns all attributes of such an element (or enclosing element).
abstract short getContextType()
Get the context.
abstract QName getEnclosingElementName()
If a call is triggered by an attribute or xsi:type, then this method returns the enclosing element of such element.
abstract String[] getLocationHints()
For import and references from the instance document, it's possible to have multiple hints for one namespace.
abstract String getTargetNamespace()
If the context is "include" or "redefine", then return the target namespace of the enclosing schema document; otherwise, the expected target namespace of this document.
abstract QName getTriggeringComponent()
If a call is triggered by an element/attribute/xsi:type in the instance, this call returns the name of such triggering component: the name of the element/attribute, or the value of the xsi:type.
[Expand]
Inherited Methods
From interface org.apache.xerces.xni.XMLResourceIdentifier
From interface org.apache.xerces.xni.grammars.XMLGrammarDescription

Constants

public static final short CONTEXT_ATTRIBUTE

Indicate that the parse of the current schema document is triggered by the occurrence of an attribute whose namespace is the target namespace of this schema document. This value is only used if we do defer the loading of schema documents until a component from that namespace is referenced from the instance.

Constant Value: 6 (0x00000006)

public static final short CONTEXT_ELEMENT

Indicate that the parse of the current schema document is triggered by the occurrence of an element whose namespace is the target namespace of this schema document. This value is only used if we do defer the loading of schema documents until a component from that namespace is referenced from the instance.

Constant Value: 5 (0x00000005)

public static final short CONTEXT_IMPORT

Indicate that the current schema document is <import>ed by another schema document.

Constant Value: 2 (0x00000002)

public static final short CONTEXT_INCLUDE

Indicate that the current schema document is <include>d by another schema document.

Constant Value: 0 (0x00000000)

public static final short CONTEXT_INSTANCE

Indicate that the parse of the current schema document is triggered by xsi:schemaLocation/noNamespaceSchemaLocation attribute(s) in the instance document. This value is only used if we don't defer the loading of schema documents.

Constant Value: 4 (0x00000004)

public static final short CONTEXT_PREPARSE

Indicate that the current schema document is being preparsed.

Constant Value: 3 (0x00000003)

public static final short CONTEXT_REDEFINE

Indicate that the current schema document is <redefine>d by another schema document.

Constant Value: 1 (0x00000001)

public static final short CONTEXT_XSITYPE

Indicate that the parse of the current schema document is triggered by the occurrence of an "xsi:type" attribute, whose value (a QName) has the target namespace of this schema document as its namespace. This value is only used if we do defer the loading of schema documents until a component from that namespace is referenced from the instance.

Constant Value: 7 (0x00000007)

Public Methods

public abstract XMLAttributes getAttributes ()

If a call is triggered by an element/attribute/xsi:type in the instance, this call returns all attributes of such an element (or enclosing element).

Returns
  • all attributes of the tiggering/enclosing element

public abstract short getContextType ()

Get the context. The returned value is one of the pre-defined CONTEXT_xxx constants.

Returns
  • the value indicating the context

public abstract QName getEnclosingElementName ()

If a call is triggered by an attribute or xsi:type, then this method returns the enclosing element of such element.

Returns
  • the name of the enclosing element

public abstract String[] getLocationHints ()

For import and references from the instance document, it's possible to have multiple hints for one namespace. So this method returns an array, which contains all location hints.

Returns
  • an array of all location hints associated to the expected target namespace

public abstract String getTargetNamespace ()

If the context is "include" or "redefine", then return the target namespace of the enclosing schema document; otherwise, the expected target namespace of this document.

Returns
  • the expected/enclosing target namespace

public abstract QName getTriggeringComponent ()

If a call is triggered by an element/attribute/xsi:type in the instance, this call returns the name of such triggering component: the name of the element/attribute, or the value of the xsi:type.

Returns
  • the name of the triggering component