org.apache.cayenne.gen

Class DataMapArtifact

java.lang.Object

org.apache.cayenne.gen.DataMapArtifact

All Implemented Interfaces:

Artifact

Direct Known Subclasses:

ClientDataMapArtifact

public class DataMapArtifact
extends Object
implements Artifact

Artifact facade for a DataMap.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
protected DataMap	dataMap
static String	DATAMAP_UTILS_KEY
protected Collection<EJBQLQuery>	ejbqlQueries
protected Collection<ProcedureQuery>	procedureQueries
protected Collection<String>	queryNames
protected Collection<SelectQuery>	selectQueries
protected Collection<SQLTemplate>	sqlTemplateQueries

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
DataMapArtifact(DataMap dataMap, Collection<Query> queries)

Method Summary

Methods

Modifier and Type	Method and Description
DataMap	getDataMap()
Object	getObject() Returns a mapping metadata object for this artifact.
String	getQualifiedBaseClassName()
String	getQualifiedClassName()
Collection<String>	getQueryNames()
Collection<SelectQuery>	getSelectQueries()
TemplateType[]	getTemplateTypes(ArtifactGenerationMode mode)
boolean	hasQueryNames()
boolean	hasSelectQueries()
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

DATAMAP_UTILS_KEY

public static final String DATAMAP_UTILS_KEY

See Also:

Constant Field Values

dataMap

protected DataMap dataMap

selectQueries

protected Collection<SelectQuery> selectQueries

sqlTemplateQueries

protected Collection<SQLTemplate> sqlTemplateQueries

procedureQueries

protected Collection<ProcedureQuery> procedureQueries

ejbqlQueries

protected Collection<EJBQLQuery> ejbqlQueries

queryNames

protected Collection<String> queryNames

Constructor Detail

DataMapArtifact

public DataMapArtifact(DataMap dataMap,
               Collection<Query> queries)

Method Detail

getQualifiedBaseClassName

public String getQualifiedBaseClassName()

Specified by:

getQualifiedBaseClassName in interface Artifact

getQualifiedClassName

public String getQualifiedClassName()

Specified by:

getQualifiedClassName in interface Artifact

getObject

public Object getObject()

Description copied from interface: Artifact

Returns a mapping metadata object for this artifact.

Specified by:

getObject 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

getTemplateTypes

public TemplateType[] getTemplateTypes(ArtifactGenerationMode mode)

Specified by:

getTemplateTypes in interface Artifact

getSelectQueries

public Collection<SelectQuery> getSelectQueries()

hasSelectQueries

public boolean hasSelectQueries()

hasQueryNames

public boolean hasQueryNames()

getQueryNames

public Collection<String> getQueryNames()

getDataMap

public DataMap getDataMap()