|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.gen.MapClassGenerator
public abstract class MapClassGenerator
Generates Java source code for ObjEntities in the DataMap. This class is abstract and
does not deal with filesystem issues directly. Concrete subclasses should provide ways
to store generated files by implementing openWriter(ObjEntity, String, String)
and closeWriter(Writer)
methods.
Field Summary | |
---|---|
protected boolean |
client
|
static java.lang.String |
CLIENT_SUBCLASS_TEMPLATE_1_2
|
static java.lang.String |
CLIENT_SUPERCLASS_TEMPLATE_1_2
|
protected DataMap |
dataMap
|
protected static java.lang.String |
DEFAULT_VERSION
|
protected java.lang.String |
mode
|
protected static java.lang.String |
MODE_DATAMAP
|
protected static java.lang.String |
MODE_ENTITY
|
protected java.util.List |
objEntities
|
static java.lang.String |
SINGLE_CLASS_TEMPLATE
|
static java.lang.String |
SINGLE_CLASS_TEMPLATE_1_1
|
static java.lang.String |
SINGLE_CLASS_TEMPLATE_1_2
|
static java.lang.String |
SUBCLASS_TEMPLATE
|
static java.lang.String |
SUBCLASS_TEMPLATE_1_1
|
static java.lang.String |
SUBCLASS_TEMPLATE_1_2
|
static java.lang.String |
SUPERCLASS_PREFIX
|
static java.lang.String |
SUPERCLASS_TEMPLATE
|
static java.lang.String |
SUPERCLASS_TEMPLATE_1_1
|
static java.lang.String |
SUPERCLASS_TEMPLATE_1_2
|
protected java.lang.String |
superPkg
|
protected static java.lang.String |
VERSION_1_1
|
protected static java.lang.String |
VERSION_1_2
|
protected java.lang.String |
versionString
|
protected foundrylogic.vpp.VPPConfig |
vppConfig
|
Constructor Summary | |
---|---|
MapClassGenerator()
|
|
MapClassGenerator(DataMap dataMap)
|
|
MapClassGenerator(DataMap dataMap,
java.util.List objEntities)
Creates a new MapClassGenerator. |
|
MapClassGenerator(java.util.List objEntities)
Deprecated. Since 1.2 use MapClassGenerator(DataMap, List) to provide support for v1.2 templates. |
Method Summary | |
---|---|
abstract void |
closeWriter(java.io.Writer out)
Closes writer after class code has been successfully written by ClassGenerationInfo. |
protected java.lang.String |
defaultSingleClassTemplate()
|
protected java.lang.String |
defaultSubclassTemplate()
|
protected java.lang.String |
defaultSuperclassTemplate()
|
void |
generateClassPairs()
Runs class generation. |
void |
generateClassPairs(java.lang.String classTemplate,
java.lang.String superTemplate,
java.lang.String superPrefix)
Runs class generation. |
void |
generateSingleClasses()
Runs class generation. |
void |
generateSingleClasses(java.lang.String classTemplate)
Deprecated. Use generateSingleClasses(String classTemplate, String superPrefix) instead. |
void |
generateSingleClasses(java.lang.String classTemplate,
java.lang.String superPrefix)
Runs class generation. |
DataMap |
getDataMap()
|
java.util.List |
getObjEntities()
|
java.lang.String |
getSuperPkg()
Returns "superPkg" property value - a name of a superclass package that should be used for all generated superclasses. |
java.lang.String |
getVersionString()
|
foundrylogic.vpp.VPPConfig |
getVppConfig()
|
protected void |
initClassGenerator_1_1(ClassGenerationInfo gen,
ObjEntity entity,
boolean superclass)
Initializes ClassGenerationInfo with class name and package of a generated class. |
boolean |
isClient()
Returns whether a default client object template will be used. |
abstract java.io.Writer |
openWriter(ObjEntity entity,
java.lang.String pkgName,
java.lang.String className)
Creates a Writer to output source code for a given ObjEntity and Java class. |
void |
setClient(boolean client)
Sets whether a default client object template should be used. |
void |
setDataMap(DataMap dataMap)
|
void |
setMode(java.lang.String mode)
|
void |
setObjEntities(java.util.List objEntities)
Initializes internal ObjEntities list. |
void |
setSuperPkg(java.lang.String superPkg)
Sets "superPkg" property value. |
void |
setVersionString(java.lang.String versionString)
|
void |
setVppConfig(foundrylogic.vpp.VPPConfig vppConfig)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SINGLE_CLASS_TEMPLATE_1_1
public static final java.lang.String SUBCLASS_TEMPLATE_1_1
public static final java.lang.String SUPERCLASS_TEMPLATE_1_1
public static final java.lang.String SINGLE_CLASS_TEMPLATE_1_2
public static final java.lang.String SUBCLASS_TEMPLATE_1_2
public static final java.lang.String SUPERCLASS_TEMPLATE_1_2
public static final java.lang.String CLIENT_SUBCLASS_TEMPLATE_1_2
public static final java.lang.String CLIENT_SUPERCLASS_TEMPLATE_1_2
public static final java.lang.String SINGLE_CLASS_TEMPLATE
public static final java.lang.String SUBCLASS_TEMPLATE
public static final java.lang.String SUPERCLASS_TEMPLATE
public static final java.lang.String SUPERCLASS_PREFIX
protected static final java.lang.String VERSION_1_1
protected static final java.lang.String VERSION_1_2
protected static final java.lang.String DEFAULT_VERSION
protected static final java.lang.String MODE_DATAMAP
protected static final java.lang.String MODE_ENTITY
protected java.lang.String versionString
protected java.util.List objEntities
protected java.lang.String superPkg
protected DataMap dataMap
protected foundrylogic.vpp.VPPConfig vppConfig
protected java.lang.String mode
protected boolean client
Constructor Detail |
---|
public MapClassGenerator()
public MapClassGenerator(DataMap dataMap)
public MapClassGenerator(DataMap dataMap, java.util.List objEntities)
public MapClassGenerator(java.util.List objEntities)
Method Detail |
---|
protected java.lang.String defaultSingleClassTemplate()
protected java.lang.String defaultSubclassTemplate()
protected java.lang.String defaultSuperclassTemplate()
public abstract java.io.Writer openWriter(ObjEntity entity, java.lang.String pkgName, java.lang.String className) throws java.lang.Exception
java.lang.Exception
public abstract void closeWriter(java.io.Writer out) throws java.lang.Exception
java.lang.Exception
public void generateClassPairs() throws java.lang.Exception
java.lang.Exception
public void generateClassPairs(java.lang.String classTemplate, java.lang.String superTemplate, java.lang.String superPrefix) throws java.lang.Exception
superPrefix
.
java.lang.Exception
public void generateSingleClasses() throws java.lang.Exception
java.lang.Exception
public void generateSingleClasses(java.lang.String classTemplate) throws java.lang.Exception
java.lang.Exception
public void generateSingleClasses(java.lang.String classTemplate, java.lang.String superPrefix) throws java.lang.Exception
java.lang.Exception
protected void initClassGenerator_1_1(ClassGenerationInfo gen, ObjEntity entity, boolean superclass)
public java.lang.String getSuperPkg()
public void setSuperPkg(java.lang.String superPkg)
public boolean isClient()
public void setClient(boolean client)
public DataMap getDataMap()
public void setDataMap(DataMap dataMap)
dataMap
- The dataMap to set.public java.util.List getObjEntities()
public void setObjEntities(java.util.List objEntities)
public java.lang.String getVersionString()
public void setVersionString(java.lang.String versionString)
versionString
- The versionString to set.public foundrylogic.vpp.VPPConfig getVppConfig()
public void setVppConfig(foundrylogic.vpp.VPPConfig vppConfig)
vppConfig
- The vppConfig to set.public void setMode(java.lang.String mode)
mode
- use "entity" for per-entity generation and "datamap" for per-datamap
generation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |