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

public abstract Class TREXBaseReader

extends GrammarReader
Class Inheritance
Known Direct Subclasses
com.sun.msv.reader.trex.classic.TREXGrammarReader, com.sun.msv.reader.trex.ng.RELAXNGReader
Imports
java.text.MessageFormat, java.util.ResourceBundle, javax.xml.parsers.SAXParserFactory, org.xml.sax.Attributes, .SAXException, com.sun.msv.grammar.Expression, .ExpressionPool, .Grammar, com.sun.msv.grammar.trex.TREXGrammar, com.sun.msv.reader.ChoiceState, .GrammarReader, .GrammarReaderController, .InterleaveState, .SequenceState, .State, .TerminalState, com.sun.msv.util.LightStack, .StartTagInfo
reads TREX grammar from SAX2 and constructs abstract grammar model.
Author
Kohsuke KAWAGUCHI

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
TREXBaseReader.StateFactory

creates various State object, which in turn parses grammar.

Field Summary

Modifier and TypeField and Description
public static final String
ERR_BAD_COMBINE

public static final String
ERR_COMBINE_MISSING

public static final String
ERR_DUPLICATE_DEFINITION

public static final String
ERR_INTERLEAVED_ANYSTRING

public static final String
ERR_INTERLEAVED_STRING

public static final String
ERR_MISSING_CHILD_NAMECLASS

public static final String
ERR_MORE_THAN_ONE_NAMECLASS

public static final String
ERR_NONEXISTENT_PARENT_GRAMMAR

public static final String
ERR_REPEATED_STRING

public static final String
ERR_SEQUENCED_STRING

public static final String
ERR_UNDECLARED_PREFIX

public static final String
ERR_UNDEFINED_PATTERN

public static final String
ERR_UNKNOWN_DATATYPE_VOCABULARY

protected TREXGrammar
grammar

grammar object currently being loaded.

private LightStack
nsStack

stack that stores value of ancestor 'ns' attribute.

public final TREXBaseReader.StateFactory
sfactory

protected String
targetNamespace

target namespace: currently active 'ns' attribute

public static final String
WRN_COMBINE_IGNORED

public static final String
WRN_OBSOLETED_XMLSCHEMA_NAMSPACE

Inherited from com.sun.msv.reader.GrammarReader:
backwardReferencebasePrefixResolvercontrollerERR_BAD_ATTRIBUTE_VALUEERR_BAD_TYPEERR_CHARACTERSERR_CONFLICTING_ATTRIBUTESERR_DATATYPE_ALREADY_DEFINEDERR_DISALLOWED_ATTRIBUTEERR_FRAGMENT_IDENTIFIERERR_ILLEGAL_FINAL_VALUEERR_MALPLACED_ELEMENTERR_MISSING_ATTRIBUTEERR_MISSING_ATTRIBUTE_2ERR_MISSING_CHILD_EXPRESSIONERR_MISSING_CHILD_TYPEERR_MISSING_TOPLEVELERR_MORE_THAN_ONE_CHILD_EXPRESSIONERR_MORE_THAN_ONE_CHILD_TYPEERR_RECURSIVE_DATATYPEERR_RECURSIVE_INCLUDEERR_RUNAWAY_EXPRESSIONERR_UNDEFINED_DATATYPEparserFactorypoolprefixResolverWRN_DEPRECATED_TYPENAMEWRN_MAYBE_WRONG_NAMESPACE

Constructor Summary

AccessConstructor and Description
public
TREXBaseReader(GrammarReaderController controller, SAXParserFactory parserFactory, ExpressionPool pool, TREXBaseReader.StateFactory stateFactory, State rootState)

full constructor

Method Summary

Modifier and TypeMethod and Description
public State
createExpressionChildState(State parent, StartTagInfo tag)

Implements abstract com.sun.msv.reader.GrammarReader.createExpressionChildState.

this method must be implemented by the derived class to create language-default expresion state.
protected State
createNameClassChildState(State parent, StartTagInfo tag)

public void
endElement(String
The element's Namespace URI, or the empty string.
a, String
The element's local name, or the empty string.
b, String
The element's qualified (prefixed) name, or the empty string.
c)

Overrides org.xml.sax.helpers.XMLFilterImpl.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Filter an end element event.
public final TREXGrammar
getResult()

obtains parsed grammar object only if parsing was successful.

public Grammar
getResultAsGrammar()

Implements abstract com.sun.msv.reader.GrammarReader.getResultAsGrammar.

gets the parsed AGM.
public final String
getTargetNamespace()

protected String
localizeMessage(String propertyName, Object[] args)

Implements abstract com.sun.msv.reader.GrammarReader.localizeMessage.

formats localized message with arguments
public void
startElement(String
The element's Namespace URI, or the empty string.
a, String
The element's local name, or the empty string.
b, String
The element's qualified (prefixed) name, or the empty string.
c, Attributes
The element's attributes.
d)

