public class

XSDDescription

extends XMLResourceIdentifierImpl
implements XMLSchemaDescription
java.lang.Object
   ↳ org.apache.xerces.util.XMLResourceIdentifierImpl
     ↳ org.apache.xerces.impl.xs.XSDDescription

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 ed by another schema document.
short CONTEXT_INCLUDE Indicate that the current schema document is d by another schema document.
short CONTEXT_INITIALIZE Indicate that this description was just initialized.
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 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
From interface org.apache.xerces.xni.grammars.XMLSchemaDescription
Fields
protected XMLAttributes fAttributes
protected short fContextType
protected QName fEnclosedElementName
protected String[] fLocationHints
protected QName fTriggeringComponent
[Expand]
Inherited Fields
From class org.apache.xerces.util.XMLResourceIdentifierImpl
Public Constructors
XSDDescription()
Public Methods
boolean equals(Object descObj)
Compares this grammar with the given grammar.
boolean fromInstance()
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).
short getContextType()
Get the context.
QName getEnclosingElementName()
If a call is triggered by an attribute or xsi:type, then this mehtod returns the enclosing element of such element.
String getGrammarType()
the type of the grammar (e.g., DTD or XSD);
String[] getLocationHints()
For import and references from the instance document, it's possible to have multiple hints for one namespace.
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.
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.
int hashCode()
Returns the hash code of this grammar
XSDDescription makeClone()
void reset()
resets all the fields
void setAttributes(XMLAttributes attributes)
void setContextType(short contextType)
void setEnclosingElementName(QName enclosedElementName)
void setLocationHints(String[] locationHints)
void setTargetNamespace(String targetNamespace)
void setTriggeringComponent(QName triggeringComponent)
[Expand]
Inherited Methods
From class org.apache.xerces.util.XMLResourceIdentifierImpl
From class java.lang.Object
From interface org.apache.xerces.xni.XMLResourceIdentifier
From interface org.apache.xerces.xni.grammars.XMLGrammarDescription
From interface org.apache.xerces.xni.grammars.XMLSchemaDescription

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 ed by another schema document.

Constant Value: 2 (0x00000002)

public static final short CONTEXT_INCLUDE

Indicate that the current schema document is d by another schema document.

Constant Value: 0 (0x00000000)

public static final short CONTEXT_INITIALIZE

Indicate that this description was just initialized.

Constant Value: -1 (0xffffffff)

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 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)

Fields

protected XMLAttributes fAttributes

protected short fContextType

protected QName fEnclosedElementName

protected String[] fLocationHints

protected QName fTriggeringComponent

Public Constructors

public XSDDescription ()

Public Methods

public boolean equals (Object descObj)

Compares this grammar with the given grammar. Currently, we compare the target namespaces.

Parameters
descObj The description of the grammar to be compared with
Returns
  • True if they are equal, else false

public boolean fromInstance ()

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

public short getContextType ()

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

Returns
  • the value indicating the context

public QName getEnclosingElementName ()

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

Returns
  • the name of the enclosing element

public String getGrammarType ()

the type of the grammar (e.g., DTD or XSD);

Returns
  • the type of this grammar
See Also

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

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

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

public int hashCode ()

Returns the hash code of this grammar

Returns
  • The hash code

public XSDDescription makeClone ()

public void reset ()

resets all the fields

public void setAttributes (XMLAttributes attributes)

public void setContextType (short contextType)

public void setEnclosingElementName (QName enclosedElementName)

public void setLocationHints (String[] locationHints)

public void setTargetNamespace (String targetNamespace)

public void setTriggeringComponent (QName triggeringComponent)