All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ca.carleton.sce.ucmagents.lfmparse.lfmparse

ca.carleton.sce.ucmagents.lfmparse.lfmparse

public class lfmparse
implements lfmparseTreeConstants, lfmparseConstants
lfmparse is a class that parses a Use Case Map description in linear form. It builds an Abstract Syntax Tree that be used later on for semantics checking and code generation. lfmparse was built using jjtree and JavaCC.

Version:
1.00, 1998 02 01
Author:
Daniel Amyot, damyot@csi.uottawa.ca
See Also:
SimpleNode, Node

Variable Index

 o jj_nt
 o jjtree
 o lookingAhead
 o token
 o token_source

Constructor Index

 o lfmparse(InputStream)
 o lfmparse(lfmparseTokenManager)

Method Index

 o atom()
Parse an atom.
 o atomName()
Parse an atom name.
 o component()
Parse a component.
 o componentName()
Parse a component name.
 o componentSpec()
Parse a component specification.
 o componentType()
Parse a component type.
 o condition()
Parse a condition.
 o connectionList()
Parse a semi-path connection list.
 o description()
Parse a general description (free text).
 o design()
Parse a complete UCM design, including root and plugin models.
 o designName()
Parse a design name.
 o disable_tracing()
 o dynamicResp()
Parse a dynamic responsibility.
 o dynamicStub()
Parse a stub.
 o emptySegment()
Parse an empty segment.
 o emptySegmentId()
Parse an empty segment identifier.
 o enable_tracing()
 o endBar()
Parse an end bar atom.
 o endBarId()
Parse an end bar identifier.
 o enforceBindings()
Parse a list of enforced path bindings.
 o entryPoint()
Parse an entry point.
 o entryPointList()
Parse an entry point list.
 o event()
Parse an event.
 o exceptionId()
Parse an exception identifier.
 o fixedStub()
Parse a stub.
 o fork()
Parse a fork.
 o forkId()
Parse a fork identifier.
 o formalToValue()
Parse an assignation of a value to a formal parameter.
 o generateParseException()
 o getNextToken()
 o getToken(int)
 o handle()
Parse an exception handler identifier.
 o ignoredEndings()
Parse a list of ignored endings in a stub binding.
 o inConnection()
Parse an input connection in a stub binding.
 o inConnections()
Parse a list of input connections.
 o inSegment()
Parse an input segment.
 o inSegmentId()
Parse an in segment identifier.
 o inSegmentList()
Parse a list of input segments.
 o instanceValues()
Parse a list of instance values for components in a plugin-to-stub binding.
 o join()
Parse a join.
 o joinId()
Parse a join identifier.
 o link()
Parse a link.
 o linkList()
Parse a link list.
 o main(String[])
Main executable.
 o model()
Parse a UCM model (either a root map or a plugin).
 o modelName()
Parse a model name.
 o modelTitle()
Parse the model title.
 o otherAtomsList()
Parse a list of other atom references.
 o outConnection()
Parse an output connection in a stub binding.
 o outConnections()
Parse a list of output connections.
 o outSegment()
Parse an output segment.
 o outSegmentId()
Parse an out segment identifier.
 o outSegmentList()
Parse a list of output segments.
 o path()
Parse a path.
 o pathAtomsSpec()
Parse a path atom specification.
 o pathBinding()
Parse a path binding.
 o pathComposition()
Parse a path composition.
 o pathCompositionList()
Parse a path composition list.
 o pathList()
Parse a path list.
 o pathName()
Parse a path name.
 o pathNameList()
Parse a list of path names.
 o pathSpec()
Parse a path specification.
 o plugin()
Parse a plugin.
 o pluginList()
Parse a plugin list.
 o pluginMaps()
Parse a list of UCM plugin maps.
 o pluginPool()
Parse a list of plugin pools.
 o pool()
Parse a pool.
 o poolName()
Parse a pool name.
 o poolSpec()
Parse a pool specification.
 o postconditionList()
Parse a list of postconditions.
 o preconditionList()
Parse a list of preconditions.
 o raise()
Parse an exception raising.
 o ReInit(InputStream)
 o ReInit(lfmparseTokenManager)
 o replicationFactor()
Parse a replication factor.
 o responsibility()
Parse a responsibility (dynamic responsibility, exception raising, or exception handling).
 o responsibilityList()
Parse a responsibility list.
 o responsibilityName()
Parse a responsability name.
 o responsibilityRef()
Parse a responsibility reference.
 o responsibilitySpec()
Parse a responsibility specification.
 o resultingEventList()
Parse a list of resulting events.
 o rootMaps()
Parse a list of UCM root maps.
 o semiPath()