Overrides org.xml.sax.helpers.XMLFilterImpl.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Filter a start element event.
public void
wrapUp()

performs final wrap-up.

Inherited from com.sun.msv.reader.GrammarReader:
_parseaddBackPatchJobaddBackPatchJobcombineURIcombineURLcreateParserFactorydetectUndefinedOnesendPrefixMappinggetBackwardCompatibleTypegetBaseUrigetCurrentStategetDeclaredLocationOfgetLocatorinputSourceFromLSInputinterceptExpressionisGrammarElementisNotationisUnparsedEntityiterateInscopeNamespacesonIDparseparseparsepopStatepushStatereportErrorreportErrorreportErrorreportErrorreportErrorreportErrorreportErrorreportErrorreportWarningreportWarningreportWarningreportWarningresolveLocationresolveNamespacePrefixrunBackPatchJobsetDeclaredLocationOfsetDocumentLocatorsetLocatorsplitQNamestartPrefixMappingswitchSourceswitchSourceswitchSource

Field Detail

ERR_BAD_COMBINEback to summary
public static final String ERR_BAD_COMBINE
ERR_COMBINE_MISSINGback to summary
public static final String ERR_COMBINE_MISSING
ERR_DUPLICATE_DEFINITIONback to summary
public static final String ERR_DUPLICATE_DEFINITION
ERR_INTERLEAVED_ANYSTRINGback to summary
public static final String ERR_INTERLEAVED_ANYSTRING
ERR_INTERLEAVED_STRINGback to summary
public static final String ERR_INTERLEAVED_STRING
ERR_MISSING_CHILD_NAMECLASSback to summary
public static final String ERR_MISSING_CHILD_NAMECLASS
ERR_MORE_THAN_ONE_NAMECLASSback to summary
public static final String ERR_MORE_THAN_ONE_NAMECLASS
ERR_NONEXISTENT_PARENT_GRAMMARback to summary
public static final String ERR_NONEXISTENT_PARENT_GRAMMAR
ERR_REPEATED_STRINGback to summary
public static final String ERR_REPEATED_STRING
ERR_SEQUENCED_STRINGback to summary
public static final String ERR_SEQUENCED_STRING
ERR_UNDECLARED_PREFIXback to summary
public static final String ERR_UNDECLARED_PREFIX
ERR_UNDEFINED_PATTERNback to summary
public static final String ERR_UNDEFINED_PATTERN
ERR_UNKNOWN_DATATYPE_VOCABULARYback to summary
public static final String ERR_UNKNOWN_DATATYPE_VOCABULARY
grammarback to summary
protected TREXGrammar grammar

grammar object currently being loaded.

nsStackback to summary
private LightStack nsStack

stack that stores value of ancestor 'ns' attribute.

sfactoryback to summary
public final TREXBaseReader.StateFactory sfactory
targetNamespaceback to summary
protected String targetNamespace

target namespace: currently active 'ns' attribute

WRN_COMBINE_IGNOREDback to summary
public static final String WRN_COMBINE_IGNORED
WRN_OBSOLETED_XMLSCHEMA_NAMSPACEback to summary
public static final String WRN_OBSOLETED_XMLSCHEMA_NAMSPACE

Constructor Detail

TREXBaseReaderback to summary
public TREXBaseReader(GrammarReaderController controller, SAXParserFactory parserFactory, ExpressionPool pool, TREXBaseReader.StateFactory stateFactory, State rootState)

full constructor

Method Detail

createExpressionChildStateback to summary
public State createExpressionChildState(State parent, StartTagInfo tag)

Implements abstract com.sun.msv.reader.GrammarReader.createExpressionChildState.

Doc from com.sun.msv.reader.GrammarReader.createExpressionChildState.

this method must be implemented by the derived class to create language-default expresion state.

Returns:State

null if the start tag is an error.

createNameClassChildStateback to summary
protected State createNameClassChildState(State parent, StartTagInfo tag)
endElementback to summary
public void endElement(String a, String b, String c) throws SAXException

Overrides org.xml.sax.helpers.XMLFilterImpl.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.helpers.XMLFilterImpl.endElement.

Filter an end element event.

Parameters
a:String

The element's Namespace URI, or the empty string.

b:String

The element's local name, or the empty string.

c:String

The element's qualified (prefixed) name, or the empty string.

Exceptions
SAXException:
The client may throw an exception during processing.
getResultback to summary
public final TREXGrammar getResult()

obtains parsed grammar object only if parsing was successful.

getResultAsGrammarback to summary
public Grammar getResultAsGrammar()

Implements abstract com.sun.msv.reader.GrammarReader.getResultAsGrammar.

Doc from com.sun.msv.reader.GrammarReader.getResultAsGrammar.

gets the parsed AGM. Should any error happens, this method should returns null. derived classes should implement type-safe getGrammar method, along with this method.

