A B C D E F G H I L M O P Q R S T U V

A

addEmbeddables(Collection<Embeddable>) - Method in class org.apache.cayenne.gen.ClassGenerationAction

addEntities(Collection<ObjEntity>) - Method in class org.apache.cayenne.gen.ClassGenerationAction

addEntities(Collection<ObjEntity>) - Method in class org.apache.cayenne.gen.ClientClassGenerationAction

addQueries(Collection<QueryDescriptor>) - Method in class org.apache.cayenne.gen.ClassGenerationAction

addQueries(Collection<QueryDescriptor>) - Method in class org.apache.cayenne.gen.ClientClassGenerationAction

addReservedType(String) - Method in class org.apache.cayenne.gen.ImportUtils

Reserve a fully-qualified data type class name so it cannot be used by another class.

addType(String) - Method in class org.apache.cayenne.gen.ImportUtils

Register a fully-qualified data type class name.

Artifact - Interface in org.apache.cayenne.gen

Represents a class generation "artifact" which is a facade to a metadata object used for a given single generation template run.

ArtifactGenerationMode - Enum in org.apache.cayenne.gen

Code generator execution mode for a single artifact.

artifacts - Variable in class org.apache.cayenne.gen.ClassGenerationAction

ArtifactsGenerationMode - Enum in org.apache.cayenne.gen

Code generator execution mode for a collection of artifacts.

artifactsGenerationMode - Variable in class org.apache.cayenne.gen.ClassGenerationAction

B

BASE_CLASS_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

BASE_PACKAGE_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

baseClassName - Variable in class org.apache.cayenne.gen.EntityUtils

basePackageName - Variable in class org.apache.cayenne.gen.EntityUtils

C

callbackNames - Variable in class org.apache.cayenne.gen.EntityUtils

canRegisterType(String) - Method in class org.apache.cayenne.gen.ImportUtils

capitalized(String) - Method in class org.apache.cayenne.gen.StringUtils

Capitalizes the first letter of the property name.

capitalizedAsConstant(String) - Method in class org.apache.cayenne.gen.StringUtils

Converts property name to Java constants naming convention.

ClassGenerationAction - Class in org.apache.cayenne.gen

ClassGenerationAction() - Constructor for class org.apache.cayenne.gen.ClassGenerationAction

ClassGeneratorResourceLoader - Class in org.apache.cayenne.gen

Velocity template resource loader customized for Cayenne use.

ClassGeneratorResourceLoader() - Constructor for class org.apache.cayenne.gen.ClassGeneratorResourceLoader

CLIENT_SUPERCLASS_PREFIX - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

ClientClassGenerationAction - Class in org.apache.cayenne.gen

ClientClassGenerationAction() - Constructor for class org.apache.cayenne.gen.ClientClassGenerationAction

ClientDataMapArtifact - Class in org.apache.cayenne.gen

ClientDataMapArtifact(DataMap, Collection<QueryDescriptor>) - Constructor for class org.apache.cayenne.gen.ClientDataMapArtifact

ClientEntityArtifact - Class in org.apache.cayenne.gen

Client code generation artifact based on ObjEntity.

ClientEntityArtifact(ObjEntity) - Constructor for class org.apache.cayenne.gen.ClientEntityArtifact

context - Variable in class org.apache.cayenne.gen.ClassGenerationAction

CREATE_PROPERTY_NAMES - Static variable in interface org.apache.cayenne.gen.Artifact

createPropertyNames - Variable in class org.apache.cayenne.gen.ClassGenerationAction

customTemplateName(TemplateType) - Method in class org.apache.cayenne.gen.ClassGenerationAction

D

dataMap - Variable in class org.apache.cayenne.gen.ClassGenerationAction

dataMap - Variable in class org.apache.cayenne.gen.DataMapArtifact

DATAMAP_SINGLE_CLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

DATAMAP_SUBCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

DATAMAP_SUPERCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

DATAMAP_UTILS_KEY - Static variable in class org.apache.cayenne.gen.DataMapArtifact

DataMapArtifact - Class in org.apache.cayenne.gen

