Modifier and Type	Class and Description
public static class	TREXGrammarReader.StateFactory creates various State object, which in turn parses grammar.
private static class	TREXGrammarReader.UndefinedDataTypeVocabulary Dummy DataTypeVocabulary for better error recovery.

Modifier and Type	Field and Description
protected String	currentGrammarURI TREX allows either (1) the predefined namespace for TREX or (2) default namespace "" as its namespace.
private boolean	issueObsoletedXMLSchemaNamespace
public static final String	TREXNamespace Namespace URI of TREX

Access	Constructor and Description
public	TREXGrammarReader(GrammarReaderController controller) easy-to-use constructor.
public	TREXGrammarReader(GrammarReaderController controller, SAXParserFactory parserFactory, ExpressionPool pool) easy-to-use constructor.
public	TREXGrammarReader(GrammarReaderController controller, SAXParserFactory parserFactory, TREXGrammarReader.StateFactory stateFactory, ExpressionPool pool) full constructor

Method Summary

Modifier and Type	Method and Description
public State	createExpressionChildState(State parent, StartTagInfo tag) Overrides com.sun.msv.reader.trex.TREXBaseReader.createExpressionChildState. this method must be implemented by the derived class to create language-default expresion state.
protected TREXGrammar	getGrammar()
protected TREXGrammarReader.StateFactory	getStateFactory()
protected boolean	isGrammarElement(StartTagInfo tag) Implements abstract com.sun.msv.reader.GrammarReader.isGrammarElement. checks if given element is that of the grammar elements.
protected String	localizeMessage(String propertyName, Object[] args) Overrides com.sun.msv.reader.trex.TREXBaseReader.localizeMessage. formats localized message with arguments
private String	mapNamespace(String namespace) maps obsoleted XML Schema namespace to the current one.
public static TREXGrammar	parse(String grammarURL, SAXParserFactory factory, GrammarReaderController controller) loads TREX pattern
public static TREXGrammar	parse(InputSource grammar, SAXParserFactory factory, GrammarReaderController controller) loads TREX pattern
public Datatype	resolveDatatype(String qName) obtains a named DataType object referenced by a QName.
public XSDatatypeExp	resolveXSDatatype(String The type of this value varies in the schema language. In XML Schema, for example, in which QNames are used to designate datatypes, this parameter will be QName. In RELAX Core, in which the same syntax is used but NCName is used to designate datatypes. So this parameter will be NCName. qName) Implements com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype.
public void	wrapUp() Overrides com.sun.msv.reader.trex.TREXBaseReader.wrapUp. performs final wrap-up.

Inherited from com.sun.msv.reader.trex.TREXBaseReader:: createNameClassChildState endElement getResult getResultAsGrammar getTargetNamespace startElement

Field Detail

currentGrammarURI	back to summary
protected String currentGrammarURI TREX allows either (1) the predefined namespace for TREX or (2) default namespace "" as its namespace. This variable holds which namespace is currently in use.

issueObsoletedXMLSchemaNamespace	back to summary
private boolean issueObsoletedXMLSchemaNamespace

TREXNamespace	back to summary
public static final String TREXNamespace Namespace URI of TREX

Constructor Detail

TREXGrammarReader	back to summary
public TREXGrammarReader(GrammarReaderController controller) easy-to-use constructor.

TREXGrammarReader	back to summary
public TREXGrammarReader(GrammarReaderController controller, SAXParserFactory parserFactory, ExpressionPool pool) easy-to-use constructor.

TREXGrammarReader	back to summary
public TREXGrammarReader(GrammarReaderController controller, SAXParserFactory parserFactory, TREXGrammarReader.StateFactory stateFactory, ExpressionPool pool) full constructor

Method Detail

createExpressionChildState	back to summary
public State createExpressionChildState(State parent, StartTagInfo tag) Overrides com.sun.msv.reader.trex.TREXBaseReader.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.

createExpressionChildState

back to summary

public State createExpressionChildState(State parent, StartTagInfo tag)

Overrides com.sun.msv.reader.trex.TREXBaseReader.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.

getGrammar	back to summary
protected TREXGrammar getGrammar()

getStateFactory	back to summary
protected TREXGrammarReader.StateFactory getStateFactory()

