Interface XSModel
-
- All Known Implementing Classes:
XSModelImpl
public interface XSModel
This interface represents an XML Schema.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description XSObjectList
getAnnotations()
[annotations]: a set of annotations if it exists, otherwise an emptyXSObjectList
.XSAttributeDeclaration
getAttributeDeclaration(String name, String namespace)
Convenience method.XSAttributeGroupDefinition
getAttributeGroup(String name, String namespace)
Convenience method.XSNamedMap
getComponents(short objectType)
Returns a list of top-level components, i.e.XSNamedMap
getComponentsByNamespace(short objectType, String namespace)
Convenience method.XSElementDeclaration
getElementDeclaration(String name, String namespace)
Convenience method.XSIDCDefinition
getIDCDefinition(String name, String namespace)
Convenience method.XSModelGroupDefinition
getModelGroupDefinition(String name, String namespace)
Convenience method.XSNamespaceItemList
getNamespaceItems()
A set of namespace schema information information items (of typeXSNamespaceItem
), 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.StringList
getNamespaces()
Convenience method.XSNotationDeclaration
getNotationDeclaration(String name, String namespace)
Convenience method.XSObjectList
getSubstitutionGroup(XSElementDeclaration head)
Convenience method.XSTypeDefinition
getTypeDefinition(String name, String namespace)
Convenience method.
-
-
-
Method Detail
-
getNamespaces
StringList getNamespaces()
Convenience method. Returns a list of all namespaces that belong to this schema. The valuenull
is not a valid namespace name, but if there are components that do not have a target namespace ,null
is included in this list.
-
getNamespaceItems
XSNamespaceItemList getNamespaceItems()
A set of namespace schema information information items (of typeXSNamespaceItem
), 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.
-
getComponents
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
- The type of the declaration, i.e.ELEMENT_DECLARATION
. Note thatXSTypeDefinition.SIMPLE_TYPE
andXSTypeDefinition.COMPLEX_TYPE
can also be used as theobjectType
to retrieve only complex types or simple types, instead of all types.- Returns:
- A list of top-level definitions of the specified type in
objectType
or an emptyXSNamedMap
if no such definitions exist.
-
getComponentsByNamespace
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
- The type of the declaration, i.e.ELEMENT_DECLARATION
.namespace
- The namespace to which the declaration belongs ornull
(for components with no target namespace).- Returns:
- A list of top-level definitions of the specified type in
objectType
and defined in the specifiednamespace
or an emptyXSNamedMap
.
-
getAnnotations
XSObjectList getAnnotations()
[annotations]: a set of annotations if it exists, otherwise an emptyXSObjectList
.
-
getElementDeclaration
XSElementDeclaration getElementDeclaration(String name, String namespace)
Convenience method. Returns a top-level element declaration.- Parameters:
name
- The name of the declaration.namespace
- The namespace of the declaration, otherwisenull
.- Returns:
- A top-level element declaration or
null
if such a declaration does not exist.
-
getAttributeDeclaration
XSAttributeDeclaration getAttributeDeclaration(String name, String namespace)
Convenience method. Returns a top-level attribute declaration.- Parameters:
name
- The name of the declaration.namespace
- The namespace of the declaration, otherwisenull
.- Returns:
- A top-level attribute declaration or
null
if such a declaration does not exist.
-
getTypeDefinition
XSTypeDefinition getTypeDefinition(String name, 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 declaration, otherwisenull
.- Returns:
- An
XSTypeDefinition
ornull
if such a definition does not exist.
-
getAttributeGroup
XSAttributeGroupDefinition getAttributeGroup(String name, String namespace)
Convenience method. Returns a top-level attribute group definition.- Parameters:
name
- The name of the definition.namespace
- The namespace of the definition, otherwisenull
.- Returns:
- A top-level attribute group definition or
null
if such a definition does not exist.
-
getModelGroupDefinition
XSModelGroupDefinition getModelGroupDefinition(String name, String namespace)
Convenience method. Returns a top-level model group definition.- Parameters:
name
- The name of the definition.namespace
- The namespace of the definition, otherwisenull
.- Returns:
- A top-level model group definition or
null
if such a definition does not exist.
-
getNotationDeclaration
XSNotationDeclaration getNotationDeclaration(String name, String namespace)
Convenience method. Returns a top-level notation declaration.- Parameters:
name
- The name of the declaration.namespace
- The namespace of the declaration, otherwisenull
.- Returns:
- A top-level notation declaration or
null
if such a declaration does not exist.
-
getIDCDefinition
XSIDCDefinition getIDCDefinition(String name, String namespace)
Convenience method. Returns an identity-constraint definition.- Parameters:
name
- The name of the definition.namespace
- The namespace of the definition, otherwisenull
.- Returns:
- An identity-constraint definition or
null
if such a declaration does not exist.
-
getSubstitutionGroup
XSObjectList getSubstitutionGroup(XSElementDeclaration head)
Convenience method. Returns a list containing the members of the substitution group for the givenXSElementDeclaration
or an emptyXSObjectList
if the substitution group contains no members.- Parameters:
head
- The substitution group head.- Returns:
- A list containing the members of the substitution group
for the given
XSElementDeclaration
or an emptyXSObjectList
if the substitution group contains no members.
-
-