org.objectweb.jorm.compiler.api
Interface JormCompilerParameter

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

public interface JormCompilerParameter
extends java.lang.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 java.lang.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 java.lang.String INHERITANCE_PACKAGE_PATTERN
           
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String computePBindingInheritance(java.lang.String cn)
          Computes the actual class name which the generated PBinding class must extend.
 java.lang.String computePClassMappingInheritance(java.lang.String cn)
          Computes the actual class name which the generated PClassMapping class must extend.
 java.lang.String getBindingEnhancedClass()
           
 java.lang.String getBindingInheritance()
           
 java.lang.String getClassMappingInheritance()
           
 org.objectweb.jorm.util.io.api.PathExplorer getClasspath()
           
 java.util.ArrayList getDtdLocations()
           
 java.util.Collection getInputFiles()
           
 java.lang.String getJavacName()
           
 java.lang.String getOutput()
           
 java.lang.String getProjectName()
           
 java.lang.String getStateInheritance()
           
 boolean isBindingAbstract()
           
 boolean isGenerateBinding()
           
 boolean isGeneratedPDFiles()
           
 boolean isGeneratedWithMapperPackage()
           
 boolean isJavac()
           
 boolean isKeepSrc()
           
 boolean isParseOnly()
           
 boolean isStateGenerated()
           
 boolean isVerbose()
           
 void loadConfFile(java.io.InputStream in, java.util.Iterator knownmappers)
          Load a jorm configuration file.
 void loadConfFile(java.lang.String file, java.util.Iterator knownmappers)
          Load a jorm configuration file.
 void print()
          Prints informations managed by the current object.
 void setBindingAbstract(boolean bindingAbstract)
           
 void setBindingEnhancedClass(java.lang.String bindingEnhancedClass)
           
 void setBindingInheritance(java.lang.String bindingInheritance)
           
 void setClassMappingInheritance(java.lang.String classMappingInheritance)
           
 void setClasspath(org.objectweb.jorm.util.io.api.PathExplorer classpath)
           
 void setDtdLocations(java.util.ArrayList dtdLocations)
           
 void setGenerateBinding(boolean v)
           
 void setGeneratedPDFiles(boolean generatedPDFiles)
           
 void setGeneratedWithMapperPackage(boolean generatedWithMapperPackage)
           
 void setInputFiles(java.util.Collection inputFiles)
           
 void setJavac(boolean javac)
           
 void setKeepSrc(boolean keepSrc)
           
 void setLogConfFile(java.lang.String logConfFile)
           
 void setOutput(java.lang.String output)
           
 void setProjectName(java.lang.String projectName)
           
 void setStateGenerated(boolean v)
           
 void setStateInheritance(java.lang.String stateInheritance)
           
 void setVerbose(boolean verbose)
           
 
Methods inherited from interface org.objectweb.jorm.util.api.Loggable
getLogger, getLoggerFactory, setLogger, setLoggerFactory
 

Field Detail

INHERITANCE_CLASSNAME_PATTERN

public static final java.lang.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.

See Also:
Constant Field Values

INHERITANCE_PACKAGE_PATTERN

public static final java.lang.String INHERITANCE_PACKAGE_PATTERN
See Also:
Constant Field Values
Method Detail

print

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


computePClassMappingInheritance

public java.lang.String computePClassMappingInheritance(java.lang.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.

computePBindingInheritance

public java.lang.String computePBindingInheritance(java.lang.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.

loadConfFile

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

Parameters:
file - the name of the jorm configuration file
Throws:
PException

loadConfFile

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

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

getClasspath

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

getOutput

public java.lang.String getOutput()
Returns:
the output directory where the generated will be put

isVerbose

public boolean isVerbose()
Returns:
a boolean value indicating if the verbose mode is activated

getInputFiles

public java.util.Collection getInputFiles()

isKeepSrc

public boolean isKeepSrc()

getJavacName

public java.lang.String getJavacName()

getProjectName

public java.lang.String getProjectName()

isJavac

public boolean isJavac()

isParseOnly

public boolean isParseOnly()

isGenerateBinding

public boolean isGenerateBinding()

isStateGenerated

public boolean isStateGenerated()

getStateInheritance

public java.lang.String getStateInheritance()
Returns:
the name of the class extended by the generated XXXState classes

getBindingInheritance

public java.lang.String getBindingInheritance()
Returns:
the name of the class inherited by the generated XXXBinding

getBindingEnhancedClass

public java.lang.String getBindingEnhancedClass()

getClassMappingInheritance

public java.lang.String getClassMappingInheritance()

isBindingAbstract

public boolean isBindingAbstract()

getDtdLocations

public java.util.ArrayList getDtdLocations()

isGeneratedPDFiles

public boolean isGeneratedPDFiles()

isGeneratedWithMapperPackage

public boolean isGeneratedWithMapperPackage()

setClasspath

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

setOutput

public void setOutput(java.lang.String output)

setVerbose

public void setVerbose(boolean verbose)

setKeepSrc

public void setKeepSrc(boolean keepSrc)

setProjectName

public void setProjectName(java.lang.String projectName)

setJavac

public void setJavac(boolean javac)

setGenerateBinding

public void setGenerateBinding(boolean v)

setStateGenerated

public void setStateGenerated(boolean v)

setStateInheritance

public void setStateInheritance(java.lang.String stateInheritance)

setBindingInheritance

public void setBindingInheritance(java.lang.String bindingInheritance)

setBindingEnhancedClass

public void setBindingEnhancedClass(java.lang.String bindingEnhancedClass)

setClassMappingInheritance

public void setClassMappingInheritance(java.lang.String classMappingInheritance)

setBindingAbstract

public void setBindingAbstract(boolean bindingAbstract)

setDtdLocations

public void setDtdLocations(java.util.ArrayList dtdLocations)

setGeneratedPDFiles

public void setGeneratedPDFiles(boolean generatedPDFiles)

setInputFiles

public void setInputFiles(java.util.Collection inputFiles)

setGeneratedWithMapperPackage

public void setGeneratedWithMapperPackage(boolean generatedWithMapperPackage)

setLogConfFile

public void setLogConfFile(java.lang.String logConfFile)

clone

public java.lang.Object clone()