Parse a semi-path.
 o semiPathConnection()
Parse a semi-path connection.
 o semiPathId()
Parse a semi-path identifier.
 o semiPathList()
Parse a semi-path list.
 o startOfPath()
Parse a start of path atom.
 o startOfPathId()
Parse a start of path identifier.
 o structureSpec()
Parse a structure specification.
 o stub()
Parse a stub.
 o stubName()
Parse a stub name.
 o subStructureSpec()
Parse a sub-structure specification.
 o synchronization()
Parse a synchronization.
 o synchronizationId()
Parse a synchronization identifier.
 o triggeringEventList()
Parse a list of triggering events.
 o waitingPlace()
Parse a waiting place atom.
 o waitingPlaceId()
Parse a waiting place identifier.

Variables

 o jjtree
 protected static JJTlfmparseState jjtree
 o token_source
 public static lfmparseTokenManager token_source
 o token
 public static Token token
 o jj_nt
 public static Token jj_nt
 o lookingAhead
 public static boolean lookingAhead

Constructors

 o lfmparse
 public lfmparse(InputStream stream)
 o lfmparse
 public lfmparse(lfmparseTokenManager tm)

Methods

 o main
 public static void main(String args[])
Main executable. It parses a UCM linear form description and displays the resulting Abstract Syntax Tree uting the dump method. If the parser fails, then an exception is generated and the call stack is output.

Parameters:
args - file.lfm to be parsed. If empty then use standard input.
See Also:
dump
 o design
 public static final SimpleNode design() throws ParseException
Parse a complete UCM design, including root and plugin models.

Returns:
a design AST
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
SimpleNode, ASTdesign
 o designName
 public static final String designName() throws ParseException
Parse a design name.

Returns:
the design name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o rootMaps
 public static final void rootMaps() throws ParseException
Parse a list of UCM root maps. Container for model child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTrootMaps, ASTmodel
 o pluginMaps
 public static final void pluginMaps() throws ParseException
Parse a list of UCM plugin maps. Container for model child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpluginMaps, ASTmodel
 o model
 public static final void model() throws ParseException
Parse a UCM model (either a root map or a plugin).

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTmodel
 o modelName
 public static final String modelName() throws ParseException
Parse a model name. Also allows root as a name for backward compatibility with ucmnav.

Returns:
the model name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o modelTitle
 public static final String modelTitle() throws ParseException
Parse the model title. Also accept a model name for backward compatibility with ucmnav.

Returns:
the model title
Throws: ParseException
This exception is thrown when parse errors are encountered
 o description
 public static final String description() throws ParseException
Parse a general description (free text).

Returns:
the description
Throws: ParseException
This exception is thrown when parse errors are encountered
 o structureSpec
 public static final void structureSpec() throws ParseException
Parse a structure specification.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTstructureSpec
 o componentSpec
 public static final void componentSpec() throws ParseException
Parse a component specification. Container for component child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTcomponentSpec, ASTcomponent
 o component
 public static final void component() throws ParseException
Parse a component.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTcomponent
 o componentName
 public static final String componentName() throws ParseException
Parse a component name.

Returns:
the component name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o componentType
 public static final String componentType() throws ParseException
Parse a component type.

Returns:
the component type
Throws: ParseException
This exception is thrown when parse errors are encountered
 o responsibilityList
 public static final Vector responsibilityList() throws ParseException
Parse a responsibility list.

Returns:
the responsibility list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o otherAtomsList
 public static final Vector otherAtomsList() throws ParseException
Parse a list of other atom references.

Returns:
the atom name list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o atomName
 public static final String atomName() throws ParseException
Parse an atom name.

Returns:
the atom name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o subStructureSpec
 public static final void subStructureSpec() throws ParseException
Parse a sub-structure specification.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTstructureSpec
 o replicationFactor
 public static final int replicationFactor() throws ParseException
Parse a replication factor.

Returns:
the replication factor (integer)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o poolSpec
 public static final void poolSpec() throws ParseException
Parse a pool specification. Container for pool child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpoolSpec, ASTpool
 o pool
 public static final void pool() throws ParseException
Parse a pool.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpool
 o pluginPool
 public static final Vector pluginPool() throws ParseException
Parse a list of plugin pools.

