Package 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 ([email protected])

Method Summary

Modifier and Type	Method	Description
XSAttGroupDecl	getAttGroupDecl(String localName)
Map<String,XSAttGroupDecl>	getAttGroupDecls()	Gets all the XSAttGroupDecls in this schema.
XSAttributeDecl	getAttributeDecl(String localName)
Map<String,XSAttributeDecl>	getAttributeDecls()	Gets all the XSAttributeDecls in this schema keyed by their local names.
XSComplexType	getComplexType(String localName)
Map<String,XSComplexType>	getComplexTypes()	Gets all the XSComplexTypes in this schema.
XSElementDecl	getElementDecl(String localName)
Map<String,XSElementDecl>	getElementDecls()	Gets all the XSElementDecls in this schema.
XSIdentityConstraint	getIdentityConstraint(String localName)	Gets the identity constraint of the given name, or null if not found.
Map<String,XSIdentityConstraint>	getIdentityConstraints()	Gets all the XSIdentityConstraints in this schema, keyed by their names.
XSModelGroupDecl	getModelGroupDecl(String localName)
Map<String,XSModelGroupDecl>	getModelGroupDecls()	Gets all the XSModelGroupDecls in this schema.
XSNotation	getNotation(String localName)
Map<String,XSNotation>	getNotations()	Gets all the XSNotations in this schema.
XSSchemaSet	getRoot()	Gets the root schema set that includes this schema.
XSSimpleType	getSimpleType(String localName)
Map<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 and not from XSComponent, there's something wrong with your code.
String	getTargetNamespace()	Gets the target namespace of the schema.
XSType	getType(String localName)
Map<String,XSType>	getTypes()	Gets all the XSTypes in this schema (union of getSimpleTypes() and getComplexTypes()
Iterator<XSAttGroupDecl>	iterateAttGroupDecls()
Iterator<XSAttributeDecl>	iterateAttributeDecls()
Iterator<XSComplexType>	iterateComplexTypes()
Iterator<XSElementDecl>	iterateElementDecls()
Iterator<XSModelGroupDecl>	iterateModelGroupDecls()
Iterator<XSNotation>	iterateNotations()
Iterator<XSSimpleType>	iterateSimpleTypes()
Iterator<XSType>	iterateTypes()

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

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

Method Details

getTargetNamespace

String getTargetNamespace()

Gets the target namespace of the schema.

Returns:

can be empty, but never be null.

getAttributeDecls

Map<String,XSAttributeDecl> getAttributeDecls()

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

iterateAttributeDecls

Iterator<XSAttributeDecl> iterateAttributeDecls()

getAttributeDecl

XSAttributeDecl getAttributeDecl(String localName)

getElementDecls

Map<String,XSElementDecl> getElementDecls()

Gets all the XSElementDecls in this schema.

iterateElementDecls

Iterator<XSElementDecl> iterateElementDecls()

getElementDecl

XSElementDecl getElementDecl(String localName)

getAttGroupDecls

Map<String,XSAttGroupDecl> getAttGroupDecls()

Gets all the XSAttGroupDecls in this schema.

iterateAttGroupDecls

Iterator<XSAttGroupDecl> iterateAttGroupDecls()

getAttGroupDecl

XSAttGroupDecl getAttGroupDecl(String localName)

getModelGroupDecls

Map<String,XSModelGroupDecl> getModelGroupDecls()

Gets all the XSModelGroupDecls in this schema.

iterateModelGroupDecls

Iterator<XSModelGroupDecl> iterateModelGroupDecls()

getModelGroupDecl

XSModelGroupDecl getModelGroupDecl(String localName)

getTypes

Map<String,XSType> getTypes()

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

iterateTypes

Iterator<XSType> iterateTypes()

getType

XSType getType(String localName)

getSimpleTypes

Map<String,XSSimpleType> getSimpleTypes()

Gets all the XSSimpleTypes in this schema.

iterateSimpleTypes

Iterator<XSSimpleType> iterateSimpleTypes()

getSimpleType

XSSimpleType getSimpleType(String localName)

getComplexTypes

Map<String,XSComplexType> getComplexTypes()

Gets all the XSComplexTypes in this schema.

iterateComplexTypes

Iterator<XSComplexType> iterateComplexTypes()

getComplexType

XSComplexType getComplexType(String localName)

getNotations

Map<String,XSNotation> getNotations()

Gets all the XSNotations in this schema.

iterateNotations

Iterator<XSNotation> iterateNotations()

getNotation

XSNotation getNotation(String localName)

getIdentityConstraints

Map<String,XSIdentityConstraint> getIdentityConstraints()

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

getIdentityConstraint

XSIdentityConstraint getIdentityConstraint(String localName)

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

getSourceDocument

@Deprecated(since="2.3")
SchemaDocument getSourceDocument()

Deprecated.

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

Sine an 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.