org.objectweb.jorm.xml2mi.api
Interface Parser

All Known Implementing Classes:

BasicDomParser

public interface Parser

The Parser interface defines the behaviour of a JORM component used to parse a set of JORM definition files. A parser is able to parse XML files (these files may be passed by the pmc command line), and build a schema of meta-objects, using a meta-information manager component.

Author:

P. Dechamboux, X. Spengler

Method Summary

ParserErrorHandler	getParserErrorHandler() allows to know the list of error the parser encounters.
java.lang.Exception	getParserException() returns the exception which is reached during the parsing of a file
boolean	isGenDep() Allows to know if the dependances must be generated or not.
java.util.Collection	parse(java.util.Iterator files) Launches the parsing process.
MetaObject	parse(java.lang.String file) Launches the parsing process.
void	setGenDep(boolean gendep) Enables or disables the generation of the dependances.
void	setMapperName(java.lang.String mapperName) Sets the name of the mapper to use.
void	setMappingName(java.lang.String mappingName) Sets the name of the mapping to use.
void	setMappingParser(MappingParser mappingParser) Sets the parser which is able to parse the mapping part of the XML file.
void	setMetaInfoManager(Manager mim) Assigns a meta-information manager to a parser in order from it to create the meta-information related to the XML files it parses.
void	setPathExplorer(org.objectweb.util.io.api.PathExplorer pathexpl) Assigns a PathExplorer object for locating files that have to be parsed.

Method Detail

parse

public java.util.Collection parse(java.util.Iterator files)
                           throws PException

Launches the parsing process. It reads and parses all the XML files and builds a schema of meta-objects for all of them. Before to use this method, the following object need to be set : Manager (with setMetaInfoManager), the PathExplorer (with setPathExplorer), the mapper name (with setMapperName), the mapping name (with setMappingName), the mapping parser object (with setMappingParser).

Parameters:

files - an iterator over the name the XML files to be parsed

parse

public MetaObject parse(java.lang.String file)
                 throws PException

Launches the parsing process. It reads and parse an XML file and builds a schema of meta-objects for it. Before to use this method, the following object need to be set : Manager (with setMetaInfoManager), the PathExplorer (with setPathExplorer), the mapper name (with setMapperName), the mapping name (with setMappingName), the mapping parser object (with setMappingParser).

Parameters:

file - the name of the XML file to be parsed

setMetaInfoManager

public void setMetaInfoManager(Manager mim)

Assigns a meta-information manager to a parser in order from it to create the meta-information related to the XML files it parses.

Parameters:

mim - the meta-information Manager to be associated to this parser

setPathExplorer

public void setPathExplorer(org.objectweb.util.io.api.PathExplorer pathexpl)

Assigns a PathExplorer object for locating files that have to be parsed.

Parameters:

pathexpl - the PathExplorer to be used for file location

setMapperName

public void setMapperName(java.lang.String mapperName)

Sets the name of the mapper to use. This name is passed on the command line or defined in a properties file.

Parameters:

mapperName - the name of the mapper

setMappingName

public void setMappingName(java.lang.String mappingName)

Sets the name of the mapping to use. This name is passed on the command line or defined in a properties file.

Parameters:

mappingName - the name of the mapping

setMappingParser

public void setMappingParser(MappingParser mappingParser)

Sets the parser which is able to parse the mapping part of the XML file.

Parameters:

mappingParser - the parser which parses the mapping object

setGenDep

public void setGenDep(boolean gendep)

Enables or disables the generation of the dependances.

Parameters:

gendep - true, the dependances are generated, else false

isGenDep

public boolean isGenDep()

Allows to know if the dependances must be generated or not.

Returns:

true, if the dependances are generated, else false

getParserException

public java.lang.Exception getParserException()

returns the exception which is reached during the parsing of a file

Returns:

an Exception object

getParserErrorHandler

public ParserErrorHandler getParserErrorHandler()

allows to know the list of error the parser encounters.

Returns:

a ParserErrorHandler object which countains all errors from the xml parser