com.sun.xml.xsom.XSSchemaSet Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.xsom;
import javax.xml.namespace.NamespaceContext;
import java.util.Iterator;
import java.util.Collection;
/**
* Set of {@link XSSchema} objects.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public interface XSSchemaSet
{
XSSchema getSchema(String targetNamespace);
XSSchema getSchema(int idx);
int getSchemaSize();
Iterator iterateSchema();
/**
* Gets all {@link XSSchema}s in a single collection.
*/
Collection getSchemas();
XSType getType(String namespaceURI, String localName);
XSSimpleType getSimpleType(String namespaceURI, String localName);
XSAttributeDecl getAttributeDecl(String namespaceURI, String localName);
XSElementDecl getElementDecl(String namespaceURI, String localName);
XSModelGroupDecl getModelGroupDecl(String namespaceURI, String localName);
XSAttGroupDecl getAttGroupDecl(String namespaceURI, String localName);
XSComplexType getComplexType(String namespaceURI, String localName);
XSIdentityConstraint getIdentityConstraint(String namespaceURI, String localName);
/** Iterates all element declarations in all the schemas. */
Iterator iterateElementDecls();
/** Iterates all type definitions in all the schemas. */
Iterator iterateTypes();
/** Iterates all atribute declarations in all the schemas. */
Iterator iterateAttributeDecls();
/** Iterates all attribute group declarations in all the schemas. */
Iterator iterateAttGroupDecls();
/** Iterates all model group declarations in all the schemas. */
Iterator iterateModelGroupDecls();
/** Iterates all simple type definitions in all the schemas. */
Iterator iterateSimpleTypes();
/** Iterates all complex type definitions in all the schemas. */
Iterator iterateComplexTypes();
/** Iterates all notation declarations in all the schemas. */
Iterator iterateNotations();
/**
* Iterates all identity constraints in all the schemas.
*/
Iterator iterateIdentityConstraints();
// conceptually static methods
XSComplexType getAnyType();
XSSimpleType getAnySimpleType();
XSContentType getEmpty();
/**
* Evaluates a schema component designator against this schema component
* and returns the resulting schema components.
*
* @throws IllegalArgumentException
* if SCD is syntactically incorrect.
* @param scd
* Schema component designator. See {@link SCD} for more details.
* @param nsContext
* The namespace context in which SCD is evaluated. Cannot be null.
* @return
* Can be empty but never null.
*/
Collection select(String scd, NamespaceContext nsContext);
/**
* Evaluates a schema component designator against this schema component
* and returns the first resulting schema component.
*
* @throws IllegalArgumentException
* if SCD is syntactically incorrect.
* @param scd
* Schema component designator. See {@link SCD} for more details.
* @param nsContext
* The namespace context in which SCD is evaluated. Cannot be null.
* @return
* null if the SCD didn't match anything. If the SCD matched more than one node,
* the first one will be returned.
*/
XSComponent selectSingle(String scd, NamespaceContext nsContext);
}