FileDocCategorySizeDatePackage
XSDDescription.javaAPI DocJava SE 5 API11230Fri Aug 26 14:55:50 BST 2005com.sun.org.apache.xerces.internal.impl.xs

XSDDescription

public class XSDDescription extends XMLResourceIdentifierImpl implements XMLSchemaDescription

Fields Summary
public static final short
CONTEXT_INITIALIZE
Indicate that this description was just initialized.
public static final short
CONTEXT_INCLUDE
Indicate that the current schema document is d by another schema document.
public static final short
CONTEXT_REDEFINE
Indicate that the current schema document is d by another schema document.
public static final short
CONTEXT_IMPORT
Indicate that the current schema document is ed by another schema document.
public static final short
CONTEXT_PREPARSE
Indicate that the current schema document is being preparsed.
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.
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.
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.
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.
protected short
fContextType
protected String[]
fLocationHints
protected QName
fTriggeringComponent
protected QName
fEnclosedElementName
protected XMLAttributes
fAttributes
Constructors Summary
Methods Summary
public booleanequals(java.lang.Object descObj)
Compares this grammar with the given grammar. Currently, we compare the target namespaces.

param
desc The description of the grammar to be compared with
return
True if they are equal, else false

        if(!(descObj instanceof XMLSchemaDescription)) return false;
        XMLSchemaDescription desc = (XMLSchemaDescription)descObj;
        if (fNamespace != null)
            return fNamespace.equals(desc.getTargetNamespace());
        else // fNamespace == null
            return desc.getTargetNamespace() == null;
    
public booleanfromInstance()

        return fContextType == CONTEXT_ATTRIBUTE ||
               fContextType == CONTEXT_ELEMENT ||
               fContextType == CONTEXT_INSTANCE ||
               fContextType == CONTEXT_XSITYPE;
    
public com.sun.org.apache.xerces.internal.xni.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).

return
all attributes of the tiggering/enclosing element

        return fAttributes;
    
public shortgetContextType()
Get the context. The returned value is one of the pre-defined CONTEXT_xxx constants.

return
the value indicating the context

        return fContextType ;
    
public com.sun.org.apache.xerces.internal.xni.QNamegetEnclosingElementName()
If a call is triggered by an attribute or xsi:type, then this mehtod returns the enclosing element of such element.

return
the name of the enclosing element

        return fEnclosedElementName ;
    
public java.lang.StringgetGrammarType()
the type of the grammar (e.g., DTD or XSD);

see
com.sun.org.apache.xerces.internal.xni.grammars.Grammar

        
                      
       
        return XMLGrammarDescription.XML_SCHEMA;
    
public java.lang.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.

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

        return fLocationHints ;
    
public java.lang.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.

return
the expected/enclosing target namespace

        return fNamespace;
    
public com.sun.org.apache.xerces.internal.xni.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.

return
the name of the triggering component

        return fTriggeringComponent ;
    
public inthashCode()
Returns the hash code of this grammar

return
The hash code

         return (fNamespace == null) ? 0 : fNamespace.hashCode();
    
public com.sun.org.apache.xerces.internal.impl.xs.XSDDescriptionmakeClone()

        XSDDescription desc = new XSDDescription();
        desc.fAttributes = this.fAttributes;
        desc.fBaseSystemId = this.fBaseSystemId;
        desc.fContextType = this.fContextType;
        desc.fEnclosedElementName = this.fEnclosedElementName;
        desc.fExpandedSystemId = this.fExpandedSystemId;
        desc.fLiteralSystemId = this.fLiteralSystemId;
        desc.fLocationHints = this.fLocationHints;
        desc.fPublicId = this.fPublicId;
        desc.fNamespace = this.fNamespace;
        desc.fTriggeringComponent = this.fTriggeringComponent;
        return desc;
    
public voidreset()
resets all the fields

        super.clear();
        fContextType = CONTEXT_INITIALIZE;
        fLocationHints  = null ;
        fTriggeringComponent = null ;
        fEnclosedElementName = null ;
        fAttributes = null ;    
    
public voidsetAttributes(com.sun.org.apache.xerces.internal.xni.XMLAttributes attributes)

        fAttributes = attributes ;    
    
public voidsetContextType(short contextType)

        fContextType = contextType ;
    
public voidsetEnclosingElementName(com.sun.org.apache.xerces.internal.xni.QName enclosedElementName)

        fEnclosedElementName = enclosedElementName ;
    
public voidsetLocationHints(java.lang.String[] locationHints)

        int length = locationHints.length ;
        fLocationHints  = new String[length];
        System.arraycopy(locationHints, 0, fLocationHints, 0, length);
        //fLocationHints = locationHints ;
    
public voidsetTargetNamespace(java.lang.String targetNamespace)

        fNamespace = targetNamespace ;
    
public voidsetTriggeringComponent(com.sun.org.apache.xerces.internal.xni.QName triggeringComponent)

        fTriggeringComponent = triggeringComponent ;