isGrammarElement	back to summary
protected boolean isGrammarElement(StartTagInfo tag) Implements abstract com.sun.msv.reader.GrammarReader.isGrammarElement. Doc from com.sun.msv.reader.GrammarReader.isGrammarElement. checks if given element is that of the grammar elements.

isGrammarElement

back to summary

protected boolean isGrammarElement(StartTagInfo tag)

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

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

checks if given element is that of the grammar elements.

localizeMessage	back to summary
protected String localizeMessage(String propertyName, Object[] args) Overrides com.sun.msv.reader.trex.TREXBaseReader.localizeMessage. Doc from com.sun.msv.reader.GrammarReader.localizeMessage. formats localized message with arguments

localizeMessage

back to summary

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

Overrides com.sun.msv.reader.trex.TREXBaseReader.localizeMessage.

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

formats localized message with arguments

mapNamespace	back to summary
private String mapNamespace(String namespace) maps obsoleted XML Schema namespace to the current one.

parse	back to summary
public static TREXGrammar parse(String grammarURL, SAXParserFactory factory, GrammarReaderController controller) loads TREX pattern

parse	back to summary
public static TREXGrammar parse(InputSource grammar, SAXParserFactory factory, GrammarReaderController controller) loads TREX pattern

resolveDatatype	back to summary
public Datatype resolveDatatype(String qName) obtains a named DataType object referenced by a QName.

resolveXSDatatype	back to summary
public XSDatatypeExp resolveXSDatatype(String qName) Implements com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype. Parameters qName:String Doc from com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype. The type of this value varies in the schema language. In XML Schema, for example, in which QNames are used to designate datatypes, this parameter will be QName. In RELAX Core, in which the same syntax is used but NCName is used to designate datatypes. So this parameter will be NCName. Returns:XSDatatypeExp Doc from com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype. A non-null valid object. An error should be reported and recovered by the callee.

resolveXSDatatype

back to summary

public XSDatatypeExp resolveXSDatatype(String qName)

Implements com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype.

Parameters

qName:String

Doc from com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype.

The type of this value varies in the schema language. In XML Schema, for example, in which QNames are used to designate datatypes, this parameter will be QName. In RELAX Core, in which the same syntax is used but NCName is used to designate datatypes. So this parameter will be NCName.

Returns:XSDatatypeExp

Doc from com.sun.msv.reader.datatype.xsd.XSDatatypeResolver.resolveXSDatatype.

A non-null valid object. An error should be reported and recovered by the callee.

wrapUp	back to summary
public void wrapUp() Overrides com.sun.msv.reader.trex.TREXBaseReader.wrapUp. Doc from com.sun.msv.reader.trex.TREXBaseReader.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.

wrapUp

back to summary

public void wrapUp()

Overrides com.sun.msv.reader.trex.TREXBaseReader.wrapUp.

Doc from com.sun.msv.reader.trex.TREXBaseReader.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.classic back to summary

public Class TREXGrammarReader.StateFactory

Class Inheritance

extends StateFactory

java.lang.Object
com.sun.msv.reader.trex.TREXBaseReader.StateFactory
com.sun.msv.reader.trex.classic.TREXGrammarReader.StateFactory

Known Direct Subclasses

com.sun.msv.reader.trex.typed.TypedTREXGrammarInterceptor

creates various State object, which in turn parses grammar. parsing behavior can be customized by implementing custom StateFactory.

Constructor Summary

Access	Constructor and Description
public	StateFactory()

Method Summary

Modifier and Type	Method and Description
public State	anyString(State parent, StartTagInfo tag)
public State	concur(State parent, StartTagInfo tag)
public State	data(State parent, StartTagInfo tag)
public State	define(State parent, StartTagInfo tag) Implements abstract com.sun.msv.reader.trex.TREXBaseReader.StateFactory.define.
public State	includePattern(State parent, StartTagInfo tag)
public State	string(State parent, StartTagInfo tag)

Constructor Detail

StateFactory	back to summary
public StateFactory()

Method Detail

anyString	back to summary
public State anyString(State parent, StartTagInfo tag)

concur	back to summary
public State concur(State parent, StartTagInfo tag)

data	back to summary
public State data(State parent, StartTagInfo tag)

