FileDocCategorySizeDatePackage
XSModel.javaAPI DocApache Xerces 3.0.17189Fri Sep 14 20:33:52 BST 2007org.apache.xerces.xs

XSModel

public interface XSModel
This interface represents an XML Schema.

Fields Summary
Constructors Summary
Methods Summary
public XSObjectListgetAnnotations()
[annotations]: a set of annotations if it exists, otherwise an empty XSObjectList.

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

param
name The name of the declaration.
param
namespace The namespace of the declaration, otherwise null.
return
A top-level attribute declaration or null if such a declaration does not exist.

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

param
name The name of the definition.
param
namespace The namespace of the definition, otherwise null.
return
A top-level attribute group definition or null if such a definition does not exist.

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

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

public XSNamedMapgetComponentsByNamespace(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.

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

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

param
name The name of the declaration.
param
namespace The namespace of the declaration, otherwise null.
return
A top-level element declaration or null if such a declaration does not exist.

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

param
name The name of the definition.
param
namespace The namespace of the definition, otherwise null.
return
A top-level model group definition or null if such a definition does not exist.

public XSNamespaceItemListgetNamespaceItems()
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.

public StringListgetNamespaces()
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.

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

param
name The name of the declaration.
param
namespace The namespace of the declaration, otherwise null.
return
A top-level notation declaration or null if such a declaration does not exist.

public XSObjectListgetSubstitutionGroup(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.

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

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

param
name The name of the definition.
param
namespace The namespace of the declaration, otherwise null.
return
An XSTypeDefinition or null if such a definition does not exist.