Package org.codehaus.modello.plugin

Class AbstractModelloGenerator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.modello.plugin.AbstractModelloGenerator

All Implemented Interfaces:

ModelloGenerator, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

AbstractJavaModelloGenerator, AbstractXmlGenerator

public abstract class AbstractModelloGenerator
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ModelloGenerator, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Field Summary

Fields

Modifier and Type	Field	Description
private org.sonatype.plexus.build.incremental.BuildContext	buildContext
private java.lang.String	encoding
private Version	generatedVersion
private Model	model
private java.io.File	outputDirectory
private boolean	packageWithVersion

Constructor Summary

Constructors

Constructor	Description
AbstractModelloGenerator()

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	capitalise(java.lang.String str)
void	contextualize(org.codehaus.plexus.context.Context ctx)
protected org.sonatype.plexus.build.incremental.BuildContext	getBuildContext()
protected java.lang.String	getEncoding()
protected java.util.List<ModelField>	getFieldsForClass(ModelClass modelClass)	Return the child fields of this class.
protected Version	getGeneratedVersion()
protected java.lang.String	getHeader()
protected Model	getModel()
java.io.File	getOutputDirectory()
protected java.lang.String	getParameter(java.lang.String name, java.util.Properties parameters)	Deprecated. Use getParameter(Properties, String) instead
protected java.lang.String	getParameter(java.util.Properties parameters, java.lang.String name)
protected java.lang.String	getParameter(java.util.Properties parameters, java.lang.String name, java.lang.String defaultValue)
protected void	initialize(Model model, java.util.Properties parameters)
protected boolean	isClassInModel(java.lang.String fieldType, Model model)
protected boolean	isCollection(java.lang.String fieldType)
protected boolean	isEmpty(java.lang.String string)
protected boolean	isInnerAssociation(ModelField field)
protected boolean	isMap(java.lang.String fieldType)
protected boolean	isPackageWithVersion()
static java.lang.String	singular(java.lang.String name)
static java.lang.String	uncapitalise(java.lang.String str)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.modello.plugin.ModelloGenerator

generate

Field Detail

model

private Model model

outputDirectory

private java.io.File outputDirectory

generatedVersion

private Version generatedVersion

packageWithVersion

private boolean packageWithVersion

encoding

private java.lang.String encoding

buildContext

private org.sonatype.plexus.build.incremental.BuildContext buildContext

Constructor Detail

AbstractModelloGenerator

public AbstractModelloGenerator()

Method Detail

initialize

protected void initialize(Model model,
                          java.util.Properties parameters)
                   throws ModelloException

Throws:

ModelloException

getModel

protected Model getModel()

getGeneratedVersion

protected Version getGeneratedVersion()

isPackageWithVersion

protected boolean isPackageWithVersion()

getOutputDirectory

public java.io.File getOutputDirectory()

getEncoding

protected java.lang.String getEncoding()

getHeader

protected java.lang.String getHeader()

isClassInModel

protected boolean isClassInModel(java.lang.String fieldType,
                                 Model model)

getFieldsForClass

protected java.util.List<ModelField> getFieldsForClass(ModelClass modelClass)

Return the child fields of this class.

Parameters:

modelClass - current class

Returns:

the list of fields of this class

isInnerAssociation

protected boolean isInnerAssociation(ModelField field)

isMap

protected boolean isMap(java.lang.String fieldType)

isCollection

protected boolean isCollection(java.lang.String fieldType)

capitalise

protected java.lang.String capitalise(java.lang.String str)

singular

public static java.lang.String singular(java.lang.String name)

uncapitalise

public static java.lang.String uncapitalise(java.lang.String str)

isEmpty

protected boolean isEmpty(java.lang.String string)

getParameter

protected java.lang.String getParameter(java.lang.String name,
                                        java.util.Properties parameters)

Deprecated.

Use getParameter(Properties, String) instead

getParameter

protected java.lang.String getParameter(java.util.Properties parameters,
                                        java.lang.String name)

getParameter

protected java.lang.String getParameter(java.util.Properties parameters,
                                        java.lang.String name,
                                        java.lang.String defaultValue)

contextualize

public void contextualize(org.codehaus.plexus.context.Context ctx)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

getBuildContext

protected org.sonatype.plexus.build.incremental.BuildContext getBuildContext()