Artifact facade for a DataMap.

DataMapArtifact(DataMap, Collection<QueryDescriptor>) - Constructor for class org.apache.cayenne.gen.DataMapArtifact

DataMapUtils - Class in org.apache.cayenne.gen

Attributes and Methods for working with Queries.

DataMapUtils() - Constructor for class org.apache.cayenne.gen.DataMapUtils

defaultTemplateName(TemplateType) - Method in class org.apache.cayenne.gen.ClassGenerationAction

defaultTemplateName(TemplateType) - Method in class org.apache.cayenne.gen.ClientClassGenerationAction

destDir - Variable in class org.apache.cayenne.gen.ClassGenerationAction

DMAP_SINGLE_CLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

DMAP_SUBCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

DMAP_SUPERCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

E

embeddable - Variable in class org.apache.cayenne.gen.EmbeddableArtifact

EMBEDDABLE_SINGLE_CLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

EMBEDDABLE_SUBCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

EMBEDDABLE_SUPERCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

EmbeddableArtifact - Class in org.apache.cayenne.gen

Artifact facade for an Embeddable.

EmbeddableArtifact(Embeddable) - Constructor for class org.apache.cayenne.gen.EmbeddableArtifact

embeddableSuperTemplate - Variable in class org.apache.cayenne.gen.ClassGenerationAction

embeddableTemplate - Variable in class org.apache.cayenne.gen.ClassGenerationAction

encoding - Variable in class org.apache.cayenne.gen.ClassGenerationAction

entity - Variable in class org.apache.cayenne.gen.EntityArtifact

ENTITY_UTILS_KEY - Static variable in class org.apache.cayenne.gen.EntityArtifact

EntityArtifact - Class in org.apache.cayenne.gen

Artifact facade for an ObjEntity.

EntityArtifact(ObjEntity) - Constructor for class org.apache.cayenne.gen.EntityArtifact

EntityUtils - Class in org.apache.cayenne.gen

Attributes and Methods for working with ObjEntities.

EntityUtils(DataMap, ObjEntity, String, String, String) - Constructor for class org.apache.cayenne.gen.EntityUtils

execQueries - Variable in class org.apache.cayenne.gen.DataMapArtifact

execute() - Method in class org.apache.cayenne.gen.ClassGenerationAction

Executes class generation once per each artifact.

execute(Artifact) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Executes class generation for a single artifact.

F

fileForClass() - Method in class org.apache.cayenne.gen.ClassGenerationAction

Returns a target file where a generated class must be saved.

fileForSuperclass() - Method in class org.apache.cayenne.gen.ClassGenerationAction

Returns a target file where a generated superclass must be saved.

formatJavaType(String, boolean) - Method in class org.apache.cayenne.gen.ImportUtils

Performs processing similar to formatJavaType(String), with special handling of primitive types and their Java class counterparts.

formatJavaType(String) - Method in class org.apache.cayenne.gen.ImportUtils

Removes registered package and non-reserved registered type name prefixes from java types

formatJavaTypeAsNonBooleanPrimitive(String) - Method in class org.apache.cayenne.gen.ImportUtils

formatVariableName(String) - Method in class org.apache.cayenne.gen.StringUtils

Prepends underscore to variable name if necessary to remove conflict with reserved keywords.

G

generate() - Method in class org.apache.cayenne.gen.ImportUtils

Generate package and list of import statements based on the registered types.

getCallbackNames() - Method in class org.apache.cayenne.gen.EntityUtils

getDataMap() - Method in class org.apache.cayenne.gen.DataMapArtifact

getEntityResolver() - Method in class org.apache.cayenne.gen.EntityUtils

Returns the EntityResolver for this set of DataMaps.

getExecQueries() - Method in class org.apache.cayenne.gen.DataMapArtifact

getInstance() - Static method in class org.apache.cayenne.gen.StringUtils

getLabel() - Method in enum org.apache.cayenne.gen.ArtifactsGenerationMode

getMapKeyType(ObjRelationship) - Method in class org.apache.cayenne.gen.EntityUtils

Returns the map key type for a collection relationship of type java.util.Map.

