org.apache.xerces.impl.xs.psvi
Interface XSModel

All Known Implementing Classes:
XSModelImpl

public interface XSModel

3.15.1 The Schema Itself. A read-only interface that represents an XML Schema.

Version:
$Id: XSModel.java,v 1.3 2002/06/17 18:41:46 elena Exp $
Author:
Elena Litani, IBM

Method Summary
 XSObjectList getAnnotations()
          {annotations} A set of annotations.
 XSAttributeDeclaration getAttributeDecl(java.lang.String name, java.lang.String namespace)
          Convenience method.
 XSAttributeGroupDefinition getAttributeGroup(java.lang.String name, java.lang.String namespace)
          Convenience method.
 XSNamedMap getComponents(short objectType)
          Returns a list of top-level components, i.e.
 XSNamedMap getComponentsByNamespace(short objectType, java.lang.String namespace)
          Convenience method.
 XSElementDeclaration getElementDecl(java.lang.String name, java.lang.String namespace)
          Convenience method.
 XSModelGroupDefinition getModelGroupDefinition(java.lang.String name, java.lang.String namespace)
          Convenience method.
 ObjectList getNamespaceItems()
          Convenience method.
 StringList getNamespaces()
          Convenience method.
 XSNotationDeclaration getNotationDecl(java.lang.String name, java.lang.String namespace)
          Convenience method.
 XSTypeDefinition getTypeDefinition(java.lang.String name, java.lang.String namespace)
          Convenience method.
 

Method Detail

getNamespaces

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 don't have a target namespace, "null" is included in this list.

Returns:
A list of all namespaces that belong to this schema.

getNamespaceItems

public ObjectList getNamespaceItems()
Convenience method. Returns a list of all [namespace schema information item]s. There is one such item for each namespace (including the null namespace). Enties of the returned enumeration are instances of XSNamespaceItem interface.

Returns:
A list of namespace items that belong to this schema.

getComponents

public XSNamedMap getComponents(short objectType)
Returns a list of top-level components, i.e. element declarations, attribute declarations, etc.

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.

Parameters:
objectType - The type of the declaration, i.e. ELEMENT_DECLARATION, ATTRIBUTE_DECLARATION, etc.
Returns:
A list of top-level definition of the specified type in objectType or null.

getComponentsByNamespace

public XSNamedMap getComponentsByNamespace(short objectType,
                                           java.lang.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.

Parameters:
objectType - The type of the declaration, i.e. ELEMENT_DECLARATION, ATTRIBUTE_DECLARATION, etc.
namespace - The namespace to which declaration belong or null (for components with no targetNamespace).
Returns:
A list of top-level definition of the specified type in objectType and defined in the specified namespace or null.

getTypeDefinition

public XSTypeDefinition getTypeDefinition(java.lang.String name,
                                          java.lang.String namespace)
Convenience method. Returns a top-level simple or complex type definition.

Parameters:
name - The name of the definition.
namespace - The namespace of the definition, otherwise null.
Returns:
An XSTypeDefinition or null if such definition does not exist.

getAttributeDecl

public XSAttributeDeclaration getAttributeDecl(java.lang.String name,
                                               java.lang.String namespace)
Convenience method. Returns a top-level attribute declaration.

Parameters:
name - The name of the declaration.
namespace - The namespace of the definition, otherwise null.
Returns:
A top-level attribute declaration or null if such declaration does not exist.

getElementDecl

public XSElementDeclaration getElementDecl(java.lang.String name,
                                           java.lang.String namespace)
Convenience method. Returns a top-level element declaration.

Parameters:
name - The name of the declaration.
namespace - The namespace of the definition, otherwise null.
Returns:
A top-level element declaration or null if such declaration does not exist.

getAttributeGroup

public XSAttributeGroupDefinition getAttributeGroup(java.lang.String name,
                                                    java.lang.String namespace)
Convenience method. Returns a top-level attribute group definition.

Parameters:
name - The name of the definition.
namespace - The namespace of the definition, otherwise null.
Returns:
A top-level attribute group definition or null if such definition does not exist.

getModelGroupDefinition

public XSModelGroupDefinition getModelGroupDefinition(java.lang.String name,
                                                      java.lang.String namespace)
Convenience method. Returns a top-level model group definition.

Parameters:
name - The name of the definition.
namespace - The namespace of the definition, otherwise null.
Returns:
A top-level model group definition definition or null if such definition does not exist.

getNotationDecl

public XSNotationDeclaration getNotationDecl(java.lang.String name,
                                             java.lang.String namespace)
Convenience method. Returns a top-level notation declaration.

Parameters:
name - The name of the declaration.
namespace - The namespace of the definition, otherwise null.
Returns:
A top-level notation declaration or null if such declaration does not exist.

getAnnotations

public XSObjectList getAnnotations()
{annotations} A set of annotations.



Copyright © 1999-2002 Apache XML Project. All Rights Reserved.