org.codehaus.modello.plugins.xml

Class XmlModelHelpers

java.lang.Object

org.codehaus.modello.plugins.xml.XmlModelHelpers

class XmlModelHelpers
extends java.lang.Object

Helper methods to deal with XML representation of the model.

Constructor Summary

Constructors

Constructor and Description
XmlModelHelpers()

Method Summary

Modifier and Type	Method and Description
(package private) static ModelField	getContentField(java.util.List<ModelField> modelFields) Get the field which type is Content if any.
(package private) static java.util.List<ModelField>	getFieldsForXml(ModelClass modelClass, Version version) Return the XML fields of this class, with proper XML order and no XML transient fields.
(package private) static java.util.List<ModelField>	getXmlAttributeFields(java.util.List<ModelField> modelFields) Gets all fields that are not marked as XML attribute.
(package private) static java.lang.String	resolveTagName(ModelClass modelClass) Resolve XML tag name for a class.
(package private) static java.lang.String	resolveTagName(ModelField modelField, XmlFieldMetadata xmlFieldMetadata) Resolve XML tag name for a field.
(package private) static java.lang.String	resolveTagName(java.lang.String fieldTagName, XmlAssociationMetadata xmlAssociationMetadata) Resolve XML tag name for an item in an association with many multiplicity.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlModelHelpers

XmlModelHelpers()

Method Detail

resolveTagName

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

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

static java.lang.String resolveTagName(java.lang.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

static ModelField getContentField(java.util.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

getXmlAttributeFields

static java.util.List<ModelField> getXmlAttributeFields(java.util.List<ModelField> modelFields)

Gets all fields that are not marked as XML attribute.

Parameters:

modelFields - The collection of model fields from which to extract the XML attributes, must not be null.

Returns:

The list of XML attributes fields, can be empty but never null.

getFieldsForXml

static java.util.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