|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.gen.ClassGenerationInfo
public class ClassGenerationInfo
Class generation engine for ObjEntities based on Velocity templates . Instance of ClassGenerationInfo is available inside Velocity template under the key "classGen".
Field Summary | |
---|---|
protected java.lang.String |
className
|
protected ObjEntity |
entity
|
protected java.lang.String |
packageName
|
protected java.lang.String |
prop
|
protected java.lang.String |
superClassName
|
protected java.lang.String |
superPackageName
|
protected java.lang.String |
superPrefix
|
Constructor Summary | |
---|---|
ClassGenerationInfo()
|
Method Summary | |
---|---|
java.lang.String |
capitalized(java.lang.String name)
Capitalizes the first letter of the property name. |
java.lang.String |
capitalizedAsConstant(java.lang.String name)
Converts property name to Java constants naming convention. |
java.lang.String |
formatJavaType(java.lang.String type)
|
java.lang.String |
formatVariableName(java.lang.String variableName)
|
java.lang.String |
getCappedProp()
Returns current property name with capitalized first letter |
java.lang.String |
getClassName()
Returns class name (without a package) of the class associated with this generator. |
ObjEntity |
getEntity()
Returns entity for the class associated with this generator. |
java.lang.String |
getPackageName()
Returns Java package name of the class associated with this generator. |
java.lang.String |
getProp()
|
java.lang.String |
getPropAsConstantName()
|
java.lang.String |
getSuperClassName()
Returns the fully qualified super class of the data object class associated with this generator |
java.lang.String |
getSuperPackageName()
Returns superPackageName property that defines a
superclass's package name. |
java.lang.String |
getSuperPrefix()
Returns prefix used to distinguish between superclass and subclass when generating classes in pairs. |
boolean |
isContainingDeclaredListProperties()
Returns true if current entity contains at least one Declared List property. |
boolean |
isContainingListProperties()
Returns true if current entity contains at least one List property. |
boolean |
isUsingPackage()
Returns true if a class associated with this generator is
located in a package. |
boolean |
isUsingSuperPackage()
Returns true if a superclass class associated with this
generator is located in a package. |
protected void |
setClassName(java.lang.String className)
Sets class name of the class associated with this generator. |
protected void |
setObjEntity(ObjEntity entity)
|
protected void |
setPackageName(java.lang.String packageName)
Sets Java package name of the class associated with this generator. |
void |
setProp(java.lang.String prop)
Sets current class property name. |
protected void |
setSuperClassName(java.lang.String value)
Sets the fully qualified super class of the data object class associated with this generator |
protected void |
setSuperPackageName(java.lang.String superPackageName)
Sets superPackageName property that defines a superclass's
package name. |
protected void |
setSuperPrefix(java.lang.String superPrefix)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ObjEntity entity
protected java.lang.String packageName
protected java.lang.String className
protected java.lang.String superPrefix
protected java.lang.String prop
protected java.lang.String superPackageName
protected java.lang.String superClassName
Constructor Detail |
---|
public ClassGenerationInfo()
Method Detail |
---|
public java.lang.String getPackageName()
protected void setPackageName(java.lang.String packageName)
public java.lang.String getSuperPackageName()
superPackageName
property that defines a
superclass's package name.
protected void setSuperPackageName(java.lang.String superPackageName)
superPackageName
property that defines a superclass's
package name.
public java.lang.String getClassName()
protected void setClassName(java.lang.String className)
protected void setSuperPrefix(java.lang.String superPrefix)
public java.lang.String formatJavaType(java.lang.String type)
public java.lang.String formatVariableName(java.lang.String variableName)
public java.lang.String getSuperPrefix()
public void setProp(java.lang.String prop)
public java.lang.String getProp()
public java.lang.String capitalized(java.lang.String name)
public java.lang.String capitalizedAsConstant(java.lang.String name)
public java.lang.String getCappedProp()
public java.lang.String getPropAsConstantName()
public boolean isContainingDeclaredListProperties()
public boolean isContainingListProperties()
public boolean isUsingPackage()
true
if a class associated with this generator is
located in a package.
public boolean isUsingSuperPackage()
true
if a superclass class associated with this
generator is located in a package.
public ObjEntity getEntity()
protected void setObjEntity(ObjEntity entity)
entity
- The entity to set.public java.lang.String getSuperClassName()
protected void setSuperClassName(java.lang.String value)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |