org.objectweb.jorm.compiler.api

Interface JormCompilerParameter

All Superinterfaces:
Cloneable, org.objectweb.jorm.util.api.Loggable

public interface JormCompilerParameter
extends Cloneable, org.objectweb.jorm.util.api.Loggable

A JormCompilerParameter object is an object which manages informations read by the command line parser. These informations are needed to the compiler system to parse, generate, and compile.

Author:
X. Spengler

Field Summary

static String
INHERITANCE_CLASSNAME_PATTERN
The pattern that represents the JORM class name to be replaced into the string defining the inherited class of a either the PBinding or the PClassMapping that is generated.
static String
INHERITANCE_PACKAGE_PATTERN

Method Summary

Object
clone()
String
computePBindingInheritance(String cn)
Computes the actual class name which the generated PBinding class must extend.
String
computePClassMappingInheritance(String cn)
Computes the actual class name which the generated PClassMapping class must extend.
String
getBindingInheritance()
String
getClassMappingInheritance()
org.objectweb.jorm.util.io.api.PathExplorer
getClasspath()
ArrayList
getDtdLocations()
Collection
getInputFiles()
String
getJavacName()
String
getOutput()
String
getProjectName()
boolean
isBindingAbstract()
boolean
isGeneratedPDFiles()
boolean
isGeneratedWithMapperPackage()
boolean
isJavac()
boolean
isKeepSrc()
boolean
isParseOnly()
boolean
isVerbose()
void
loadConfFile(InputStream in, Iterator knownmappers)
Load a jorm configuration file.
void
loadConfFile(String file, Iterator knownmappers)
Load a jorm configuration file.
void
print()
Prints informations managed by the current object.
void
setBindingAbstract(boolean bindingAbstract)
void
setBindingInheritance(String bindingInheritance)
void
setClassMappingInheritance(String classMappingInheritance)
void
setClasspath(org.objectweb.jorm.util.io.api.PathExplorer classpath)
void
setDtdLocations(ArrayList dtdLocations)
void
setGeneratedPDFiles(boolean generatedPDFiles)
void
setGeneratedWithMapperPackage(boolean generatedWithMapperPackage)
void
setInputFiles(Collection inputFiles)
void
setJavac(boolean javac)
void
setKeepSrc(boolean keepSrc)
void
setLogConfFile(String logConfFile)
void
setOutput(String output)
void
setProjectName(String projectName)
void
setVerbose(boolean verbose)

Methods inherited from interface org.objectweb.jorm.util.api.Loggable

getLogger, getLoggerFactory, setLogger, setLoggerFactory

Field Details

INHERITANCE_CLASSNAME_PATTERN

public static final String INHERITANCE_CLASSNAME_PATTERN
The pattern that represents the JORM class name to be replaced into the string defining the inherited class of a either the PBinding or the PClassMapping that is generated.


INHERITANCE_PACKAGE_PATTERN

public static final String INHERITANCE_PACKAGE_PATTERN

Method Details

clone

public Object clone()


computePBindingInheritance

public String computePBindingInheritance(String cn)
Computes the actual class name which the generated PBinding class must extend.

Parameters:
cn - The class name of the persistent class for which the code is generated.

Returns:
The computed class name.


computePClassMappingInheritance

public String computePClassMappingInheritance(String cn)
Computes the actual class name which the generated PClassMapping class must extend.

Parameters:
cn - The class name of the persistent class for which the code is generated.

Returns:
The computed class name.


getBindingInheritance

public String getBindingInheritance()

Returns:
the name of the class inherited by the generated XXXBinding


getClassMappingInheritance

public String getClassMappingInheritance()


getClasspath

public org.objectweb.jorm.util.io.api.PathExplorer getClasspath()


getDtdLocations

public ArrayList getDtdLocations()


getInputFiles

public Collection getInputFiles()


getJavacName

public String getJavacName()


getOutput

public String getOutput()

Returns:
the output directory where the generated will be put


getProjectName

public String getProjectName()


isBindingAbstract

public boolean isBindingAbstract()


isGeneratedPDFiles

public boolean isGeneratedPDFiles()


isGeneratedWithMapperPackage

public boolean isGeneratedWithMapperPackage()


isJavac

public boolean isJavac()


isKeepSrc

public boolean isKeepSrc()


isParseOnly

public boolean isParseOnly()


isVerbose

public boolean isVerbose()

Returns:
a boolean value indicating if the verbose mode is activated


loadConfFile

public void loadConfFile(InputStream in,
                         Iterator knownmappers)
            throws PException
Load a jorm configuration file.

Parameters:
in - the input stream of the jorm configuration file


loadConfFile

public void loadConfFile(String file,
                         Iterator knownmappers)
            throws PException
Load a jorm configuration file.

Parameters:
file - the name of the jorm configuration file


print

public void print()
Prints informations managed by the current object.


setBindingAbstract

public void setBindingAbstract(boolean bindingAbstract)


setBindingInheritance

public void setBindingInheritance(String bindingInheritance)


setClassMappingInheritance

public void setClassMappingInheritance(String classMappingInheritance)


setClasspath

public void setClasspath(org.objectweb.jorm.util.io.api.PathExplorer classpath)


setDtdLocations

public void setDtdLocations(ArrayList dtdLocations)


setGeneratedPDFiles

public void setGeneratedPDFiles(boolean generatedPDFiles)


setGeneratedWithMapperPackage

public void setGeneratedWithMapperPackage(boolean generatedWithMapperPackage)


setInputFiles

public void setInputFiles(Collection inputFiles)


setJavac

public void setJavac(boolean javac)


setKeepSrc

public void setKeepSrc(boolean keepSrc)


setLogConfFile

public void setLogConfFile(String logConfFile)


setOutput

public void setOutput(String output)


setProjectName

public void setProjectName(String projectName)


setVerbose

public void setVerbose(boolean verbose)