org.apache.xerces.impl.xs

Class SchemaGrammar

public class SchemaGrammar extends Object implements XSGrammar, XSNamespaceItem

This class is to hold all schema component declaration that are declared within one namespace. The Grammar class this class extends contains what little commonality there is between XML Schema and DTD grammars. It's useful to distinguish grammar objects from other kinds of object when they exist in pools or caches.

INTERNAL:: Usage of this class is not supported. It may be altered or removed at any time.

Version: $Id: SchemaGrammar.java,v 1.42 2004/12/15 23:48:48 mrglavas Exp $

Author: Sandy Gao, IBM Elena Litani, IBM

Nested Class Summary
static class	SchemaGrammar.BuiltinSchemaGrammar
static class	SchemaGrammar.Schema4Annotations A partial schema for schemas for validating annotations. INTERNAL: Usage of this class is not supported.

Field Summary
static XSSimpleType	fAnySimpleType
static XSComplexTypeDecl	fAnyType
static SchemaGrammar.Schema4Annotations	SG_Schema4Annotations
static SchemaGrammar.BuiltinSchemaGrammar	SG_SchemaNS
static SchemaGrammar.BuiltinSchemaGrammar	SG_XSI

Constructor Summary
protected	SchemaGrammar()
	SchemaGrammar(String targetNamespace, XSDDescription grammarDesc, SymbolTable symbolTable) Default constructor.

Method Summary
void	addAnnotation(XSAnnotationImpl annotation)
void	addComplexTypeDecl(XSComplexTypeDecl decl, SimpleLocator locator) add one complex type decl: for later constraint checking
void	addDocument(Object document, String location)
void	addGlobalAttributeDecl(XSAttributeDecl decl) register one global attribute
void	addGlobalAttributeGroupDecl(XSAttributeGroupDecl decl) register one global attribute group
void	addGlobalElementDecl(XSElementDecl decl) register one global element
void	addGlobalGroupDecl(XSGroupDecl decl) register one global group
void	addGlobalNotationDecl(XSNotationDecl decl) register one global notation
void	addGlobalTypeDecl(XSTypeDefinition decl) register one global type
void	addIDConstraintDecl(XSElementDecl elmDecl, IdentityConstraint decl) register one identity constraint
void	addRedefinedGroupDecl(XSGroupDecl derived, XSGroupDecl base, SimpleLocator locator) add a group redefined by restriction: for later constraint checking
XSObjectList	getAnnotations()
XSAttributeDeclaration	getAttributeDeclaration(String name) Convenience method.
XSAttributeGroupDefinition	getAttributeGroup(String name) Convenience method.
XSNamedMap	getComponents(short objectType) [schema components]: a list of top-level components, i.e. element declarations, attribute declarations, etc.
StringList	getDocumentLocations() [document location]
XSElementDeclaration	getElementDeclaration(String name) Convenience method.
XSAttributeDecl	getGlobalAttributeDecl(String declName) get one global attribute
XSAttributeGroupDecl	getGlobalAttributeGroupDecl(String declName) get one global attribute group
XSElementDecl	getGlobalElementDecl(String declName) get one global element
XSGroupDecl	getGlobalGroupDecl(String declName) get one global group
XSNotationDecl	getGlobalNotationDecl(String declName) get one global notation
XSTypeDefinition	getGlobalTypeDecl(String declName) get one global type
XMLGrammarDescription	getGrammarDescription()
IdentityConstraint	getIDConstraintDecl(String declName) get one identity constraint
Vector	getImportedGrammars()
XSModelGroupDefinition	getModelGroupDefinition(String name) Convenience method.
XSNotationDeclaration	getNotationDeclaration(String name) Convenience method.
String	getSchemaNamespace() [schema namespace]
String	getTargetNamespace() Returns this grammar's target namespace.
XSTypeDefinition	getTypeDefinition(String name) Convenience method.
boolean	hasIDConstraints() get one identity constraint
boolean	isNamespaceAware()
void	setImportedGrammars(Vector importedGrammars)
XSModel	toXSModel() Return an `XSModel` that represents components in this schema grammar.
XSModel	toXSModel(XSGrammar[] grammars)

Field Detail

fAnySimpleType

public static final XSSimpleType fAnySimpleType

fAnyType

public static final XSComplexTypeDecl fAnyType

SG_Schema4Annotations

public static final SchemaGrammar.Schema4Annotations SG_Schema4Annotations

SG_SchemaNS

public static final SchemaGrammar.BuiltinSchemaGrammar SG_SchemaNS

SG_XSI

public static final SchemaGrammar.BuiltinSchemaGrammar SG_XSI

Constructor Detail

SchemaGrammar

protected SchemaGrammar()

SchemaGrammar

public SchemaGrammar(String targetNamespace, XSDDescription grammarDesc, SymbolTable symbolTable)

Default constructor.

Parameters: targetNamespace grammarDesc the XMLGrammarDescription corresponding to this objec at the least a systemId should always be known. symbolTable needed for annotation support

Method Detail

addAnnotation

public void addAnnotation(XSAnnotationImpl annotation)

addComplexTypeDecl

public void addComplexTypeDecl(XSComplexTypeDecl decl, SimpleLocator locator)

add one complex type decl: for later constraint checking

addDocument

public void addDocument(Object document, String location)

addGlobalAttributeDecl

public void addGlobalAttributeDecl(XSAttributeDecl decl)

addGlobalAttributeGroupDecl

public void addGlobalAttributeGroupDecl(XSAttributeGroupDecl decl)

addGlobalElementDecl

public void addGlobalElementDecl(XSElementDecl decl)

addGlobalGroupDecl

public void addGlobalGroupDecl(XSGroupDecl decl)

addGlobalNotationDecl

public void addGlobalNotationDecl(XSNotationDecl decl)

addGlobalTypeDecl

public void addGlobalTypeDecl(XSTypeDefinition decl)

addIDConstraintDecl

public final void addIDConstraintDecl(XSElementDecl elmDecl, IdentityConstraint decl)

addRedefinedGroupDecl

public void addRedefinedGroupDecl(XSGroupDecl derived, XSGroupDecl base, SimpleLocator locator)

add a group redefined by restriction: for later constraint checking

getAnnotations

public XSObjectList getAnnotations()

See Also: org.apache.xerces.xs.XSNamespaceItem#getAnnotations()

getAttributeDeclaration

public XSAttributeDeclaration getAttributeDeclaration(String name)

Convenience method. Returns a top-level attribute declaration.

Parameters: name The name of the declaration.

Returns: A top-level attribute declaration or null if such declaration does not exist.

getAttributeGroup

public XSAttributeGroupDefinition getAttributeGroup(String name)

Convenience method. Returns a top-level attribute group definition.

Parameters: name The name of the definition.

Returns: A top-level attribute group definition or null if such definition does not exist.

getComponents

public XSNamedMap getComponents(short objectType)

[schema components]: a list of top-level components, i.e. element declarations, attribute declarations, etc.

Parameters: objectType The type of the declaration, i.e. ELEMENT_DECLARATION. Note that XSTypeDefinition.SIMPLE_TYPE and XSTypeDefinition.COMPLEX_TYPE can also be used as the objectType to retrieve only complex types or simple types, instead of all types.

Returns: A list of top-level definition of the specified type in objectType or an empty XSNamedMap if no such definitions exist.