getObject() - Method in interface org.apache.cayenne.gen.Artifact

Returns a mapping metadata object for this artifact.

getObject() - Method in class org.apache.cayenne.gen.DataMapArtifact

getObject() - Method in class org.apache.cayenne.gen.EmbeddableArtifact

getObject() - Method in class org.apache.cayenne.gen.EntityArtifact

Returns ObjEntity.

getParameterNames(SelectQueryDescriptor) - Method in class org.apache.cayenne.gen.DataMapUtils

Get all parameter names that used in query qualifier.

getParameterType(SelectQueryDescriptor, String) - Method in class org.apache.cayenne.gen.DataMapUtils

Get type of parameter for given name.

getPrimaryDataMap() - Method in class org.apache.cayenne.gen.EntityUtils

getQualifiedBaseClassName() - Method in interface org.apache.cayenne.gen.Artifact

getQualifiedBaseClassName() - Method in class org.apache.cayenne.gen.ClientDataMapArtifact

getQualifiedBaseClassName() - Method in class org.apache.cayenne.gen.ClientEntityArtifact

getQualifiedBaseClassName() - Method in class org.apache.cayenne.gen.DataMapArtifact

getQualifiedBaseClassName() - Method in class org.apache.cayenne.gen.EmbeddableArtifact

getQualifiedBaseClassName() - Method in class org.apache.cayenne.gen.EntityArtifact

getQualifiedClassName() - Method in interface org.apache.cayenne.gen.Artifact

getQualifiedClassName() - Method in class org.apache.cayenne.gen.ClientDataMapArtifact

getQualifiedClassName() - Method in class org.apache.cayenne.gen.ClientEntityArtifact

getQualifiedClassName() - Method in class org.apache.cayenne.gen.DataMapArtifact

getQualifiedClassName() - Method in class org.apache.cayenne.gen.EmbeddableArtifact

getQualifiedClassName() - Method in class org.apache.cayenne.gen.EntityArtifact

getQueryMethodName(QueryDescriptor) - Method in class org.apache.cayenne.gen.DataMapUtils

Return valid method name based on query name (replace all illegal characters with underscore '_').

getQueryNames() - Method in class org.apache.cayenne.gen.DataMapArtifact

getResourceStream(String) - Method in class org.apache.cayenne.gen.ClassGeneratorResourceLoader

Returns resource as InputStream.

getSelectQueries() - Method in class org.apache.cayenne.gen.DataMapArtifact

getSingleClassType() - Method in class org.apache.cayenne.gen.EntityArtifact

getSubclassType() - Method in class org.apache.cayenne.gen.EntityArtifact

getSuperclassPrefix() - Method in class org.apache.cayenne.gen.ClassGenerationAction

Returns a String used to prefix class name to create a generated superclass.

getSuperClassType() - Method in class org.apache.cayenne.gen.EntityArtifact

getTemplate(TemplateType) - Method in class org.apache.cayenne.gen.ClassGenerationAction

getTemplateTypes(ArtifactGenerationMode) - Method in interface org.apache.cayenne.gen.Artifact

getTemplateTypes(ArtifactGenerationMode) - Method in class org.apache.cayenne.gen.DataMapArtifact

getTemplateTypes(ArtifactGenerationMode) - Method in class org.apache.cayenne.gen.EmbeddableArtifact

getTemplateTypes(ArtifactGenerationMode) - Method in class org.apache.cayenne.gen.EntityArtifact

H

hasExecQueries() - Method in class org.apache.cayenne.gen.DataMapArtifact

hasParameters(SelectQueryDescriptor) - Method in class org.apache.cayenne.gen.DataMapUtils

hasQueryNames() - Method in class org.apache.cayenne.gen.DataMapArtifact

hasSelectQueries() - Method in class org.apache.cayenne.gen.DataMapArtifact

hasToManyDeclaredRelationships() - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity contains at least one toMany relationship, ignoring those declared in superentities.

hasToManyDeclaredRelationships(ObjEntity) - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if an ObjEntity contains at least one toMany relationship, ignoring those declared in superentities.

