Top Description Inners Fields Constructors Methods
com.sun.msv.grammar.trex

public Class TREXGrammar

extends ReferenceExp
implements Grammar
Class Inheritance
All Implemented Interfaces
com.sun.msv.grammar.Grammar, java.io.Serializable
Known Direct Subclasses
com.sun.msv.grammar.relaxng.RELAXNGGrammar
Imports
com.sun.msv.grammar.Expression, .ExpressionPool, .Grammar, .ReferenceContainer, .ReferenceExp, com.sun.msv.reader.datatype.DataTypeVocabularyMap

TREX grammar, which is expressed as <grammar> element.

The exp field keeps the start pattern.

Author
Kohsuke KAWAGUCHI

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public final DataTypeVocabularyMap
dataTypes

data type vocabularies used and defined by this grammar.

public final TREXGrammar.RefContainer
namedPatterns

named patterns which are defined by using <define> element.

protected final TREXGrammar
parentGrammar

in case of nested grammar, this variable points to the parent grammar.

public final ExpressionPool
pool

ExpressionPool that is associated with this grammar

private static final long
Inherited from com.sun.msv.grammar.ReferenceExp:
expname

Constructor Summary

AccessConstructor and Description
public
TREXGrammar(ExpressionPool pool, TREXGrammar
this object is used to resolve <ref> element with parent attribute.
parentGrammar
)

public
public

Method Summary

Modifier and TypeMethod and Description
public final TREXGrammar
getParentGrammar()

gets a parent TREXGrammar.

public ExpressionPool
getPool()

Implements com.sun.msv.grammar.Grammar.getPool.

gets ExpressionPool object which was used to construct this grammar.
public Expression
getTopLevel()

Implements com.sun.msv.grammar.Grammar.getTopLevel.

gets the start pattern.
Inherited from com.sun.msv.grammar.ReferenceExp:
calcEpsilonReducibilitycalcHashCodeequalsisDefinedvisitvisitvisitvisit

Field Detail

dataTypesback to summary
public final DataTypeVocabularyMap dataTypes

data type vocabularies used and defined by this grammar.

namedPatternsback to summary
public final TREXGrammar.RefContainer namedPatterns

named patterns which are defined by using <define> element. this is a map from pattern name to RefPattern object

parentGrammarback to summary
protected final TREXGrammar parentGrammar

in case of nested grammar, this variable points to the parent grammar. Otherwise null.

poolback to summary
public final ExpressionPool pool

ExpressionPool that is associated with this grammar

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.sun.msv.grammar.ReferenceExp.serialVersionUID.

Constructor Detail

TREXGrammarback to summary
public TREXGrammar(ExpressionPool pool, TREXGrammar parentGrammar)
Parameters
parentGrammar:TREXGrammar

this object is used to resolve <ref> element with parent attribute.

TREXGrammarback to summary
public TREXGrammar(ExpressionPool pool)
TREXGrammarback to summary
public TREXGrammar()

Method Detail

getParentGrammarback to summary
public final TREXGrammar getParentGrammar()

gets a parent TREXGrammar. In case of nested grammar, the parent grammar will be returned. Otherwise, it returns null.

getPoolback to summary
public ExpressionPool getPool()

Implements com.sun.msv.grammar.Grammar.getPool.

Doc from com.sun.msv.grammar.Grammar.getPool.

gets ExpressionPool object which was used to construct this grammar. Never return null.

getTopLevelback to summary
public Expression getTopLevel()

Implements com.sun.msv.grammar.Grammar.getTopLevel.

gets the start pattern. The pattern defined under <start> element. This pattern will be used to verify document element.

com.sun.msv.grammar.trex back to summary

public final Class TREXGrammar.RefContainer

extends ReferenceContainer
Class Inheritance
Annotations
@SuppressWarnings:serial

Field Summary

Inherited from com.sun.msv.grammar.ReferenceContainer:
impl

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected ReferenceExp
createReference(String name)

Implements abstract com.sun.msv.grammar.ReferenceContainer.createReference.

creates a new reference object with given name
public ReferenceExp
Inherited from com.sun.msv.grammar.ReferenceContainer:
_get_getOrCreategetAlliteratorredefineremovesize

Constructor Detail

RefContainerback to summary
public RefContainer()

Method Detail

createReferenceback to summary
protected ReferenceExp createReference(String name)

Implements abstract com.sun.msv.grammar.ReferenceContainer.createReference.

Doc from com.sun.msv.grammar.ReferenceContainer.createReference.

creates a new reference object with given name

getOrCreateback to summary
public ReferenceExp getOrCreate(String name)