/* * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.xml.internal.xsom; import com.sun.xml.internal.xsom.parser.SchemaDocument; import com.sun.xml.internal.xsom.visitor.XSFunction; import com.sun.xml.internal.xsom.visitor.XSVisitor; import org.xml.sax.Locator; import javax.xml.namespace.NamespaceContext; import java.util.List; import java.util.Collection; /** * Base interface for all the schema components. * * @author * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) */ public interface XSComponent { /** Gets the annotation associated to this component, if any. */ XSAnnotation getAnnotation(); /** * Works like {@link #getAnnotation()}, but allow a new empty {@link XSAnnotation} to be created * if not exist. * * @param createIfNotExist * true to create a new {@link XSAnnotation} if it doesn't exist already. * false to make this method behavel like {@link #getAnnotation()}. * * @return * null if createIfNotExist==false and annotation didn't exist. * Otherwise non-null. */ XSAnnotation getAnnotation(boolean createIfNotExist); /** * Gets the foreign attributes on this schema component. * *
* In general, a schema component may match multiple elements * in a schema document, and those elements can individually * carry foreign attributes. * *
* This method returns a list of {@link ForeignAttributes}, where * each {@link ForeignAttributes} object represent foreign attributes * on one element. * * @return * can be an empty list but never be null. */ List extends ForeignAttributes> getForeignAttributes(); /** * Gets the foreign attribute of the given name, or null if not found. * *
* If multiple occurences of the same attribute is found, * this method returns the first one. * * @see #getForeignAttributes() */ String getForeignAttribute(String nsUri, String localName); /** * Gets the locator that indicates the source location where * this component is created from, or null if no information is * available. */ Locator getLocator(); /** * Gets a reference to the {@link XSSchema} object to which this component * belongs. *
* In case of XSEmpty
component, this method
* returns null since there is no owner component.
*/
XSSchema getOwnerSchema();
/**
* Gets the root schema set that includes this component.
*
*
* In case of XSEmpty
component, this method
* returns null since there is no owner component.
*/
XSSchemaSet getRoot();
/**
* Gets the {@link SchemaDocument} that indicates which document this component
* was defined in.
*
* @return
* null for components that are built-in to XML Schema, such
* as anyType, or "empty" {@link XSContentType}. This method also
* returns null for {@link XSSchema}.
* For all other user-defined
* components this method returns non-null, even if they are local.
*/
SchemaDocument getSourceDocument();
/**
* 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