cb.parser

Class PetalParser

java.lang.Object

cb.parser.PetalParser

public class PetalParser
extends Object

Optimized parser for Rational Rose Petal files.

Version:

$Id: PetalParser.java,v 1.19 2005/05/09 20:11:58 moroff Exp $

Author:

M. Dahm

Constructor Summary

Constructors

Constructor and Description
PetalParser(Reader r, Map<String,String> pathMap) create a petal Parser with the given path Map

Method Summary

Modifier and Type	Method and Description
static PetalParser	createParser(File file) crate a parser for the given file
static PetalParser	createParser(File file, Map<String,String> pathMap) create a parser for the given file and pathMap
static PetalParser	createParser(InputStream stream) create a parser form the given input stream
static PetalParser	createParser(InputStream stream, Map<String,String> pathMap)
static PetalParser	createParser(Reader stream)
static PetalParser	createParser(Reader stream, Map<String,String> pathMap)
static PetalParser	createParser(String file_name) create a parser from the given file name
static PetalParser	createParser(String file_name, Map<String,String> pathMap) create a parser for the given file name and pathMap
static PetalParser	createParser(URL url, Map<String,String> pathMap) create parser for the given Url and pathMap
Class[]	getIgnoredNodes()
Map	getPathMap()
static void	main(String[] args)
PetalFile	parse() Top level construct are always petal and design objects
static PetalFile	parse(String[] args) Utility method for main
static PetalFile	parse(String[] args, Map pathMap) Utility method for main
List	parseList()
PetalObject	parseObject()
PetalNode	parseValue(boolean rparen_ok)
Value	parseValueObject()
File	resolveReference(String path) Resolve reference to external file, e.g., "$CURDIR\\ConsolidatedView\\ConsolidatedView.cat"
void	setCurrentDir(File dir) Set current, i.e., the directory where the source MDL file is located so that references to external .CAT files can be resolved.
void	setIgnoredNodes(Class[] nodes) If the parser finds such a node while building the petal tree, the node will be ignored and not added to the tree.
void	setPathMap(Map pathMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PetalParser

public PetalParser(Reader r,
                   Map<String,String> pathMap)

create a petal Parser with the given path Map

Parameters:

r -

pathMap -

Method Detail

setIgnoredNodes

public void setIgnoredNodes(Class[] nodes)

If the parser finds such a node while building the petal tree, the node will be ignored and not added to the tree. E.g, setIgnoredNodes(Diagram.class) will abandon all diagrams of the model.

getIgnoredNodes

public Class[] getIgnoredNodes()

createParser

public static PetalParser createParser(String file_name)

create a parser from the given file name

Parameters:

file_name - or "-" to denote stdin

Returns:

- the parser for the given file name

createParser

public static PetalParser createParser(String file_name,
                                       Map<String,String> pathMap)

create a parser for the given file name and pathMap

Parameters:

file_name -

pathMap -

Returns:

- the parser

createParser

public static PetalParser createParser(URL url,
                                       Map<String,String> pathMap)

create parser for the given Url and pathMap

Parameters:

url -

pathMap -

Returns:

-the parser

createParser

public static PetalParser createParser(File file)

crate a parser for the given file

Parameters:

file -

Returns:

- the parser

createParser

public static PetalParser createParser(File file,
                                       Map<String,String> pathMap)

create a parser for the given file and pathMap

Parameters:

file -

pathMap -

Returns:

the parser

setCurrentDir

public void setCurrentDir(File dir)

Set current, i.e., the directory where the source MDL file is located so that references to external .CAT files can be resolved.

resolveReference

public File resolveReference(String path)

Resolve reference to external file, e.g., "$CURDIR\\ConsolidatedView\\ConsolidatedView.cat"

Returns:

file handle or null if file can not be located

createParser

public static PetalParser createParser(Reader stream)

createParser

public static PetalParser createParser(Reader stream,
                                       Map<String,String> pathMap)

createParser

public static PetalParser createParser(InputStream stream)

create a parser form the given input stream

Parameters:

stream -

Returns:

- return the parser

createParser

public static PetalParser createParser(InputStream stream,
                                       Map<String,String> pathMap)

parse

public PetalFile parse()

Top level construct are always petal and design objects

parseObject

public PetalObject parseObject()

parseValue

public PetalNode parseValue(boolean rparen_ok)

parseList

public List parseList()

parseValueObject

public Value parseValueObject()

main

public static void main(String[] args)

parse

public static PetalFile parse(String[] args,
                              Map pathMap)

Utility method for main

parse

public static PetalFile parse(String[] args)

Utility method for main

getPathMap

public Map getPathMap()

Returns:

Returns the pathMap.

setPathMap

public void setPathMap(Map pathMap)

Parameters:

pathMap - The pathMap to set.