325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A/*
325N/A * Copyright (C) 2004-2011
325N/A *
325N/A * Permission is hereby granted, free of charge, to any person obtaining a copy
325N/A * of this software and associated documentation files (the "Software"), to deal
325N/A * in the Software without restriction, including without limitation the rights
325N/A * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
325N/A * copies of the Software, and to permit persons to whom the Software is
325N/A * furnished to do so, subject to the following conditions:
325N/A *
325N/A * The above copyright notice and this permission notice shall be included in
325N/A * all copies or substantial portions of the Software.
325N/A *
325N/A * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
325N/A * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
325N/A * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
325N/A * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
325N/A * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
325N/A * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
325N/A * THE SOFTWARE.
325N/A */
325N/Apackage com.sun.xml.internal.rngom.ast.builder;
325N/A
325N/Aimport com.sun.xml.internal.rngom.ast.om.Location;
325N/Aimport com.sun.xml.internal.rngom.ast.om.ParsedElementAnnotation;
325N/Aimport com.sun.xml.internal.rngom.ast.om.ParsedNameClass;
325N/Aimport com.sun.xml.internal.rngom.ast.om.ParsedPattern;
325N/Aimport com.sun.xml.internal.rngom.parse.*;
325N/Aimport com.sun.xml.internal.rngom.parse.IllegalSchemaException;
325N/Aimport com.sun.xml.internal.rngom.parse.Parseable;
325N/A
325N/Aimport java.util.List;
325N/A
325N/A// TODO: define combine error check should be done by the parser.
325N/Apublic interface SchemaBuilder<
325N/A N extends ParsedNameClass,
325N/A P extends ParsedPattern,
325N/A E extends ParsedElementAnnotation,
325N/A L extends Location,
325N/A A extends Annotations<E,L,CL>,
325N/A CL extends CommentList<L>> {
325N/A
325N/A /**
325N/A * Returns the {@link NameClassBuilder}, which is used to build name
325N/A * classes for this {@link SchemaBuilder}. The
325N/A * {@link com.sun.xml.internal.rngom.nc.NameClass}es that are built will then be
325N/A * fed into this {@link SchemaBuilder}to further build RELAX NG patterns.
325N/A *
325N/A * @return always return a non-null valid object. This method can (and
325N/A * probably should) always return the same object.
325N/A */
325N/A NameClassBuilder<N,E,L,A,CL> getNameClassBuilder() throws BuildException;
325N/A
325N/A P makeChoice(List<P> patterns, L loc, A anno) throws BuildException;
325N/A
325N/A P makeInterleave(List<P> patterns, L loc, A anno) throws BuildException;
325N/A
325N/A P makeGroup(List<P> patterns, L loc, A anno) throws BuildException;
325N/A
325N/A P makeOneOrMore(P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeZeroOrMore(P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeOptional(P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeList(P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeMixed(P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeEmpty(L loc, A anno);
325N/A
325N/A P makeNotAllowed(L loc, A anno);
325N/A
325N/A P makeText(L loc, A anno);
325N/A
325N/A P makeAttribute(N nc, P p, L loc, A anno) throws BuildException;
325N/A
325N/A P makeElement(N nc, P p, L loc, A anno) throws BuildException;
325N/A
325N/A DataPatternBuilder makeDataPatternBuilder(String datatypeLibrary, String type, L loc) throws BuildException;
325N/A
325N/A P makeValue(String datatypeLibrary, String type, String value,
325N/A Context c, String ns, L loc, A anno) throws BuildException;
325N/A
325N/A /**
325N/A *
325N/A * @param parent
325N/A * The parent scope. null if there's no parent scope.
325N/A * For example, if the complete document looks like the following:
325N/A * <pre><xmp>
325N/A * <grammar>
325N/A * <start><element name="root"><empty/></element></start>
325N/A * </grammar>
325N/A * </xmp></pre>
325N/A * Then when the outer-most {@link Grammar} is created, it will
325N/A * receive the <tt>null</tt> parent.
325N/A */
325N/A Grammar<P,E,L,A,CL> makeGrammar(Scope<P,E,L,A,CL> parent);
325N/A
325N/A /**
325N/A * Called when annotation is found right inside a pattern
325N/A *
325N/A * such as,
325N/A *
325N/A * <pre><xmp>
325N/A * <element name="foo"> <!-- this becomes 'P' -->
325N/A * <foreign:annotation /> <!-- this becomes 'A' -->
325N/A * ...
325N/A * </element>
325N/A * </xmp></pre>
325N/A */
325N/A P annotate(P p, A anno) throws BuildException;
325N/A
325N/A /**
325N/A * Called when element annotation is found after a pattern.
325N/A *
325N/A * such as,
325N/A *
325N/A * <pre><xmp>
325N/A * <element name="foo">
325N/A * <empty /> <!-- this becomes 'P' -->
325N/A * <foreign:annotation /> <!-- this becomes 'E' -->
325N/A * </element>
325N/A * </xmp></pre>
325N/A */
325N/A P annotateAfter(P p, E e) throws BuildException;
325N/A
325N/A P commentAfter(P p, CL comments) throws BuildException;
325N/A
325N/A /**
325N/A *
325N/A * @param current
325N/A * Current grammar that we are parsing. This is what contains
325N/A * externalRef.
325N/A * @param scope
325N/A * The parent scope. null if there's no parent scope.
325N/A * See {@link #makeGrammar(Scope)} for more details about
325N/A * when this parameter can be null.
325N/A */
325N/A P makeExternalRef(Parseable current, String uri, String ns, Scope<P,E,L,A,CL> scope,
325N/A L loc, A anno) throws BuildException, IllegalSchemaException;
325N/A
325N/A L makeLocation(String systemId, int lineNumber, int columnNumber);
325N/A
325N/A /**
325N/A * Creates {@link Annotations} object to parse annotations on patterns.
325N/A *
325N/A * @return
325N/A * must be non-null.
325N/A */
325N/A A makeAnnotations(CL comments, Context context);
325N/A
325N/A ElementAnnotationBuilder<P,E,L,A,CL> makeElementAnnotationBuilder(String ns,
325N/A String localName, String prefix, L loc, CL comments,
325N/A Context context);
325N/A
325N/A CL makeCommentList();
325N/A
325N/A P makeErrorPattern();
325N/A
325N/A /**
325N/A * If this {@link SchemaBuilder}is interested in actually parsing
325N/A * comments, this method returns true.
325N/A * <p>
325N/A * Returning false allows the schema parser to speed up the processing by
325N/A * skiping comment-related handlings.
325N/A */
325N/A boolean usesComments();
325N/A
325N/A /**
325N/A * Called after all the parsing is done.
325N/A *
325N/A * <p>
325N/A * This hook typically allows as {@link SchemaBuilder} to expand
325N/A * notAllowed (if it's following the simplification as in the spec.)
325N/A */
325N/A P expandPattern( P p ) throws BuildException, IllegalSchemaException;
325N/A}