org.apache.cayenne.dbsync.naming

Interface ObjectNameGenerator

All Known Implementing Classes:

DefaultObjectNameGenerator

public interface ObjectNameGenerator

A strategy for creating names for object layer metadata artifacts based on their DB counterpart naming or structure. Generated names should normally be further cleaned by passing them through NameBuilder, that will resolve duplication conflicts.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
String	objAttributeName(DbAttribute dbAttribute) Generates a name for ObjAttribute derived from DbAttribute name.
String	objEntityName(DbEntity dbEntity) Generates a name for ObjEntity derived from DbEntity name.
String	relationshipName(DbRelationship... relationshipChain) Generates a String that can be used as a name of an ObjRelationship, derived from join semantics of a chain of connected DbRelationships.

Method Detail

objEntityName

String objEntityName(DbEntity dbEntity)

Generates a name for ObjEntity derived from DbEntity name.

objAttributeName

String objAttributeName(DbAttribute dbAttribute)

Generates a name for ObjAttribute derived from DbAttribute name.

relationshipName

String relationshipName(DbRelationship... relationshipChain)

Generates a String that can be used as a name of an ObjRelationship, derived from join semantics of a chain of connected DbRelationships.

The chain must contain at least one relationship. Though if we are dealing with a flattened relationship, more than one can be passed, in the same order as they are present in a flattened relationship.

Generated name can be used for DbRelationship itself (in which case the chain must have exactly one parameter).