com.sun.xml.xsom.XSSchema Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 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 com.sun.xml.xsom.parser.SchemaDocument;
import java.util.Iterator;
import java.util.Map;
/**
* Schema.
*
* Container of declarations that belong to the same target namespace.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
public interface XSSchema extends XSComponent
{
/**
* Gets the target namespace of the schema.
*
* @return
* can be empty, but never be null.
*/
String getTargetNamespace();
/**
* Gets all the {@link XSAttributeDecl}s in this schema
* keyed by their local names.
*/
Map getAttributeDecls();
Iterator iterateAttributeDecls();
XSAttributeDecl getAttributeDecl(String localName);
/**
* Gets all the {@link XSElementDecl}s in this schema.
*/
Map getElementDecls();
Iterator iterateElementDecls();
XSElementDecl getElementDecl(String localName);
/**
* Gets all the {@link XSAttGroupDecl}s in this schema.
*/
Map getAttGroupDecls();
Iterator iterateAttGroupDecls();
XSAttGroupDecl getAttGroupDecl(String localName);
/**
* Gets all the {@link XSModelGroupDecl}s in this schema.
*/
Map getModelGroupDecls();
Iterator iterateModelGroupDecls();
XSModelGroupDecl getModelGroupDecl(String localName);
/**
* Gets all the {@link XSType}s in this schema (union of
* {@link #getSimpleTypes()} and {@link #getComplexTypes()}
*/
Map getTypes();
Iterator iterateTypes();
XSType getType(String localName);
/**
* Gets all the {@link XSSimpleType}s in this schema.
*/
Map getSimpleTypes();
Iterator iterateSimpleTypes();
XSSimpleType getSimpleType(String localName);
/**
* Gets all the {@link XSComplexType}s in this schema.
*/
Map getComplexTypes();
Iterator iterateComplexTypes();
XSComplexType getComplexType(String localName);
/**
* Gets all the {@link XSNotation}s in this schema.
*/
Map getNotations();
Iterator iterateNotations();
XSNotation getNotation(String localName);
/**
* Gets all the {@link XSIdentityConstraint}s in this schema,
* keyed by their names.
*/
Map getIdentityConstraints();
/**
* Gets the identity constraint of the given name, or null if not found.
*/
XSIdentityConstraint getIdentityConstraint(String localName);
/**
* Sine an {@link XSSchema} is not necessarily defined in
* one schema document (for example one schema can span across
* many documents through {@code s}.),
* so this method always returns null.
*
* @deprecated
* Since this method always returns null, if you are calling
* this method from {@link XSSchema} and not from {@link XSComponent},
* there's something wrong with your code.
*/
SchemaDocument getSourceDocument();
/**
* Gets the root schema set that includes this schema.
*
* @return never null.
*/
XSSchemaSet getRoot();
}