getTargetNamespaceback to summary
public final String getTargetNamespace()
localizeMessageback to summary
protected String localizeMessage(String propertyName, Object[] args)

Implements abstract com.sun.msv.reader.GrammarReader.localizeMessage.

Doc from com.sun.msv.reader.GrammarReader.localizeMessage.

formats localized message with arguments

startElementback to summary
public void startElement(String a, String b, String c, Attributes d) throws SAXException

Overrides org.xml.sax.helpers.XMLFilterImpl.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.helpers.XMLFilterImpl.startElement.

Filter a start element event.

Parameters
a:String

The element's Namespace URI, or the empty string.

b:String

The element's local name, or the empty string.

c:String

The element's qualified (prefixed) name, or the empty string.

d:Attributes

The element's attributes.

Exceptions
SAXException:
The client may throw an exception during processing.
wrapUpback to summary
public void wrapUp()

performs final wrap-up. This method is called from the RootState object, after the parsing is completed.

This method has to be called after the run-away expression check is done.

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

public abstract Class TREXBaseReader.StateFactory

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.msv.reader.trex.classic.TREXGrammarReader.StateFactory, com.sun.msv.reader.trex.ng.RELAXNGReader.StateFactory
creates various State object, which in turn parses grammar. parsing behavior can be customized by implementing custom StateFactory.

Constructor Summary

AccessConstructor and Description
public
StateFactory()

Method Summary

Modifier and TypeMethod and Description
public State
attribute(State parent, StartTagInfo tag)

public State
choice(State parent, StartTagInfo tag)

public TREXGrammar
createGrammar(ExpressionPool pool, TREXGrammar parent)

public abstract State
define(State parent, StartTagInfo tag)

public State
divInGrammar(State parent, StartTagInfo tag)

public State
element(State parent, StartTagInfo tag)

public State
empty(State parent, StartTagInfo tag)

public State
grammar(State parent, StartTagInfo tag)

public State
group(State parent, StartTagInfo tag)

public State
includedGrammar()

public State
includeGrammar(State parent, StartTagInfo tag)

public State
interleave(State parent, StartTagInfo tag)

public State
mixed(State parent, StartTagInfo tag)

public State
notAllowed(State parent, StartTagInfo tag)

public State
nsAnyName(State parent, StartTagInfo tag)

public State
nsChoice(State parent, StartTagInfo tag)

public State
nsDifference(State parent, StartTagInfo tag)

public State
nsName(State parent, StartTagInfo tag)

public State
nsNot(State parent, StartTagInfo tag)

public State
nsNsName(State parent, StartTagInfo tag)

public State
oneOrMore(State parent, StartTagInfo tag)

public State
optional(State parent, StartTagInfo tag)

public State
ref(State parent, StartTagInfo tag)

public State
start(State parent, StartTagInfo tag)

public State
zeroOrMore(State parent, StartTagInfo tag)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

StateFactoryback to summary
public StateFactory()

Method Detail

attributeback to summary
public State attribute(State parent, StartTagInfo tag)
choiceback to summary
public State choice(State parent, StartTagInfo tag)
createGrammarback to summary
public TREXGrammar createGrammar(ExpressionPool pool, TREXGrammar parent)
defineback to summary
public abstract State define(State parent, StartTagInfo tag)
divInGrammarback to summary
public State divInGrammar(State parent, StartTagInfo tag)
elementback to summary
public State element(State parent, StartTagInfo tag)
emptyback to summary
public State empty(State parent, StartTagInfo tag)
grammarback to summary
public State grammar(State parent, StartTagInfo tag)
groupback to summary
public State group(State parent, StartTagInfo tag)
includedGrammarback to summary
public State includedGrammar()
includeGrammarback to summary
public State includeGrammar(State parent, StartTagInfo tag)
interleaveback to summary
public State interleave(State parent, StartTagInfo tag)
mixedback to summary
public State mixed(State parent, StartTagInfo tag)
notAllowedback to summary
public State notAllowed(State parent, StartTagInfo tag)
nsAnyNameback to summary
public State nsAnyName(State parent, StartTagInfo tag)
nsChoiceback to summary
public State nsChoice(State parent, StartTagInfo tag)
nsDifferenceback to summary
public State nsDifference(State parent, StartTagInfo tag)
nsNameback to summary
public State nsName(State parent, StartTagInfo tag)
nsNotback to summary
public State nsNot(State parent, StartTagInfo tag)
nsNsNameback to summary
public State nsNsName(State parent, StartTagInfo tag)
oneOrMoreback to summary
public State oneOrMore(State parent, StartTagInfo tag)
optionalback to summary
public State optional(State parent, StartTagInfo tag)
refback to summary
public State ref(State parent, StartTagInfo tag)
startback to summary
public State start(State parent, StartTagInfo tag)
zeroOrMoreback to summary
public State zeroOrMore(State parent, StartTagInfo tag)