Package org.codehaus.modello.plugins.xml

Class AbstractXmlGenerator

  • All Implemented Interfaces:
    org.codehaus.modello.plugin.ModelloGenerator
    public abstract class AbstractXmlGenerator
extends org.codehaus.modello.plugin.AbstractModelloGenerator
    Abstract class for plugins working on XML representation of the model, without having any need to generate Java code.
    Author:
    Hervé Boutemy

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.codehaus.modello.model.ModelField getContentField​(java.util.List<org.codehaus.modello.model.ModelField> modelFields)
      Get the field which type is Content if any.
      protected java.util.List<org.codehaus.modello.model.ModelField> getFieldsForXml​(org.codehaus.modello.model.ModelClass modelClass, org.codehaus.modello.model.Version version)
      Return the XML fields of this class, with proper XML order and no XML transient fields.
      protected java.util.List<org.codehaus.modello.model.ModelField> getXmlAttributeFields​(java.util.List<org.codehaus.modello.model.ModelField> modelFields)
      Gets all fields that are not marked as XML attribute.
      protected boolean hasContentField​(java.util.List<org.codehaus.modello.model.ModelField> modelFields)  
      protected void initHeader​(org.codehaus.plexus.util.xml.XMLWriter w)  
      protected java.lang.String resolveTagName​(java.lang.String fieldTagName, XmlAssociationMetadata xmlAssociationMetadata)
      Resolve XML tag name for an item in an association with many multiplicity.
      protected java.lang.String resolveTagName​(org.codehaus.modello.model.ModelClass modelClass)
      Resolve XML tag name for a class.
      protected java.lang.String resolveTagName​(org.codehaus.modello.model.ModelField modelField, XmlFieldMetadata xmlFieldMetadata)
      Resolve XML tag name for a field.

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

        capitalise, getBuildContext, getEncoding, getFieldsForClass, getGeneratedHeader, getGeneratedVersion, getHeader, getLicenseHeader, getLogger, getModel, getOutputDirectory, getParameter, initialize, isClassInModel, isCollection, isEmpty, isInnerAssociation, isMap, isPackageWithVersion, newWriter, newWriter, requireParameter, singular, uncapitalise

      • 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

    • Constructor Detail

      • AbstractXmlGenerator

        public AbstractXmlGenerator()

    • Method Detail

      • initHeader

        protected void initHeader​(org.codehaus.plexus.util.xml.XMLWriter w)

      • resolveTagName

        protected java.lang.String resolveTagName​(org.codehaus.modello.model.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 java.lang.String resolveTagName​(org.codehaus.modello.model.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 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

      • hasContentField

        protected boolean hasContentField​(java.util.List<org.codehaus.modello.model.ModelField> modelFields)

      • getContentField

        protected org.codehaus.modello.model.ModelField getContentField​(java.util.List<org.codehaus.modello.model.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

        protected java.util.List<org.codehaus.modello.model.ModelField> getXmlAttributeFields​(java.util.List<org.codehaus.modello.model.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

        protected java.util.List<org.codehaus.modello.model.ModelField> getFieldsForXml​(org.codehaus.modello.model.ModelClass modelClass,
                                                                                org.codehaus.modello.model.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