org.apache.cayenne.gen

Class EntityArtifact

java.lang.Object

org.apache.cayenne.gen.EntityArtifact

All Implemented Interfaces:

Artifact

Direct Known Subclasses:

ClientEntityArtifact

public class EntityArtifact
extends Object
implements Artifact

Artifact facade for an ObjEntity.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjEntity	entity
static String	ENTITY_UTILS_KEY

Fields inherited from interface org.apache.cayenne.gen.Artifact

BASE_CLASS_KEY, BASE_PACKAGE_KEY, IMPORT_UTILS_KEY, OBJECT_KEY, STRING_UTILS_KEY, SUB_CLASS_KEY, SUB_PACKAGE_KEY, SUPER_CLASS_KEY, SUPER_PACKAGE_KEY

Constructor Summary

Constructors

Constructor and Description
EntityArtifact(ObjEntity entity)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getObject() Returns ObjEntity.
String	getQualifiedBaseClassName()
String	getQualifiedClassName()
TemplateType	getSingleClassType()
TemplateType	getSubclassType()
TemplateType	getSuperClassType()
TemplateType[]	getTemplateTypes(ArtifactGenerationMode mode)
void	postInitContext(org.apache.velocity.VelocityContext context) A callback method that allows each artifact to add its own special keys to the context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITY_UTILS_KEY

public static String ENTITY_UTILS_KEY

entity

protected ObjEntity entity

Constructor Detail

EntityArtifact

public EntityArtifact(ObjEntity entity)

Method Detail

getObject

public Object getObject()

Returns ObjEntity.

Specified by:

getObject in interface Artifact

getQualifiedBaseClassName

public String getQualifiedBaseClassName()

Specified by:

getQualifiedBaseClassName in interface Artifact

getQualifiedClassName

public String getQualifiedClassName()

Specified by:

getQualifiedClassName in interface Artifact

getSingleClassType

public TemplateType getSingleClassType()

getSubclassType

public TemplateType getSubclassType()

getSuperClassType

public TemplateType getSuperClassType()

getTemplateTypes

public TemplateType[] getTemplateTypes(ArtifactGenerationMode mode)

Specified by:

getTemplateTypes in interface Artifact

postInitContext

public void postInitContext(org.apache.velocity.VelocityContext context)

Description copied from interface: Artifact

A callback method that allows each artifact to add its own special keys to the context. Invoked from ClassGenerationAction.resetContextForArtifactTemplate(Artifact, TemplateType), after the context is initialized by code generator, so this method can use predefined keys from the context.

Specified by:

postInitContext in interface Artifact