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 package com.sun.xml.internal.rngom.ast.util;
  27 
  28 import com.sun.xml.internal.rngom.ast.builder.BuildException;
  29 import com.sun.xml.internal.rngom.ast.builder.SchemaBuilder;
  30 import com.sun.xml.internal.rngom.ast.om.ParsedPattern;
  31 import com.sun.xml.internal.rngom.binary.SchemaBuilderImpl;
  32 import com.sun.xml.internal.rngom.binary.SchemaPatternBuilder;
  33 import com.sun.xml.internal.rngom.parse.IllegalSchemaException;
  34 import com.sun.xml.internal.rngom.parse.host.ParsedPatternHost;
  35 import com.sun.xml.internal.rngom.parse.host.SchemaBuilderHost;
  36 import org.relaxng.datatype.DatatypeLibraryFactory;
  37 import org.xml.sax.ErrorHandler;
  38 
  39 /**
  40  * Wraps a {@link SchemaBuilder} and does all the semantic checks
  41  * required by the RELAX NG spec.
  42  *
  43  * <h2>Usage</h2>
  44  * <p>
  45  * Whereas you normally write it as follows:
  46  * <pre>
  47  * YourParsedPattern r = (YourParsedPattern)parseable.parse(sb);
  48  * </pre>
  49  * write this as follows:
  50  * <pre>
  51  * YourParsedPattern r = (YourParsedPattern)parseable.parse(new CheckingSchemaBuilder(sb,eh));
  52  * </pre>
  53  *
  54  * <p>
  55  * The checking is done by using the <tt>rngom.binary</tt> package, so if you are using
  56  * that package for parsing schemas, then there's no need to use this.
  57  *
  58  * @author
  59  *      Kohsuke Kawaguchi (kk@kohsuke.org)
  60  */
  61 public class CheckingSchemaBuilder extends SchemaBuilderHost {
  62     /**
  63      *
  64      * @param sb
  65      *      Your {@link SchemaBuilder} that parses RELAX NG schemas.
  66      * @param eh
  67      *      All the errors found will be sent to this handler.
  68      */
  69     public CheckingSchemaBuilder( SchemaBuilder sb, ErrorHandler eh ) {
  70         super(new SchemaBuilderImpl(eh),sb);
  71     }
  72     public CheckingSchemaBuilder( SchemaBuilder sb, ErrorHandler eh, DatatypeLibraryFactory dlf ) {
  73         super(new SchemaBuilderImpl(eh,dlf,new SchemaPatternBuilder()),sb);
  74     }
  75 
  76     public ParsedPattern expandPattern(ParsedPattern p)
  77         throws BuildException, IllegalSchemaException {
  78 
  79         // just return the result from the user-given SchemaBuilder
  80         ParsedPatternHost r = (ParsedPatternHost)super.expandPattern(p);
  81         return r.rhs;
  82     }
  83 }