org.apache.xerces.xs.XSNamespaceItem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xercesImpl Show documentation
Show all versions of xercesImpl Show documentation
Xerces2 is the next generation of high performance, fully compliant XML parsers in the Apache Xerces family.
This new version of Xerces introduces the Xerces Native Interface (XNI), a complete framework for building
parser components and configurations that is extremely modular and easy to program. The Apache Xerces2 parser is
the reference implementation of XNI but other parser components, configurations, and parsers can be written
using the Xerces Native Interface. For complete design and implementation documents, refer to the XNI Manual.
Xerces2 is a fully conforming XML Schema 1.0 processor. A partial experimental implementation of the XML Schema
1.1 Structures and Datatypes Working Drafts (December 2009) and an experimental implementation of the XML Schema
Definition Language (XSD): Component Designators (SCD) Candidate Recommendation (January 2010) are provided for
evaluation. For more information, refer to the XML Schema page. Xerces2 also provides a complete implementation
of the Document Object Model Level 3 Core and Load/Save W3C Recommendations and provides a complete
implementation of the XML Inclusions (XInclude) W3C Recommendation. It also provides support for OASIS XML
Catalogs v1.1. Xerces2 is able to parse documents written according to the XML 1.1 Recommendation, except that
it does not yet provide an option to enable normalization checking as described in section 2.13 of this
specification. It also handles namespaces according to the XML Namespaces 1.1 Recommendation, and will correctly
serialize XML 1.1 documents if the DOM level 3 load/save APIs are in use.
/*
* 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;
/**
* The interface represents the namespace schema information information item.
* Each namespace schema information information item corresponds to an XML
* Schema with a unique namespace name.
*/
public interface XSNamespaceItem {
/**
* [schema namespace]: A namespace name or null if absent.
*/
public String getSchemaNamespace();
/**
* [schema components]: 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 definition of the specified type in
* objectType or an empty XSNamedMap if no
* such definitions exist.
*/
public XSNamedMap getComponents(short objectType);
/**
* [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.
* @return A top-level element declaration or null if such a
* declaration does not exist.
*/
public XSElementDeclaration getElementDeclaration(String name);
/**
* Convenience method. Returns a top-level attribute declaration.
* @param name The name of the declaration.
* @return A top-level attribute declaration or null if such
* a declaration does not exist.
*/
public XSAttributeDeclaration getAttributeDeclaration(String name);
/**
* Convenience method. Returns a top-level simple or complex type
* definition.
* @param name The name of the definition.
* @return An XSTypeDefinition or null if such
* a definition does not exist.
*/
public XSTypeDefinition getTypeDefinition(String name);
/**
* Convenience method. Returns a top-level attribute group definition.
* @param name The name of the definition.
* @return A top-level attribute group definition or null if
* such a definition does not exist.
*/
public XSAttributeGroupDefinition getAttributeGroup(String name);
/**
* Convenience method. Returns a top-level model group definition.
* @param name The name of the definition.
* @return A top-level model group definition definition or
* null if such a definition does not exist.
*/
public XSModelGroupDefinition getModelGroupDefinition(String name);
/**
* Convenience method. Returns a top-level notation declaration.
* @param name The name of the declaration.
* @return A top-level notation declaration or null if such
* a declaration does not exist.
*/
public XSNotationDeclaration getNotationDeclaration(String name);
/**
* Convenience method. Returns an identity-constraint definition.
* @param name The name of the definition.
* @return An identity-constraint definition or null if such
* a declaration does not exist.
*/
public XSIDCDefinition getIDCDefinition(String name);
/**
* [document location] - a list of location URIs for the documents that
* contributed to the XSModel.
*/
public StringList getDocumentLocations();
}