hasToManyRelationships() - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity contains at least one toMany relationship.

hasToManyRelationships(ObjEntity) - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if an ObjEntity contains at least one toMany relationship.

hasToOneDeclaredRelationships() - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity contains at least one toOne relationship, ignoring those declared in superentities.

hasToOneDeclaredRelationships(ObjEntity) - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if an ObjEntity contains at least one toOne relationship, ignoring those declared in superentities.

hasToOneRelationships() - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity contains at least one toOne relationship.

hasToOneRelationships(ObjEntity) - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if an ObjEntity contains at least one toOne relationship.

I

IMPORT_UTILS_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

importOrdering - Static variable in class org.apache.cayenne.gen.ImportUtils

importTypesMap - Variable in class org.apache.cayenne.gen.ImportUtils

ImportUtils - Class in org.apache.cayenne.gen

Methods for mangling strings.

ImportUtils() - Constructor for class org.apache.cayenne.gen.ImportUtils

isAbstract() - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity is defined as abstract.

isAbstract(ObjEntity) - Method in class org.apache.cayenne.gen.EntityUtils

Returns true if current ObjEntity is defined as abstract.

isBoolean(String) - Method in class org.apache.cayenne.gen.ImportUtils

isNonBooleanPrimitive(String) - Method in class org.apache.cayenne.gen.ImportUtils

isOld(File) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Returns true if file parameter is older than internal timestamp of this class generator.

isSuperclass() - Method in enum org.apache.cayenne.gen.TemplateType

isValidParameterNames(SelectQueryDescriptor) - Method in class org.apache.cayenne.gen.DataMapUtils

L

loadFromAbsPath(String) - Method in class org.apache.cayenne.gen.ClassGeneratorResourceLoader

loadFromRelativePath(String) - Method in class org.apache.cayenne.gen.ClassGeneratorResourceLoader

loadFromThisClassLoader(String) - Method in class org.apache.cayenne.gen.ClassGeneratorResourceLoader

loadFromThreadClassLoader(String) - Method in class org.apache.cayenne.gen.ClassGeneratorResourceLoader

logger - Variable in class org.apache.cayenne.gen.ClassGenerationAction

M

makePairs - Variable in class org.apache.cayenne.gen.ClassGenerationAction

