org.objectweb.jorm.generator.lib
Class BinderGenerator

java.lang.Object
  extended byorg.objectweb.jorm.generator.lib.CommonHelper
      extended byorg.objectweb.jorm.generator.lib.CommonGenerator
          extended byorg.objectweb.jorm.generator.lib.BinderGenerator
All Implemented Interfaces:
Loggable

public class BinderGenerator
extends CommonGenerator

This class is a generator of XXXBinder objects. It is generic either the mapper type. This generator use the velocity tools. The used template is Binder.vm . Associated to this template this generator builds a velocity context which contains the following information:

KeyValue
"compositename"The reference to the compositename meta object
"tools" The reference to the CommonHelper
"header" The file name of the common template which contains the header of the generate files.


Nested Class Summary
 class BinderGenerator.AutoCalculatedFieldInfo
           
 
Field Summary
 
Fields inherited from class org.objectweb.jorm.generator.lib.CommonGenerator
GEN_TEMPLATE_DIR, logger, loggerFactory, MAPPER_TEMPLATE_DIR, velocityEngine
 
Fields inherited from class org.objectweb.jorm.generator.lib.CommonHelper
debug, PN_GET_TYPES
 
Constructor Summary
BinderGenerator()
           
 
Method Summary
 boolean containsObject(CompositeName cn)
           
 boolean containsPrimitive(CompositeName cn)
           
 void generate(CompositeName co, TargetHolder holder, JormCompilerParameter cp)
          This method generates a XPBinder file corresponding to the co parameter in the directory parameter.
 java.lang.String getCoderGetter(PType t)
           
 java.lang.String getCoderSetter(PType t)
           
 java.lang.String getNullValue(PrimitiveElement pe)
           
 java.lang.String getPNameFromGenericPNG(CompositeName cn, java.lang.String pngVar, java.lang.String ctxVar)
           
 java.lang.String getPNameFromGenericPNG(CompositeName cn, java.lang.String pngVar, java.lang.String ctxVar, java.lang.String connVar)
           
 java.lang.String getPNameFromSpecificPNG(CompositeName cn, java.lang.String pngVar, java.lang.String ctxVar)
           
 java.lang.String getPNameFromSpecificPNG(CompositeName cn, java.lang.String pngVar, java.lang.String ctxVar, java.lang.String connVar)
           
 java.lang.String getTestNullValues(CompositeName cn, boolean generic, java.lang.String ctx)
           
 
Methods inherited from class org.objectweb.jorm.generator.lib.CommonGenerator
getLogger, getLoggerFactory, getTemplateLibraries, setLogger, setLoggerFactory, setVelocityEngine
 
Methods inherited from class org.objectweb.jorm.generator.lib.CommonHelper
buildPemList, canBeNullValue, comparePE, containsCharArrayField, containsCompositeName, containsFieldWhichCanBeNull, containsGenClassRef, containsReference, containsSerializedField, debug, getCNPackageName, getCoderName, getCompositeNameDefEntries, getCompositeReferences, getCTDeclaration, getCTDeclaration, getFQNOfCompositeName, getInheritedClasses, getPaGetMethod, getPaSetMethod, getPemPos, getPNameDecodeFunction, getPNameEncodeFunction, getPNameGetterGetFunction, getPNGTypes, getPrimitiveElement, getPrimitiveElement, getProjectionField, getPType, getPTypeBigDecimal, getPTypeBigInteger, getPTypeBoolean, getPTypeByte, getPTypeByteArray, getPTypeChar, getPTypeCharArray, getPTypeDate, getPTypeDouble, getPTypeFloat, getPTypeInt, getPTypeLong, getPTypeOboolean, getPTypeObyte, getPTypeOchar, getPTypeOdouble, getPTypeOfloat, getPTypeOint, getPTypeOlong, getPTypeOshort, getPTypeReference, getPTypeSerialized, getPTypeShort, getPTypeString, getRefNameDef, getTupleDecoding, getTupleDecoding, getTupleGetter, isCharArrayType, isClass, isClassRef, isCompositeName, isFieldName, isGenClassRef, isHiddenField, isNull, isObjectType, isPrimitiveElement, isReference, isSerializedField, isSerializedType, isValidString, log, not, upperFL
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BinderGenerator

public BinderGenerator()
Method Detail

generate

public void generate(CompositeName co,
                     TargetHolder holder,
                     JormCompilerParameter cp)
              throws PException
This method generates a XPBinder file corresponding to the co parameter in the directory parameter.

Parameters:
co - The meta object interface.
holder - The target holder which allows to create files.
cp - This parameter permits to reach the compilation parameters.
Throws:
PException

containsObject

public boolean containsObject(CompositeName cn)
                       throws PException
Throws:
PException

containsPrimitive

public boolean containsPrimitive(CompositeName cn)
                          throws PException
Throws:
PException

getNullValue

public java.lang.String getNullValue(PrimitiveElement pe)

getPNameFromSpecificPNG

public java.lang.String getPNameFromSpecificPNG(CompositeName cn,
                                                java.lang.String pngVar,
                                                java.lang.String ctxVar)
                                         throws PException
Throws:
PException

getPNameFromSpecificPNG

public java.lang.String getPNameFromSpecificPNG(CompositeName cn,
                                                java.lang.String pngVar,
                                                java.lang.String ctxVar,
                                                java.lang.String connVar)
                                         throws PException
Throws:
PException

getPNameFromGenericPNG

public java.lang.String getPNameFromGenericPNG(CompositeName cn,
                                               java.lang.String pngVar,
                                               java.lang.String ctxVar)
                                        throws PException
Throws:
PException

getPNameFromGenericPNG

public java.lang.String getPNameFromGenericPNG(CompositeName cn,
                                               java.lang.String pngVar,
                                               java.lang.String ctxVar,
                                               java.lang.String connVar)
                                        throws PException
Throws:
PException

getTestNullValues

public java.lang.String getTestNullValues(CompositeName cn,
                                          boolean generic,
                                          java.lang.String ctx)
                                   throws PException
Throws:
PException

getCoderSetter

public java.lang.String getCoderSetter(PType t)

getCoderGetter

public java.lang.String getCoderGetter(PType t)