org.codehaus.modello.plugins.xml

Class AbstractXmlJavaGenerator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.modello.plugin.AbstractModelloGenerator

org.codehaus.modello.plugin.java.AbstractJavaModelloGenerator

org.codehaus.modello.plugins.xml.AbstractXmlJavaGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractJDOMGenerator, AbstractStaxGenerator, AbstractXpp3Generator, Dom4jReaderGenerator, Dom4jWriterGenerator

public abstract class AbstractXmlJavaGenerator
extends AbstractJavaModelloGenerator

Abstract class for plugins generating Java code for XML representation of the model.

Author:

Hervé Boutemy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	strictXmlAttributes

Fields inherited from class org.codehaus.modello.plugin.java.AbstractJavaModelloGenerator

DEFAULT_DATE_FORMAT, domAsXpp3, useJava5

Constructor Summary

Constructors

Constructor and Description
AbstractXmlJavaGenerator()

Method Summary

Modifier and Type	Method and Description
protected ModelField	getContentField(List<ModelField> modelFields) Get the field which type is Content if any.
protected List<ModelField>	getFieldsForXml(ModelClass modelClass, Version version) Return the XML fields of this class, with proper XML order and no XML transient fields.
protected String	getFileName(String suffix)
protected String	getValue(String type, String initialValue, XmlFieldMetadata xmlFieldMetadata)
protected void	initialize(Model model, Properties parameters)
protected String	resolveTagName(ModelClass modelClass) Resolve XML tag name for a class.
protected String	resolveTagName(ModelField modelField, XmlFieldMetadata xmlFieldMetadata) Resolve XML tag name for a field.
protected String	resolveTagName(String fieldTagName, XmlAssociationMetadata xmlAssociationMetadata) Resolve XML tag name for an item in an association with many multiplicity.
protected void	writeDateParsingHelper(JSourceCode sc, String exception)

Methods inherited from class org.codehaus.modello.plugin.java.AbstractJavaModelloGenerator

addModelImports, getClasses, getDefaultValue, getJavaDefaultValue, getPrefix, getValueChecker, initHeader, initHeader, isJavaEnabled, isRelevant, isTrackingSupport, newJSourceWriter, suppressAllWarnings

Methods inherited from class org.codehaus.modello.plugin.AbstractModelloGenerator

capitalise, contextualize, getBuildContext, getEncoding, getFieldsForClass, getGeneratedVersion, getHeader, getModel, getOutputDirectory, getParameter, getParameter, getParameter, isClassInModel, isCollection, isEmpty, isInnerAssociation, isMap, isPackageWithVersion, singular, uncapitalise

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

strictXmlAttributes

protected boolean strictXmlAttributes

Constructor Detail

AbstractXmlJavaGenerator

public AbstractXmlJavaGenerator()

Method Detail

initialize

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

Overrides:

initialize in class AbstractJavaModelloGenerator

Throws:

ModelloException

getFileName

protected String getFileName(String suffix)

resolveTagName

protected String resolveTagName(ModelClass modelClass)

Resolve XML tag name for a class. Note: only root class needs such a resolution.

Parameters:

modelClass - the model class

Returns:

the XML tag name for the class

resolveTagName

protected String resolveTagName(ModelField modelField,
                                XmlFieldMetadata xmlFieldMetadata)

Resolve XML tag name for a field.

Parameters:

modelField - the model field

xmlFieldMetadata - the XML metadata of the field

Returns:

the XML tag name for the field

resolveTagName

protected String resolveTagName(String fieldTagName,
                                XmlAssociationMetadata xmlAssociationMetadata)

Resolve XML tag name for an item in an association with many multiplicity.

Parameters:

fieldTagName - the XML tag name of the field containing the association

xmlAssociationMetadata - the XML metadata of the association

Returns:

the XML tag name for items

getContentField

protected ModelField getContentField(List<ModelField> modelFields)

Get the field which type is Content if any.

Parameters:

modelFields - the fields to check

Returns:

the field, or null if no field is Content

getFieldsForXml

protected List<ModelField> getFieldsForXml(ModelClass modelClass,
                                           Version version)

Return the XML fields of this class, with proper XML order and no XML transient fields.

Parameters:

modelClass - current class

version - the version of the class to use

Returns:

the list of XML fields of this class

getValue

protected String getValue(String type,
                          String initialValue,
                          XmlFieldMetadata xmlFieldMetadata)

writeDateParsingHelper

protected void writeDateParsingHelper(JSourceCode sc,
                                      String exception)