mkpath(File, String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Returns a File object corresponding to a directory where files that belong to pkgName package should reside.

O

OBJECT_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

Root object, such as ObjEntity or Embeddable, etc.

objEntity - Variable in class org.apache.cayenne.gen.EntityUtils

openWriter(TemplateType) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Opens a Writer to write generated output.

org.apache.cayenne.gen - package org.apache.cayenne.gen

Contains classes that provide Java source generation facility.

org.apache.cayenne.tools - package org.apache.cayenne.tools

outputPattern - Variable in class org.apache.cayenne.gen.ClassGenerationAction

overwrite - Variable in class org.apache.cayenne.gen.ClassGenerationAction

P

packageName - Variable in class org.apache.cayenne.gen.ImportUtils

pluralize(String) - Method in class org.apache.cayenne.gen.StringUtils

Converts entity or property name to a plural form.

postInitContext(VelocityContext) - Method in interface org.apache.cayenne.gen.Artifact

A callback method that allows each artifact to add its own special keys to the context.

postInitContext(VelocityContext) - Method in class org.apache.cayenne.gen.DataMapArtifact

postInitContext(VelocityContext) - Method in class org.apache.cayenne.gen.EmbeddableArtifact

postInitContext(VelocityContext) - Method in class org.apache.cayenne.gen.EntityArtifact

primaryDataMap - Variable in class org.apache.cayenne.gen.EntityUtils

Q

queryNames - Variable in class org.apache.cayenne.gen.DataMapArtifact

querySuperTemplate - Variable in class org.apache.cayenne.gen.ClassGenerationAction

queryTemplate - Variable in class org.apache.cayenne.gen.ClassGenerationAction

R

replaceWildcardInStringWithString(String, String, String) - Method in class org.apache.cayenne.gen.StringUtils

reservedImportTypesMap - Variable in class org.apache.cayenne.gen.ImportUtils

resetContextForArtifact(Artifact) - Method in class org.apache.cayenne.gen.ClassGenerationAction

VelocityContext initialization method called once per artifact.

resetContextForArtifactTemplate(Artifact, TemplateType) - Method in class org.apache.cayenne.gen.ClassGenerationAction

VelocityContext initialization method called once per each artifact and template type combination.

S

selectQueries - Variable in class org.apache.cayenne.gen.DataMapArtifact

setArtifactsGenerationMode(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setContext(VelocityContext) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets an optional shared VelocityContext.

setCreatePropertyNames(boolean) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets createPropertyNames property.

setDataMap(DataMap) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setDestDir(File) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets the destDir.

setEmbeddableSuperTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setEmbeddableTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setEncoding(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets file encoding.

setLogger(Logger) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Injects an optional logger that will be used to trace generated files at the info level.

setMakePairs(boolean) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets makepairs property.

setOutputPattern(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets outputPattern property.

setOverwrite(boolean) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets overwrite property.

setPackage(String) - Method in class org.apache.cayenne.gen.ImportUtils

Add the package name to use for this importUtil invocation.

setQuerySuperTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setQueryTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setSuperPkg(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets "superPkg" property value.

setSuperTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets superTemplate property.

setTemplate(String) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets template property.

setTimestamp(long) - Method in class org.apache.cayenne.gen.ClassGenerationAction

setUsePkgPath(boolean) - Method in class org.apache.cayenne.gen.ClassGenerationAction

Sets usepkgpath property.

SINGLE_CLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

STRING_UTILS_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

StringUtils - Class in org.apache.cayenne.gen

Methods for mangling strings.

StringUtils() - Constructor for class org.apache.cayenne.gen.StringUtils

stripClass(String) - Method in class org.apache.cayenne.gen.StringUtils

Removes base name, leaving package name.

stripGeneric(String) - Method in class org.apache.cayenne.gen.StringUtils

Strip generic definition from string

stripPackageName(String) - Method in class org.apache.cayenne.gen.StringUtils

Removes package name, leaving base name.

SUB_CLASS_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

SUB_PACKAGE_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

SUBCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

SUBCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

subClassName - Variable in class org.apache.cayenne.gen.EntityUtils

subPackageName - Variable in class org.apache.cayenne.gen.EntityUtils

SUPER_CLASS_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

SUPER_PACKAGE_KEY - Static variable in interface org.apache.cayenne.gen.Artifact

SUPERCLASS_PREFIX - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

SUPERCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClassGenerationAction

SUPERCLASS_TEMPLATE - Static variable in class org.apache.cayenne.gen.ClientClassGenerationAction

superClassName - Variable in class org.apache.cayenne.gen.EntityUtils

superPackageName - Variable in class org.apache.cayenne.gen.EntityUtils

superPkg - Variable in class org.apache.cayenne.gen.ClassGenerationAction

superTemplate - Variable in class org.apache.cayenne.gen.ClassGenerationAction

T

template - Variable in class org.apache.cayenne.gen.ClassGenerationAction

templateCache - Variable in class org.apache.cayenne.gen.ClassGenerationAction

TemplateType - Enum in org.apache.cayenne.gen

Defines class generation template types.

timestamp - Variable in class org.apache.cayenne.gen.ClassGenerationAction

U

uncapitalized(String) - Static method in class org.apache.cayenne.gen.StringUtils

Returns string with lowercased first letter

usePkgPath - Variable in class org.apache.cayenne.gen.ClassGenerationAction

V

validateAttributes() - Method in class org.apache.cayenne.gen.ClassGenerationAction

Validates the state of this class generator.

valueOf(String) - Static method in enum org.apache.cayenne.gen.ArtifactGenerationMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.cayenne.gen.ArtifactsGenerationMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.cayenne.gen.TemplateType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.cayenne.gen.ArtifactGenerationMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.cayenne.gen.ArtifactsGenerationMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.cayenne.gen.TemplateType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M O P Q R S T U V