org.apache.xerces.impl.xs

Class XSDDescription

Implemented Interfaces:
org.apache.xerces.xni.XMLResourceIdentifier, org.apache.xerces.xni.grammars.XMLSchemaDescription

public class XSDDescription
extends XMLResourceIdentifierImpl
implements org.apache.xerces.xni.grammars.XMLSchemaDescription

All information specific to XML Schema grammars.
Version:
$Id: XSDDescription.java 320107 2004-10-14 03:49:33Z mrglavas $
Authors:
Neil Graham, IBM
Neeraj Bajaj, SUN Microsystems.

Field Summary

static 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.
static 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.
static short
CONTEXT_IMPORT
Indicate that the current schema document is ed by another schema document.
static short
CONTEXT_INCLUDE
Indicate that the current schema document is d by another schema document.
static short
CONTEXT_INITIALIZE
Indicate that this description was just initialized.
static short
CONTEXT_INSTANCE
Indicate that the parse of the current schema document is triggered by xsi:schemaLocation/noNamespaceSchemaLocation attribute(s) in the instance document.
static short
CONTEXT_PREPARSE
Indicate that the current schema document is being preparsed.
static short
CONTEXT_REDEFINE
Indicate that the current schema document is d by another schema document.
static 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.
protected org.apache.xerces.xni.XMLAttributes
fAttributes
protected short
fContextType
protected org.apache.xerces.xni.QName
fEnclosedElementName
protected String[]
fLocationHints
protected org.apache.xerces.xni.QName
fTriggeringComponent

Fields inherited from class org.apache.xerces.util.XMLResourceIdentifierImpl

fBaseSystemId, fExpandedSystemId, fLiteralSystemId, fNamespace, fPublicId

Fields inherited from interface org.apache.xerces.xni.grammars.XMLSchemaDescription

CONTEXT_ATTRIBUTE, CONTEXT_ELEMENT, CONTEXT_IMPORT, CONTEXT_INCLUDE, CONTEXT_INSTANCE, CONTEXT_PREPARSE, CONTEXT_REDEFINE, CONTEXT_XSITYPE

Method Summary

boolean
equals(Object descObj)
Compares this grammar with the given grammar.
boolean
fromInstance()
org.apache.xerces.xni.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.
org.apache.xerces.xni.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.
org.apache.xerces.xni.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(org.apache.xerces.xni.XMLAttributes attributes)
void
setContextType(short contextType)
void
setEnclosingElementName(org.apache.xerces.xni.QName enclosedElementName)
void
setLocationHints(String[] locationHints)
void
setTargetNamespace(String targetNamespace)
void
setTriggeringComponent(org.apache.xerces.xni.QName triggeringComponent)

Methods inherited from class org.apache.xerces.util.XMLResourceIdentifierImpl

clear, getBaseSystemId, getExpandedSystemId, getLiteralSystemId, getNamespace, getPublicId, hashCode, setBaseSystemId, setExpandedSystemId, setLiteralSystemId, setNamespace, setPublicId, setValues, setValues, toString

Field Details

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.
Field Value:
6

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.
Field Value:
5

CONTEXT_IMPORT

public static final short CONTEXT_IMPORT
Indicate that the current schema document is ed by another schema document.
Field Value:
2

CONTEXT_INCLUDE

public static final short CONTEXT_INCLUDE
Indicate that the current schema document is d by another schema document.
Field Value:
0

CONTEXT_INITIALIZE

public static final short CONTEXT_INITIALIZE
Indicate that this description was just initialized.
Field Value:
-1

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.
Field Value:
4

CONTEXT_PREPARSE

public static final short CONTEXT_PREPARSE
Indicate that the current schema document is being preparsed.
Field Value:
3

CONTEXT_REDEFINE

public static final short CONTEXT_REDEFINE
Indicate that the current schema document is d by another schema document.
Field Value:
1

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.
Field Value:
7

fAttributes

protected org.apache.xerces.xni.XMLAttributes fAttributes

fContextType

protected short fContextType

fEnclosedElementName

protected org.apache.xerces.xni.QName fEnclosedElementName

fLocationHints

protected String[] fLocationHints

fTriggeringComponent

protected org.apache.xerces.xni.QName fTriggeringComponent

Method Details

equals

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

fromInstance

public boolean fromInstance()

getAttributes

public org.apache.xerces.xni.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).
Specified by:
getAttributes in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
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.
Specified by:
getContextType in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
Returns:
the value indicating the context

getEnclosingElementName

public org.apache.xerces.xni.QName getEnclosingElementName()
If a call is triggered by an attribute or xsi:type, then this mehtod returns the enclosing element of such element.
Specified by:
getEnclosingElementName in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
Returns:
the name of the enclosing element

getGrammarType

public String getGrammarType()
the type of the grammar (e.g., DTD or XSD);
Specified by:
getGrammarType in interface org.apache.xerces.xni.grammars.XMLGrammarDescription
See Also:
org.apache.xerces.xni.grammars.Grammar

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.
Specified by:
getLocationHints in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
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.
Specified by:
getTargetNamespace in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
Returns:
the expected/enclosing target namespace

getTriggeringComponent

public org.apache.xerces.xni.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.
Specified by:
getTriggeringComponent in interface org.apache.xerces.xni.grammars.XMLSchemaDescription
Returns:
the name of the triggering component

hashCode

public int hashCode()
Returns the hash code of this grammar
Overrides:
hashCode in interface XMLResourceIdentifierImpl
Returns:
The hash code

makeClone

public XSDDescription makeClone()

reset

public void reset()
resets all the fields

setAttributes

public void setAttributes(org.apache.xerces.xni.XMLAttributes attributes)

setContextType

public void setContextType(short contextType)

setEnclosingElementName

public void setEnclosingElementName(org.apache.xerces.xni.QName enclosedElementName)

setLocationHints

public void setLocationHints(String[] locationHints)

setTargetNamespace

public void setTargetNamespace(String targetNamespace)

setTriggeringComponent

public void setTriggeringComponent(org.apache.xerces.xni.QName triggeringComponent)

Copyright B) 1999-2006 The Apache Software Foundation. All Rights Reserved.