define	back to summary
public State define(State parent, StartTagInfo tag) Implements abstract com.sun.msv.reader.trex.TREXBaseReader.StateFactory.define.

includePattern	back to summary
public State includePattern(State parent, StartTagInfo tag)

string	back to summary
public State string(State parent, StartTagInfo tag)

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

private Class TREXGrammarReader.UndefinedDataTypeVocabulary

Class Inheritance

extends Object
implements DataTypeVocabulary

java.lang.Object
com.sun.msv.reader.trex.classic.TREXGrammarReader.UndefinedDataTypeVocabulary

All Implemented Interfaces

com.sun.msv.reader.datatype.DataTypeVocabulary

Dummy DataTypeVocabulary for better error recovery. If DataTypeVocabulary is not found, the error is reported and this class is used to prevent further repetitive error messages.

Constructor Summary

Access	Constructor and Description
private	UndefinedDataTypeVocabulary()

Method Summary

Modifier and Type	Method and Description
public State	createTopLevelReaderState(StartTagInfo tag) Implements com.sun.msv.reader.datatype.DataTypeVocabulary.createTopLevelReaderState. creates a State object that will parse the element specified by tag parameter.
public Datatype	getType(String local part of the qualified name, like "string" or "integer". prefix part must be removed by the caller. localTypeName) Implements com.sun.msv.reader.datatype.DataTypeVocabulary.getType. resolves a type name to Datatype object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

UndefinedDataTypeVocabulary	back to summary
private UndefinedDataTypeVocabulary()

Method Detail

createTopLevelReaderState	back to summary
public State createTopLevelReaderState(StartTagInfo tag) Implements com.sun.msv.reader.datatype.DataTypeVocabulary.createTopLevelReaderState. Doc from com.sun.msv.reader.datatype.DataTypeVocabulary.createTopLevelReaderState. creates a State object that will parse the element specified by tag parameter. Returns:State null if given start tag is not recognized by this object. This method is called when an "island" of this vocabulary was found. The state returned from this method will be used to parse the root element of this island. The parent state of this state must implement TypeOwner or ExpressionOwner. In either case, the implementation must report its parsing result by calling either interface. If both interface is implemented, the implementation must notify via TypeOwner interface only and may not call methods of ExpressionOwner. If the parsed island is not a type definition (for example, comments or inclusion), the implementation may not call TypeOwner nor ExpressionOwner.

createTopLevelReaderState

back to summary

public State createTopLevelReaderState(StartTagInfo tag)

Implements com.sun.msv.reader.datatype.DataTypeVocabulary.createTopLevelReaderState.

Doc from com.sun.msv.reader.datatype.DataTypeVocabulary.createTopLevelReaderState.

creates a State object that will parse the element specified by tag parameter.

Returns:State: null if given start tag is not recognized by this object. This method is called when an "island" of this vocabulary was found. The state returned from this method will be used to parse the root element of this island. The parent state of this state must implement TypeOwner or ExpressionOwner. In either case, the implementation must report its parsing result by calling either interface. If both interface is implemented, the implementation must notify via TypeOwner interface only and may not call methods of ExpressionOwner. If the parsed island is not a type definition (for example, comments or inclusion), the implementation may not call TypeOwner nor ExpressionOwner.

getType	back to summary
public Datatype getType(String localTypeName) Implements com.sun.msv.reader.datatype.DataTypeVocabulary.getType. Doc from com.sun.msv.reader.datatype.DataTypeVocabulary.getType. resolves a type name to Datatype object. Parameters localTypeName:String local part of the qualified name, like "string" or "integer". prefix part must be removed by the caller. Returns:Datatype a non-null valid datatype object.

getType

back to summary

public Datatype getType(String localTypeName)

Implements com.sun.msv.reader.datatype.DataTypeVocabulary.getType.

Doc from com.sun.msv.reader.datatype.DataTypeVocabulary.getType.

resolves a type name to Datatype object.

Parameters

localTypeName:String: local part of the qualified name, like "string" or "integer". prefix part must be removed by the caller.

Returns:Datatype

a non-null valid datatype object.

public Class TREXGrammarReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class TREXGrammarReader.StateFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class TREXGrammarReader.UndefinedDataTypeVocabulary

Constructor Summary

Method Summary

Constructor Detail

Method Detail