Thu, 12 Oct 2017 19:44:07 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.xsom; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.xml.internal.xsom.parser.SchemaDocument; |
aoqi@0 | 29 | |
aoqi@0 | 30 | import java.util.Iterator; |
aoqi@0 | 31 | import java.util.Map; |
aoqi@0 | 32 | |
aoqi@0 | 33 | /** |
aoqi@0 | 34 | * Schema. |
aoqi@0 | 35 | * |
aoqi@0 | 36 | * Container of declarations that belong to the same target namespace. |
aoqi@0 | 37 | * |
aoqi@0 | 38 | * @author |
aoqi@0 | 39 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
aoqi@0 | 40 | */ |
aoqi@0 | 41 | public interface XSSchema extends XSComponent |
aoqi@0 | 42 | { |
aoqi@0 | 43 | /** |
aoqi@0 | 44 | * Gets the target namespace of the schema. |
aoqi@0 | 45 | * |
aoqi@0 | 46 | * @return |
aoqi@0 | 47 | * can be empty, but never be null. |
aoqi@0 | 48 | */ |
aoqi@0 | 49 | String getTargetNamespace(); |
aoqi@0 | 50 | |
aoqi@0 | 51 | /** |
aoqi@0 | 52 | * Gets all the {@link XSAttributeDecl}s in this schema |
aoqi@0 | 53 | * keyed by their local names. |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | Map<String,XSAttributeDecl> getAttributeDecls(); |
aoqi@0 | 56 | Iterator<XSAttributeDecl> iterateAttributeDecls(); |
aoqi@0 | 57 | XSAttributeDecl getAttributeDecl(String localName); |
aoqi@0 | 58 | |
aoqi@0 | 59 | /** |
aoqi@0 | 60 | * Gets all the {@link XSElementDecl}s in this schema. |
aoqi@0 | 61 | */ |
aoqi@0 | 62 | Map<String,XSElementDecl> getElementDecls(); |
aoqi@0 | 63 | Iterator<XSElementDecl> iterateElementDecls(); |
aoqi@0 | 64 | XSElementDecl getElementDecl(String localName); |
aoqi@0 | 65 | |
aoqi@0 | 66 | /** |
aoqi@0 | 67 | * Gets all the {@link XSAttGroupDecl}s in this schema. |
aoqi@0 | 68 | */ |
aoqi@0 | 69 | Map<String,XSAttGroupDecl> getAttGroupDecls(); |
aoqi@0 | 70 | Iterator<XSAttGroupDecl> iterateAttGroupDecls(); |
aoqi@0 | 71 | XSAttGroupDecl getAttGroupDecl(String localName); |
aoqi@0 | 72 | |
aoqi@0 | 73 | /** |
aoqi@0 | 74 | * Gets all the {@link XSModelGroupDecl}s in this schema. |
aoqi@0 | 75 | */ |
aoqi@0 | 76 | Map<String,XSModelGroupDecl> getModelGroupDecls(); |
aoqi@0 | 77 | Iterator<XSModelGroupDecl> iterateModelGroupDecls(); |
aoqi@0 | 78 | XSModelGroupDecl getModelGroupDecl(String localName); |
aoqi@0 | 79 | |
aoqi@0 | 80 | /** |
aoqi@0 | 81 | * Gets all the {@link XSType}s in this schema (union of |
aoqi@0 | 82 | * {@link #getSimpleTypes()} and {@link #getComplexTypes()} |
aoqi@0 | 83 | */ |
aoqi@0 | 84 | Map<String,XSType> getTypes(); |
aoqi@0 | 85 | Iterator<XSType> iterateTypes(); |
aoqi@0 | 86 | XSType getType(String localName); |
aoqi@0 | 87 | |
aoqi@0 | 88 | /** |
aoqi@0 | 89 | * Gets all the {@link XSSimpleType}s in this schema. |
aoqi@0 | 90 | */ |
aoqi@0 | 91 | Map<String,XSSimpleType> getSimpleTypes(); |
aoqi@0 | 92 | Iterator<XSSimpleType> iterateSimpleTypes(); |
aoqi@0 | 93 | XSSimpleType getSimpleType(String localName); |
aoqi@0 | 94 | |
aoqi@0 | 95 | /** |
aoqi@0 | 96 | * Gets all the {@link XSComplexType}s in this schema. |
aoqi@0 | 97 | */ |
aoqi@0 | 98 | Map<String,XSComplexType> getComplexTypes(); |
aoqi@0 | 99 | Iterator<XSComplexType> iterateComplexTypes(); |
aoqi@0 | 100 | XSComplexType getComplexType(String localName); |
aoqi@0 | 101 | |
aoqi@0 | 102 | /** |
aoqi@0 | 103 | * Gets all the {@link XSNotation}s in this schema. |
aoqi@0 | 104 | */ |
aoqi@0 | 105 | Map<String,XSNotation> getNotations(); |
aoqi@0 | 106 | Iterator<XSNotation> iterateNotations(); |
aoqi@0 | 107 | XSNotation getNotation(String localName); |
aoqi@0 | 108 | |
aoqi@0 | 109 | /** |
aoqi@0 | 110 | * Gets all the {@link XSIdentityConstraint}s in this schema, |
aoqi@0 | 111 | * keyed by their names. |
aoqi@0 | 112 | */ |
aoqi@0 | 113 | Map<String,XSIdentityConstraint> getIdentityConstraints(); |
aoqi@0 | 114 | |
aoqi@0 | 115 | /** |
aoqi@0 | 116 | * Gets the identity constraint of the given name, or null if not found. |
aoqi@0 | 117 | */ |
aoqi@0 | 118 | XSIdentityConstraint getIdentityConstraint(String localName); |
aoqi@0 | 119 | |
aoqi@0 | 120 | /** |
aoqi@0 | 121 | * Sine an {@link XSSchema} is not necessarily defined in |
aoqi@0 | 122 | * one schema document (for example one schema can span across |
aoqi@0 | 123 | * many documents through <xs:include>s.), |
aoqi@0 | 124 | * so this method always returns null. |
aoqi@0 | 125 | * |
aoqi@0 | 126 | * @deprecated |
aoqi@0 | 127 | * Since this method always returns null, if you are calling |
aoqi@0 | 128 | * this method from {@link XSSchema} and not from {@link XSComponent}, |
aoqi@0 | 129 | * there's something wrong with your code. |
aoqi@0 | 130 | */ |
aoqi@0 | 131 | SchemaDocument getSourceDocument(); |
aoqi@0 | 132 | |
aoqi@0 | 133 | /** |
aoqi@0 | 134 | * Gets the root schema set that includes this schema. |
aoqi@0 | 135 | * |
aoqi@0 | 136 | * @return never null. |
aoqi@0 | 137 | */ |
aoqi@0 | 138 | XSSchemaSet getRoot(); |
aoqi@0 | 139 | } |