org.apache.xerces.xni.grammars

Interface XMLSchemaDescription

public interface XMLSchemaDescription extends XMLGrammarDescription

All information specific to XML Schema grammars.

Version: $Id: XMLSchemaDescription.java,v 1.4 2005/02/24 05:18:57 mrglavas Exp $

Author: Sandy Gao, IBM

Field Summary
static shortCONTEXT_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.
static shortCONTEXT_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.
static shortCONTEXT_IMPORT
Indicate that the current schema document is <import>ed by another schema document.
static shortCONTEXT_INCLUDE
Indicate that the current schema document is <include>d by another schema document.
static shortCONTEXT_INSTANCE
Indicate that the parse of the current schema document is triggered by xsi:schemaLocation/noNamespaceSchemaLocation attribute(s) in the instance document.
static shortCONTEXT_PREPARSE
Indicate that the current schema document is being preparsed.
static shortCONTEXT_REDEFINE
Indicate that the current schema document is <redefine>d by another schema document.
static shortCONTEXT_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.
Method Summary
XMLAttributesgetAttributes()
If a call is triggered by an element/attribute/xsi:type in the instance, this call returns all attribute of such element (or enclosing element).
shortgetContextType()
Get the context.
QNamegetEnclosingElementName()
If a call is triggered by an attribute or xsi:type, then this method returns the enclosing element of such element.
String[]getLocationHints()
For import and references from the instance document, it's possible to have multiple hints for one namespace.
StringgetTargetNamespace()
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.
QNamegetTriggeringComponent()
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.

Field Detail

CONTEXT_ATTRIBUTE

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.

CONTEXT_ELEMENT

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.

CONTEXT_IMPORT

public static final short CONTEXT_IMPORT
Indicate that the current schema document is <import>ed by another schema document.

CONTEXT_INCLUDE

public static final short CONTEXT_INCLUDE
Indicate that the current schema document is <include>d by another schema document.

CONTEXT_INSTANCE

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.

CONTEXT_PREPARSE

public static final short CONTEXT_PREPARSE
Indicate that the current schema document is being preparsed.

CONTEXT_REDEFINE

public static final short CONTEXT_REDEFINE
Indicate that the current schema document is <redefine>d by another schema document.

CONTEXT_XSITYPE

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.

Method Detail

getAttributes

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

Returns: all attributes of the tiggering/enclosing element

getContextType

public short getContextType()
Get the context. The returned value is one of the pre-defined CONTEXT_xxx constants.

Returns: the value indicating the context

getEnclosingElementName

public 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

getLocationHints

public 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

getTargetNamespace

public 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

getTriggeringComponent

public 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

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.