com.sun.msv.grammar.trex.TREXGrammar Maven / Gradle / Ivy
/*
* Copyright (c) 2001-2013 Oracle and/or its affiliates. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of Oracle nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.sun.msv.grammar.trex;
import com.sun.msv.grammar.Expression;
import com.sun.msv.grammar.ExpressionPool;
import com.sun.msv.grammar.Grammar;
import com.sun.msv.grammar.ReferenceContainer;
import com.sun.msv.grammar.ReferenceExp;
import com.sun.msv.reader.datatype.DataTypeVocabularyMap;
/**
* TREX grammar, which is expressed as <grammar> element.
*
*
* The exp field keeps the start pattern.
*
* @author Kohsuke KAWAGUCHI
*/
public class TREXGrammar extends ReferenceExp implements Grammar{
static final public class RefContainer extends ReferenceContainer {
public ReferenceExp getOrCreate( String name ) {
return super._getOrCreate(name);
}
protected ReferenceExp createReference( String name ) {
return new ReferenceExp(name);
}
}
/** named patterns which are defined by using <define> element.
*
* this is a map from pattern name to RefPattern object
*/
public final RefContainer namedPatterns = new RefContainer();
/** gets the start pattern.
*
* The pattern defined under <start> element.
* This pattern will be used to verify document element.
*/
public Expression getTopLevel() { return this.exp; }
/** ExpressionPool that is associated with this grammar */
public final ExpressionPool pool;
public ExpressionPool getPool() { return pool; }
/** in case of nested grammar, this variable points to the parent grammar.
* Otherwise null.
*/
protected final TREXGrammar parentGrammar;
/**
* gets a parent TREXGrammar.
*
* In case of nested grammar, the parent grammar will be returned.
* Otherwise, it returns null.
*/
public final TREXGrammar getParentGrammar() { return parentGrammar; }
/**
* data type vocabularies used and defined by this grammar.
*/
public final DataTypeVocabularyMap dataTypes = new DataTypeVocabularyMap();
/**
*
* @param parentGrammar
* this object is used to resolve <ref> element with parent
* attribute.
*/
public TREXGrammar( ExpressionPool pool, TREXGrammar parentGrammar ) {
super(null);
this.pool = pool;
this.parentGrammar = parentGrammar;
}
public TREXGrammar( ExpressionPool pool ) { this(pool,null); }
public TREXGrammar() { this(new ExpressionPool(),null); }
// serialization support
private static final long serialVersionUID = 1;
}