|
||||||||||
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 String |
CLIENT_SUBCLASS_TEMPLATE_1_2
|
static String |
CLIENT_SUPERCLASS_TEMPLATE_1_2
|
protected DataMap |
dataMap
|
protected static String |
DEFAULT_VERSION
|
protected String |
mode
|
protected static String |
MODE_DATAMAP
|
protected static String |
MODE_ENTITY
|
protected List |
objEntities
|
static String |
SINGLE_CLASS_TEMPLATE
|
static String |
SINGLE_CLASS_TEMPLATE_1_1
|
static String |
SINGLE_CLASS_TEMPLATE_1_2
|
static String |
SUBCLASS_TEMPLATE
|
static String |
SUBCLASS_TEMPLATE_1_1
|
static String |
SUBCLASS_TEMPLATE_1_2
|
static String |
SUPERCLASS_PREFIX
|
static String |
SUPERCLASS_TEMPLATE
|
static String |
SUPERCLASS_TEMPLATE_1_1
|
static String |
SUPERCLASS_TEMPLATE_1_2
|
protected String |
superPkg
|
protected static String |
VERSION_1_1
|
protected static String |
VERSION_1_2
|
protected String |
versionString
|
protected foundrylogic.vpp.VPPConfig |
vppConfig
|
Constructor Summary | |
---|---|
MapClassGenerator()
|
|
MapClassGenerator(DataMap dataMap)
|
|
MapClassGenerator(DataMap dataMap,
List objEntities)
Creates a new MapClassGenerator. |
Method Summary | |
---|---|
abstract void |
closeWriter(Writer out)
Closes writer after class code has been successfully written by ClassGenerationInfo. |
protected String |
defaultSingleClassTemplate()
|
protected String |
defaultSubclassTemplate()
|
protected String |
defaultSuperclassTemplate()
|
void |
generateClassPairs()
Runs class generation. |
void |
generateClassPairs(String classTemplate,
String superTemplate,
String superPrefix)
Runs class generation. |
void |
generateSingleClasses()
Runs class generation. |
void |
generateSingleClasses(String classTemplate,
String superPrefix)
Runs class generation. |
DataMap |
getDataMap()
|
List |
getObjEntities()
|
String |
getSuperPkg()
Returns "superPkg" property value - a name of a superclass package that should be used for all generated superclasses. |
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 Writer |
openWriter(ObjEntity entity,
String pkgName,
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(String mode)
|
void |
setObjEntities(List objEntities)
Initializes internal ObjEntities list. |
void |
setSuperPkg(String superPkg)
Sets "superPkg" property value. |
void |
setVersionString(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 String SINGLE_CLASS_TEMPLATE_1_1
public static final String SUBCLASS_TEMPLATE_1_1
public static final String SUPERCLASS_TEMPLATE_1_1
public static final String SINGLE_CLASS_TEMPLATE_1_2
public static final String SUBCLASS_TEMPLATE_1_2
public static final String SUPERCLASS_TEMPLATE_1_2
public static final String CLIENT_SUBCLASS_TEMPLATE_1_2
public static final String CLIENT_SUPERCLASS_TEMPLATE_1_2
public static final String SINGLE_CLASS_TEMPLATE
public static final String SUBCLASS_TEMPLATE
public static final String SUPERCLASS_TEMPLATE
public static final String SUPERCLASS_PREFIX
protected static final String VERSION_1_1
protected static final String VERSION_1_2
protected static final String DEFAULT_VERSION
protected static final String MODE_DATAMAP
protected static final String MODE_ENTITY
protected String versionString
protected List objEntities
protected String superPkg
protected DataMap dataMap
protected foundrylogic.vpp.VPPConfig vppConfig
protected String mode
protected boolean client
Constructor Detail |
---|
public MapClassGenerator()
public MapClassGenerator(DataMap dataMap)
public MapClassGenerator(DataMap dataMap, List objEntities)
Method Detail |
---|
protected String defaultSingleClassTemplate()
protected String defaultSubclassTemplate()
protected String defaultSuperclassTemplate()
public abstract Writer openWriter(ObjEntity entity, String pkgName, String className) throws Exception
Exception
public abstract void closeWriter(Writer out) throws Exception
Exception
public void generateClassPairs() throws Exception
Exception
public void generateClassPairs(String classTemplate, String superTemplate, String superPrefix) throws Exception
superPrefix
.
Exception
public void generateSingleClasses() throws Exception
Exception
public void generateSingleClasses(String classTemplate, String superPrefix) throws Exception
Exception
protected void initClassGenerator_1_1(ClassGenerationInfo gen, ObjEntity entity, boolean superclass)
public String getSuperPkg()
public void setSuperPkg(String superPkg)
public boolean isClient()
public void setClient(boolean client)
public DataMap getDataMap()
public void setDataMap(DataMap dataMap)
dataMap
- The dataMap to set.public List getObjEntities()
public void setObjEntities(List objEntities)
public String getVersionString()
public void setVersionString(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(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 |