org.apache.xerces.xs.XSModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xerces2-xsd11 Show documentation
Show all versions of xerces2-xsd11 Show documentation
A processor for parsing, validating, serializing and manipulating XML, written in Java
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.xerces.xs;
/**
* This interface represents an XML Schema.
*/
public interface XSModel {
/**
* 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 StringList getNamespaces();
/**
* 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 XSNamespaceItemList getNamespaceItems();
/**
* Returns a list of top-level components, i.e. element declarations,
* attribute declarations, etc. Identity-constraint definitions are also
* considered top-level.
*
* @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 XSNamedMap getComponents(short objectType);
/**
* 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.
*
* @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 XSNamedMap getComponentsByNamespace(short objectType,
String namespace);
/**
* [annotations]: a set of annotations if it exists, otherwise an empty
* XSObjectList.
*/
public XSObjectList getAnnotations();
/**
* 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 XSElementDeclaration getElementDeclaration(String name,
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 XSAttributeDeclaration getAttributeDeclaration(String name,
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.
*/
public XSTypeDefinition getTypeDefinition(String name,
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 XSAttributeGroupDefinition getAttributeGroup(String name,
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 XSModelGroupDefinition getModelGroupDefinition(String name,
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 XSNotationDeclaration getNotationDeclaration(String name,
String namespace);
/**
* Convenience method. Returns an identity-constraint definition.
* @param name The name of the definition.
* @param namespace The namespace of the definition, otherwise
* null.
* @return An identity-constraint definition or null if such
* a declaration does not exist.
*/
public XSIDCDefinition getIDCDefinition(String name,
String namespace);
/**
* 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 XSObjectList getSubstitutionGroup(XSElementDeclaration head);
}