Top Description Methods
org.apache.xerces.xs

public Interface XSModel

Known Direct Implementers
org.apache.xerces.impl.xs.XSModelImpl
This interface represents an XML Schema.

Method Summary

Modifier and TypeMethod and Description
public XSObjectList
getAnnotations()

[annotations]: a set of annotations if it exists, otherwise an empty XSObjectList.

public XSAttributeDeclaration

Returns:

A top-level attribute declaration or null if such a declaration does not exist.
getAttributeDeclaration(String
The name of the declaration.
name, String
The namespace of the declaration, otherwise null.
namespace)

Convenience method.

public XSAttributeGroupDefinition

Returns:

A top-level attribute group definition or null if such a definition does not exist.
getAttributeGroup(String
The name of the definition.
name, String
The namespace of the definition, otherwise null.
namespace)

Convenience method.

public XSNamedMap

Returns:

A list of top-level definitions of the specified type in objectType or an empty XSNamedMap if no such definitions exist.
getComponents(short
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.
objectType)

Returns a list of top-level components, i.e. element declarations, attribute declarations, etc. Identity-constraint definitions are also considered top-level.

public XSNamedMap

Returns:

A list of top-level definitions of the specified type in objectType and defined in the specified namespace or an empty XSNamedMap.
getComponentsByNamespace(short
The type of the declaration, i.e. ELEMENT_DECLARATION.
objectType, String
The namespace to which the declaration belongs or null (for components with no target namespace).
namespace)

Convenience method.

public XSElementDeclaration

Returns:

A top-level element declaration or null if such a declaration does not exist.
getElementDeclaration(String
The name of the declaration.
name, String
The namespace of the declaration, otherwise null.
namespace)

Convenience method.

public XSIDCDefinition

Returns:

An identity-constraint definition or null if such a declaration does not exist.
getIDCDefinition(String
The name of the definition.
name, String
The namespace of the definition, otherwise null.
namespace)

Convenience method.

public XSModelGroupDefinition

Returns:

A top-level model group definition or null if such a definition does not exist.
getModelGroupDefinition(String
The name of the definition.
name, String
The namespace of the definition, otherwise null.
namespace)

Convenience method.

public XSNamespaceItemList
getNamespaceItems()

A set of namespace schema information information items (of type XSNamespaceItem), one for each namespace name which appears as the target namespace of any schema component in the schema used for that assessment, and one for absent if any schema component in the schema had no target namespace.

public StringList
getNamespaces()

Convenience method.

public XSNotationDeclaration

Returns:

A top-level notation declaration or null if such a declaration does not exist.
getNotationDeclaration(String
The name of the declaration.
name, String
The namespace of the declaration, otherwise null.
namespace)

Convenience method.

public XSObjectList

Returns:

A list containing the members of the substitution group for the given XSElementDeclaration or an empty XSObjectList if the substitution group contains no members.
getSubstitutionGroup(XSElementDeclaration
The substitution group head.
head)

Convenience method.

public XSTypeDefinition

Returns:

An XSTypeDefinition or null if such a definition does not exist.
getTypeDefinition(String
The name of the definition.
name, String
The namespace of the declaration, otherwise null.
namespace)

Convenience method.

Method Detail

getAnnotationsback to summary
public XSObjectList getAnnotations()

[annotations]: a set of annotations if it exists, otherwise an empty XSObjectList.

getAttributeDeclarationback to summary
public XSAttributeDeclaration getAttributeDeclaration(String name, String namespace)

Convenience method. Returns a top-level attribute declaration.

Parameters
name:String

The name of the declaration.

namespace:String

The namespace of the declaration, otherwise null.

Returns:XSAttributeDeclaration

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

getAttributeGroupback to summary
public XSAttributeGroupDefinition getAttributeGroup(String name, String namespace)

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

Parameters
name:String

The name of the definition.

namespace:String

The namespace of the definition, otherwise null.

Returns:XSAttributeGroupDefinition

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

getComponentsback to summary
public XSNamedMap getComponents(short objectType)

Returns a list of top-level components, i.e. element declarations, attribute declarations, etc. Identity-constraint definitions are also considered top-level.

Parameters
objectType:short

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:XSNamedMap

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

getComponentsByNamespaceback to summary
public XSNamedMap getComponentsByNamespace(short objectType, String namespace)

Convenience method. Returns a list of top-level component declarations that are defined within the specified namespace, i.e. element declarations, attribute declarations, etc. Identity-constraint definitions are also considered top-level.

Parameters
objectType:short

The type of the declaration, i.e. ELEMENT_DECLARATION.

namespace:String

The namespace to which the declaration belongs or null (for components with no target namespace).

Returns:XSNamedMap

A list of top-level definitions of the specified type in objectType and defined in the specified namespace or an empty XSNamedMap.

getElementDeclarationback to summary
public XSElementDeclaration getElementDeclaration(String name, String namespace)

Convenience method. Returns a top-level element declaration.

Parameters
name:String

The name of the declaration.

namespace:String

The namespace of the declaration, otherwise null.

Returns:XSElementDeclaration

A top-level element declaration or null if such a declaration does not exist.

getIDCDefinitionback to summary
public XSIDCDefinition getIDCDefinition(String name, String namespace)

Convenience method. Returns an identity-constraint definition.

Parameters
name:String

The name of the definition.

namespace:String

The namespace of the definition, otherwise null.

Returns:XSIDCDefinition

An identity-constraint definition or null if such a declaration does not exist.

getModelGroupDefinitionback to summary
public XSModelGroupDefinition getModelGroupDefinition(String name, String namespace)

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

Parameters
name:String

The name of the definition.

namespace:String

The namespace of the definition, otherwise null.

Returns:XSModelGroupDefinition

A top-level model group definition or null if such a definition does not exist.

getNamespaceItemsback to summary
public XSNamespaceItemList getNamespaceItems()

A set of namespace schema information information items (of type XSNamespaceItem), one for each namespace name which appears as the target namespace of any schema component in the schema used for that assessment, and one for absent if any schema component in the schema had no target namespace. For more information see schema information.

getNamespacesback to summary
public StringList getNamespaces()

Convenience method. Returns a list of all namespaces that belong to this schema. The value null is not a valid namespace name, but if there are components that do not have a target namespace , null is included in this list.

getNotationDeclarationback to summary
public XSNotationDeclaration getNotationDeclaration(String name, String namespace)

Convenience method. Returns a top-level notation declaration.

Parameters
name:String

The name of the declaration.

namespace:String

The namespace of the declaration, otherwise null.

Returns:XSNotationDeclaration

A top-level notation declaration or null if such a declaration does not exist.

getSubstitutionGroupback to summary
public XSObjectList getSubstitutionGroup(XSElementDeclaration head)

Convenience method. Returns a list containing the members of the substitution group for the given XSElementDeclaration or an empty XSObjectList if the substitution group contains no members.

Parameters
head:XSElementDeclaration

The substitution group head.

Returns:XSObjectList

A list containing the members of the substitution group for the given XSElementDeclaration or an empty XSObjectList if the substitution group contains no members.

getTypeDefinitionback to summary
public XSTypeDefinition getTypeDefinition(String name, String namespace)

Convenience method. Returns a top-level simple or complex type definition.

Parameters
name:String

The name of the definition.

namespace:String

The namespace of the declaration, otherwise null.

Returns:XSTypeDefinition

An XSTypeDefinition or null if such a definition does not exist.