com.sun.xml.xsom
Interface XSSchema

All Superinterfaces:

XSComponent

All Known Implementing Classes:

SchemaImpl

public interface XSSchema
extends XSComponent

Schema. Container of declarations that belong to the same target namespace.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Method Summary

XSAttGroupDecl	getAttGroupDecl(java.lang.String localName)
java.util.Map<java.lang.String,XSAttGroupDecl>	getAttGroupDecls() Gets all the XSAttGroupDecls in this schema.
XSAttributeDecl	getAttributeDecl(java.lang.String localName)
java.util.Map<java.lang.String,XSAttributeDecl>	getAttributeDecls() Gets all the XSAttributeDecls in this schema keyed by their local names.
XSComplexType	getComplexType(java.lang.String localName)
java.util.Map<java.lang.String,XSComplexType>	getComplexTypes() Gets all the XSComplexTypes in this schema.
XSElementDecl	getElementDecl(java.lang.String localName)
java.util.Map<java.lang.String,XSElementDecl>	getElementDecls() Gets all the XSElementDecls in this schema.
XSIdentityConstraint	getIdentityConstraint(java.lang.String localName) Gets the identity constraint of the given name, or null if not found.
java.util.Map<java.lang.String,XSIdentityConstraint>	getIdentityConstraints() Gets all the XSIdentityConstraints in this schema, keyed by their names.
XSModelGroupDecl	getModelGroupDecl(java.lang.String localName)
java.util.Map<java.lang.String,XSModelGroupDecl>	getModelGroupDecls() Gets all the XSModelGroupDecls in this schema.
XSNotation	getNotation(java.lang.String localName)
java.util.Map<java.lang.String,XSNotation>	getNotations() Gets all the XSNotations in this schema.
XSSchemaSet	getRoot() Gets the root schema set that includes this schema.
XSSimpleType	getSimpleType(java.lang.String localName)
java.util.Map<java.lang.String,XSSimpleType>	getSimpleTypes() Gets all the XSSimpleTypes in this schema.
SchemaDocument	getSourceDocument() Deprecated. Since this method always returns null, if you are calling this method from XSSchema and not from XSComponent, there's something wrong with your code.
java.lang.String	getTargetNamespace() Gets the target namespace of the schema.
XSType	getType(java.lang.String localName)
java.util.Map<java.lang.String,XSType>	getTypes() Gets all the XSTypes in this schema (union of getSimpleTypes() and getComplexTypes()
java.util.Iterator<XSAttGroupDecl>	iterateAttGroupDecls()
java.util.Iterator<XSAttributeDecl>	iterateAttributeDecls()
java.util.Iterator<XSComplexType>	iterateComplexTypes()
java.util.Iterator<XSElementDecl>	iterateElementDecls()
java.util.Iterator<XSModelGroupDecl>	iterateModelGroupDecls()
java.util.Iterator<XSNotation>	iterateNotations()
java.util.Iterator<XSSimpleType>	iterateSimpleTypes()
java.util.Iterator<XSType>	iterateTypes()

Methods inherited from interface com.sun.xml.xsom.XSComponent

apply, getAnnotation, getAnnotation, getForeignAttribute, getForeignAttributes, getLocator, getOwnerSchema, select, selectSingle, visit

Method Detail

getTargetNamespace

java.lang.String getTargetNamespace()

Gets the target namespace of the schema.

Returns:

can be empty, but never be null.

getAttributeDecls

java.util.Map<java.lang.String,XSAttributeDecl> getAttributeDecls()

Gets all the XSAttributeDecls in this schema keyed by their local names.

iterateAttributeDecls

java.util.Iterator<XSAttributeDecl> iterateAttributeDecls()

getAttributeDecl

XSAttributeDecl getAttributeDecl(java.lang.String localName)

getElementDecls

java.util.Map<java.lang.String,XSElementDecl> getElementDecls()

Gets all the XSElementDecls in this schema.

iterateElementDecls

java.util.Iterator<XSElementDecl> iterateElementDecls()

getElementDecl

XSElementDecl getElementDecl(java.lang.String localName)

getAttGroupDecls

java.util.Map<java.lang.String,XSAttGroupDecl> getAttGroupDecls()

Gets all the XSAttGroupDecls in this schema.

iterateAttGroupDecls

java.util.Iterator<XSAttGroupDecl> iterateAttGroupDecls()

getAttGroupDecl

XSAttGroupDecl getAttGroupDecl(java.lang.String localName)

getModelGroupDecls

java.util.Map<java.lang.String,XSModelGroupDecl> getModelGroupDecls()

Gets all the XSModelGroupDecls in this schema.

iterateModelGroupDecls

java.util.Iterator<XSModelGroupDecl> iterateModelGroupDecls()

getModelGroupDecl

XSModelGroupDecl getModelGroupDecl(java.lang.String localName)

getTypes

java.util.Map<java.lang.String,XSType> getTypes()

Gets all the XSTypes in this schema (union of getSimpleTypes() and getComplexTypes()

iterateTypes

java.util.Iterator<XSType> iterateTypes()

getType

XSType getType(java.lang.String localName)

getSimpleTypes

java.util.Map<java.lang.String,XSSimpleType> getSimpleTypes()

Gets all the XSSimpleTypes in this schema.

iterateSimpleTypes

java.util.Iterator<XSSimpleType> iterateSimpleTypes()

getSimpleType

XSSimpleType getSimpleType(java.lang.String localName)

getComplexTypes

java.util.Map<java.lang.String,XSComplexType> getComplexTypes()

Gets all the XSComplexTypes in this schema.

iterateComplexTypes

java.util.Iterator<XSComplexType> iterateComplexTypes()

getComplexType

XSComplexType getComplexType(java.lang.String localName)

getNotations

java.util.Map<java.lang.String,XSNotation> getNotations()

Gets all the XSNotations in this schema.

iterateNotations

java.util.Iterator<XSNotation> iterateNotations()

getNotation

XSNotation getNotation(java.lang.String localName)

getIdentityConstraints

java.util.Map<java.lang.String,XSIdentityConstraint> getIdentityConstraints()

Gets all the XSIdentityConstraints in this schema, keyed by their names.

getIdentityConstraint

XSIdentityConstraint getIdentityConstraint(java.lang.String localName)

Gets the identity constraint of the given name, or null if not found.

getSourceDocument

SchemaDocument getSourceDocument()

Deprecated. Since this method always returns null, if you are calling this method from XSSchema and not from XSComponent, there's something wrong with your code.

Sine an XSSchema is not necessarily defined in one schema document (for example one schema can span across many documents through <xs:include>s.), so this method always returns null.

Specified by:

getSourceDocument in interface XSComponent

Returns:

null for components that are built-in to XML Schema, such as anyType, or "empty" XSContentType. This method also returns null for XSSchema. For all other user-defined components this method returns non-null, even if they are local.

getRoot

XSSchemaSet getRoot()

Gets the root schema set that includes this schema.

Specified by:

getRoot in interface XSComponent

Returns:

never null.