Returns:
the list of plugin names (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o poolName
 public static final String poolName() throws ParseException
Parse a pool name.

Returns:
the pool name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o pathSpec
 public static final void pathSpec() throws ParseException
Parse a path specification.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpathSpec
 o pathAtomsSpec
 public static final void pathAtomsSpec() throws ParseException
Parse a path atom specification. Container for atom child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpathAtomsSpec, ASTatom
 o atom
 public static final void atom() throws ParseException
Parse an atom. Atoms are of many kind, and ASTatom is an abstract class.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTatom
 o startOfPath
 public static final void startOfPath() throws ParseException
Parse a start of path atom.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTstartOfPath
 o startOfPathId
 public static final String startOfPathId() throws ParseException
Parse a start of path identifier.

Returns:
the start of path identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o pathNameList
 public static final Vector pathNameList() throws ParseException
Parse a list of path names.

Returns:
the list of path names (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o pathName
 public static final String pathName() throws ParseException
Parse a path name.

Returns:
the path name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o outSegmentList
 public static final Vector outSegmentList() throws ParseException
Parse a list of output segments.

Returns:
the list of output segments (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o outSegment
 public static final String outSegment() throws ParseException
Parse an output segment.

Returns:
the out segment identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o outSegmentId
 public static final String outSegmentId() throws ParseException
Parse an out segment identifier.

Returns:
the out segment identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o triggeringEventList
 public static final Vector triggeringEventList() throws ParseException
Parse a list of triggering events.

Returns:
the list of events (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o event
 public static final StringPair event() throws ParseException
Parse an event.

Returns:
the name of the event and its description without the delimiters (as a StringPair).
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o preconditionList
 public static final Vector preconditionList() throws ParseException
Parse a list of preconditions.

Returns:
the condition list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o condition
 public static final StringPair condition() throws ParseException
Parse a condition.

Returns:
the name of the condition and its description without the delimiters (as a StringPair).
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o waitingPlace
 public static final void waitingPlace() throws ParseException
Parse a waiting place atom.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTwaitingPlace
 o waitingPlaceId
 public static final String waitingPlaceId() throws ParseException
Parse a waiting place identifier.

Returns:
the waiting place identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o inSegmentList
 public static final Vector inSegmentList() throws ParseException
Parse a list of input segments.

Returns:
the list of input segments (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o inSegment
 public static final String inSegment() throws ParseException
Parse an input segment.

Returns:
the in segment identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o inSegmentId
 public static final String inSegmentId() throws ParseException
Parse an in segment identifier.

Returns:
the in segment identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o endBar
 public static final void endBar() throws ParseException
Parse an end bar atom.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTendBar
 o endBarId
 public static final String endBarId() throws ParseException
Parse an end bar identifier.

Returns:
the end bar identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o resultingEventList
 public static final Vector resultingEventList() throws ParseException
Parse a list of resulting events.

Returns:
the list of events (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o postconditionList
 public static final Vector postconditionList() throws ParseException
Parse a list of postconditions.

Returns:
the condition list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o responsibilityRef
 public static final void responsibilityRef() throws ParseException
Parse a responsibility reference.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTresponsibilityRef
 o responsibilityName
 public static final String responsibilityName() throws ParseException
Parse a responsability name.

Returns:
the responsability name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o stub
 public static final void stub() throws ParseException
Parse a stub.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTfixedStub, ASTdynamicStub
 o fixedStub
 public static final void fixedStub() throws ParseException
Parse a stub.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTfixedStub
 o dynamicStub
 public static final void dynamicStub() throws ParseException
Parse a stub.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTdynamicStub
 o stubName
 public static final String stubName() throws ParseException
Parse a stub name.

Returns:
the stub name
Throws: ParseException
This exception is thrown when parse errors are encountered
 o pluginList
 public static final void pluginList() throws ParseException
Parse a plugin list. Container for plugin child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpluginList, ASTplugin
 o plugin
 public static final void plugin() throws ParseException
Parse a plugin.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTplugin
 o inConnections
 public static final Vector inConnections() throws ParseException
Parse a list of input connections.

Returns:
the path list of input connections (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o inConnection
 public static final StringPair inConnection() throws ParseException
Parse an input connection in a stub binding.

Returns:
the input segment (from the stub) and the start of path identifier (from the plugin) (as a StringPair)
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o outConnections
 public static final Vector outConnections() throws ParseException
Parse a list of output connections.

Returns:
the path list of output connections (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o outConnection
 public static final StringPair outConnection() throws ParseException
Parse an output connection in a stub binding.

Returns:
the end bar identifier (from the plugin) and the output segment identifier (from the stub) (as a StringPair)
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o ignoredEndings
 public static final Vector ignoredEndings() throws ParseException
Parse a list of ignored endings in a stub binding.

Returns:
the path list of ignored endings (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o instanceValues
 public static final Vector instanceValues() throws ParseException
Parse a list of instance values for components in a plugin-to-stub binding.

Returns:
the instance values list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o formalToValue
 public static final StringPair formalToValue() throws ParseException
Parse an assignation of a value to a formal parameter.

Returns:
the formal parameter and the value (as a StringPair)
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o enforceBindings
 public static final Vector enforceBindings() throws ParseException
Parse a list of enforced path bindings.

Returns:
the path binding list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o pathBinding
 public static final StringPair pathBinding() throws ParseException
Parse a path binding.

Returns:
the input segment identifier and the output segment identifier (as a StringPair)
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o join
 public static final void join() throws ParseException
Parse a join.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTjoin
 o joinId
 public static final String joinId() throws ParseException
Parse a join identifier.

Returns:
the join identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o fork
 public static final void fork() throws ParseException
Parse a fork.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTfork
 o forkId
 public static final String forkId() throws ParseException
Parse a fork identifier.

Returns:
the fork identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o synchronization
 public static final void synchronization() throws ParseException
Parse a synchronization.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTsynchronization
 o synchronizationId
 public static final String synchronizationId() throws ParseException
Parse a synchronization identifier.

Returns:
the synchronization identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o entryPointList
 public static final Vector entryPointList() throws ParseException
Parse an entry point list.

Returns:
the entry point list (as a Vector)
Throws: ParseException
This exception is thrown when parse errors are encountered
 o entryPoint
 public static final StringPair entryPoint() throws ParseException
Parse an entry point.

Returns:
the input segment identifier and the timeout path (as a StringPair)
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o emptySegment
 public static final void emptySegment() throws ParseException
Parse an empty segment.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTemptySegment
 o emptySegmentId
 public static final String emptySegmentId() throws ParseException
Parse an empty segment identifier.

Returns:
the empty segment identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o semiPathList
 public static final void semiPathList() throws ParseException
Parse a semi-path list. Container for semiPath child nodes

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTsemiPathList, ASTsemiPath
 o semiPath
 public static final void semiPath() throws ParseException
Parse a semi-path. Container for a link child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTsemiPath, ASTlink
 o semiPathId
 public static final String semiPathId() throws ParseException
Parse a semi-path identifier.

Returns:
the semi-path identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o linkList
 public static final void linkList() throws ParseException
Parse a link list.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTlink
 o link
 public static final void link() throws ParseException
Parse a link.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTlink
 o pathList
 public static final void pathList() throws ParseException
Parse a path list. Container for path child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTPathList, ASTpath
 o path
 public static final void path() throws ParseException
Parse a path. Container for semiPathConnection child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpath, ASTsemiPathConnection
 o connectionList
 public static final void connectionList() throws ParseException
Parse a semi-path connection list.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTsemiPathConnection
 o semiPathConnection
 public static final void semiPathConnection() throws ParseException
Parse a semi-path connection.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTsemiPathConnection
 o pathCompositionList
 public static final void pathCompositionList() throws ParseException
Parse a path composition list. Container for pathComposition child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpathCompositionList, ASTpathComposition
 o pathComposition
 public static final void pathComposition() throws ParseException
Parse a path composition.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTpathComposition
 o responsibilitySpec
 public static final void responsibilitySpec() throws ParseException
Parse a responsibility specification. Container for responsibility child nodes.

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTresponsibilitySpec, ASTresponsibility
 o responsibility
 public static final void responsibility() throws ParseException
Parse a responsibility (dynamic responsibility, exception raising, or exception handling).

Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
ASTresponsibility
 o dynamicResp
 public static final Vector dynamicResp() throws ParseException
Parse a dynamic responsibility.

Returns:
the action, the IsIn status, and the source pool name (as a Vector).
Throws: ParseException
This exception is thrown when parse errors are encountered
 o raise
 public static final StringPair raise() throws ParseException
Parse an exception raising.

Returns:
the exception identifier and the name of the exception path (as a StringPair).
Throws: ParseException
This exception is thrown when parse errors are encountered
See Also:
StringPair
 o exceptionId
 public static final String exceptionId() throws ParseException
Parse an exception identifier.

Returns:
the exception identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o handle
 public static final String handle() throws ParseException
Parse an exception handler identifier.

Returns:
the exception handler identifier
Throws: ParseException
This exception is thrown when parse errors are encountered
 o ReInit
 public static void ReInit(InputStream stream)
 o ReInit
 public void ReInit(lfmparseTokenManager tm)
 o getNextToken
 public static final Token getNextToken()
 o getToken
 public static final Token getToken(int index)
 o generateParseException
 public static final ParseException generateParseException()
 o enable_tracing
 public static final void enable_tracing()
 o disable_tracing
 public static final void disable_tracing()

All Packages  Class Hierarchy  This Package  Previous  Next  Index