1 /*
   2  * Copyright (c) 2005, 2015, 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.ast.util;
  47 
  48 import com.sun.xml.internal.rngom.ast.builder.BuildException;
  49 import com.sun.xml.internal.rngom.ast.builder.SchemaBuilder;
  50 import com.sun.xml.internal.rngom.ast.om.ParsedPattern;
  51 import com.sun.xml.internal.rngom.binary.SchemaBuilderImpl;
  52 import com.sun.xml.internal.rngom.binary.SchemaPatternBuilder;
  53 import com.sun.xml.internal.rngom.parse.IllegalSchemaException;
  54 import com.sun.xml.internal.rngom.parse.host.ParsedPatternHost;
  55 import com.sun.xml.internal.rngom.parse.host.SchemaBuilderHost;
  56 import com.sun.xml.internal.org.relaxng.datatype.DatatypeLibraryFactory;
  57 import org.xml.sax.ErrorHandler;
  58 
  59 /**
  60  * Wraps a {@link SchemaBuilder} and does all the semantic checks
  61  * required by the RELAX NG spec.
  62  *
  63  * <h2>Usage</h2>
  64  * <p>
  65  * Whereas you normally write it as follows:
  66  * <pre>
  67  * YourParsedPattern r = (YourParsedPattern)parseable.parse(sb);
  68  * </pre>
  69  * write this as follows:
  70  * <pre>
  71  * YourParsedPattern r = (YourParsedPattern)parseable.parse(new CheckingSchemaBuilder(sb,eh));
  72  * </pre>
  73  *
  74  * <p>
  75  * The checking is done by using the <tt>rngom.binary</tt> package, so if you are using
  76  * that package for parsing schemas, then there's no need to use this.
  77  *
  78  * @author
  79  *      Kohsuke Kawaguchi (kk@kohsuke.org)
  80  */
  81 public class CheckingSchemaBuilder extends SchemaBuilderHost {
  82     /**
  83      *
  84      * @param sb
  85      *      Your {@link SchemaBuilder} that parses RELAX NG schemas.
  86      * @param eh
  87      *      All the errors found will be sent to this handler.
  88      */
  89     public CheckingSchemaBuilder( SchemaBuilder sb, ErrorHandler eh ) {
  90         super(new SchemaBuilderImpl(eh),sb);
  91     }
  92     public CheckingSchemaBuilder( SchemaBuilder sb, ErrorHandler eh, DatatypeLibraryFactory dlf ) {
  93         super(new SchemaBuilderImpl(eh,dlf,new SchemaPatternBuilder()),sb);
  94     }
  95 
  96     public ParsedPattern expandPattern(ParsedPattern p)
  97         throws BuildException, IllegalSchemaException {
  98 
  99         // just return the result from the user-given SchemaBuilder
 100         ParsedPatternHost r = (ParsedPatternHost)super.expandPattern(p);
 101         return r.rhs;
 102     }
 103 }