All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.tools.rngom.ast.builder.SchemaBuilder Maven / Gradle / Ivy

There is a newer version: 4.0.5
Show newest version
/*
 * Copyright (C) 2004-2015
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.sun.tools.rngom.ast.builder;

import com.sun.tools.rngom.ast.om.Location;
import com.sun.tools.rngom.ast.om.ParsedElementAnnotation;
import com.sun.tools.rngom.ast.om.ParsedPattern;
import com.sun.tools.rngom.nc.NameClass;
import com.sun.tools.rngom.ast.om.ParsedNameClass;
import com.sun.tools.rngom.parse.*;

import java.util.List;

// TODO: define combine error check should be done by the parser.
public interface SchemaBuilder<
    N extends ParsedNameClass,
    P extends ParsedPattern,
    E extends ParsedElementAnnotation,
    L extends Location,
    A extends Annotations,
    CL extends CommentList> {

    /**
     * Returns the {@link NameClassBuilder}, which is used to build name
     * classes for this . The
     * {@link NameClass}es that are built will then be
     * fed into this to further build RELAX NG patterns.
     * 
     * @return always return a non-null valid object. This method can (and
     *         probably should) always return the same object.
     */
    NameClassBuilder getNameClassBuilder() throws BuildException;

    P makeChoice(List

patterns, L loc, A anno) throws BuildException; P makeInterleave(List

patterns, L loc, A anno) throws BuildException; P makeGroup(List

patterns, L loc, A anno) throws BuildException; P makeOneOrMore(P p, L loc, A anno) throws BuildException; P makeZeroOrMore(P p, L loc, A anno) throws BuildException; P makeOptional(P p, L loc, A anno) throws BuildException; P makeList(P p, L loc, A anno) throws BuildException; P makeMixed(P p, L loc, A anno) throws BuildException; P makeEmpty(L loc, A anno); P makeNotAllowed(L loc, A anno); P makeText(L loc, A anno); P makeAttribute(N nc, P p, L loc, A anno) throws BuildException; P makeElement(N nc, P p, L loc, A anno) throws BuildException; DataPatternBuilder makeDataPatternBuilder(String datatypeLibrary, String type, L loc) throws BuildException; P makeValue(String datatypeLibrary, String type, String value, Context c, String ns, L loc, A anno) throws BuildException; /** * * @param parent * The parent scope. null if there's no parent scope. * For example, if the complete document looks like the following: *

{@code
     *      
     *        
     *      
     *      }
* Then when the outer-most {@link Grammar} is created, it will * receive the {@code null} parent. */ Grammar makeGrammar(Scope parent); /** * Called when annotation is found right inside a pattern * * such as, * *
{@code
     *      
     *    
     *   ...
     * 
     * }
*/ P annotate(P p, A anno) throws BuildException; /** * Called when element annotation is found after a pattern. * * such as, * *
{@code
     * 
     *                 
     *    
     * 
     * }
*/ P annotateAfter(P p, E e) throws BuildException; P commentAfter(P p, CL comments) throws BuildException; /** * * @param current * Current grammar that we are parsing. This is what contains * externalRef. * @param scope * The parent scope. null if there's no parent scope. * See {@link #makeGrammar(Scope)} for more details about * when this parameter can be null. */ P makeExternalRef(Parseable current, String uri, String ns, Scope scope, L loc, A anno) throws BuildException, IllegalSchemaException; L makeLocation(String systemId, int lineNumber, int columnNumber); /** * Creates {@link Annotations} object to parse annotations on patterns. * * @return * must be non-null. */ A makeAnnotations(CL comments, Context context); ElementAnnotationBuilder makeElementAnnotationBuilder(String ns, String localName, String prefix, L loc, CL comments, Context context); CL makeCommentList(); P makeErrorPattern(); /** * If this is interested in actually parsing * comments, this method returns true. *

* Returning false allows the schema parser to speed up the processing by * skiping comment-related handlings. */ boolean usesComments(); /** * Called after all the parsing is done. * *

* This hook typically allows as to expand * notAllowed (if it's following the simplification as in the spec.) */ P expandPattern( P p ) throws BuildException, IllegalSchemaException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy