1 /*
   2  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 /*
  26  * Copyright (C) 2004-2011
  27  *
  28  * Permission is hereby granted, free of charge, to any person obtaining a copy
  29  * of this software and associated documentation files (the "Software"), to deal
  30  * in the Software without restriction, including without limitation the rights
  31  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  32  * copies of the Software, and to permit persons to whom the Software is
  33  * furnished to do so, subject to the following conditions:
  34  *
  35  * The above copyright notice and this permission notice shall be included in
  36  * all copies or substantial portions of the Software.
  37  *
  38  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  39  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  40  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  41  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  42  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  43  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  44  * THE SOFTWARE.
  45  */
  46 package com.sun.xml.internal.rngom.parse;
  47 
  48 import com.sun.xml.internal.rngom.ast.builder.*;
  49 import com.sun.xml.internal.rngom.ast.om.*;
  50 
  51 /**
  52  * An input that can be turned into a RELAX NG pattern.
  53  *
  54  * <p>
  55  * This is either a RELAX NG schema in the XML format, or a RELAX NG
  56  * schema in the compact syntax.
  57  */
  58 public interface Parseable {
  59     /**
  60      * Parses this {@link Parseable} object into a RELAX NG pattern.
  61      *
  62      * @param sb
  63      *      The builder of the schema object model. This object
  64      *      dictates how the actual pattern is constructed.
  65      *
  66      * @return
  67      *      a parsed object. Always returns a non-null valid object.
  68      */
  69     <P extends ParsedPattern> P parse(SchemaBuilder<?,P,?,?,?,?> sb) throws BuildException, IllegalSchemaException;
  70 
  71     /**
  72      * Called from {@link Include} in response to
  73      * {@link Include#endInclude(Parseable, String, String, Location, Annotations)}
  74      * to parse the included grammar.
  75      *
  76      * @param g
  77      *      receives the events from the included grammar.
  78      */
  79     <P extends ParsedPattern> P parseInclude(String uri, SchemaBuilder<?,P,?,?,?,?> f, IncludedGrammar<P,?,?,?,?> g, String inheritedNs)
  80         throws BuildException, IllegalSchemaException;
  81 
  82     /**
  83      * Called from {@link SchemaBuilder} in response to
  84      * {@link SchemaBuilder#makeExternalRef(Parseable, String, String, Scope, Location, Annotations)}
  85      * to parse the referenced grammar.
  86      *
  87      * @param f
  88      *      receives the events from the referenced grammar.
  89      */
  90     <P extends ParsedPattern> P parseExternal(String uri, SchemaBuilder<?,P,?,?,?,?> f, Scope s, String inheritedNs)
  91         throws BuildException, IllegalSchemaException;
  92 }