org.jpox.store.rdbms.sqlidentifier
Class JPAIdentifierFactory

java.lang.Object
  org.jpox.store.mapped.AbstractIdentifierFactory
      org.jpox.store.rdbms.sqlidentifier.AbstractRDBMSIdentifierFactory
          org.jpox.store.rdbms.sqlidentifier.JPAIdentifierFactory

All Implemented Interfaces:

org.jpox.store.mapped.IdentifierFactory, RDBMSIdentifierFactory

public class JPAIdentifierFactory
extends AbstractRDBMSIdentifierFactory

Factory that creates immutable instances of DatastoreIdentifier for RDBMS datastores with JPA. Includes the JPA naming strategy, naming as follows

• Class called "MyClass" will generate table name of "MYCLASS"
• Field called "myField" will generate column name of "MYFIELD"
• Join table will be named after the ownerClass and the otherClass so "MyClass" joining to "MyOtherClass" will have a join table called "MYCLASS_MYOTHERCLASS"
• Datastore-identity column for class "MyClass" will be "MYCLASS_ID" (not part of JPA)
• 1-N uni between "MyClass" (field="myField") and "MyElement" will have FK in "MYELEMENT" of MYFIELD_MYCLASS_ID
• 1-N bi between "MyClass" (field="myField") and "MyElement" (field="myClassRef") will have FK in "MYELEMENT" of name "MYCLASSREF_MYCLASS_ID".
• 1-1 uni between "MyClass" (field="myField") and "MyElement" will have FK in "MYCLASS" of name "MYFIELD_MYELEMENT_ID"
• Discriminator field columns will, by default, be called "DTYPE"
• Version field columns will, by default, be called "VERSION"
• Index field columns will, by default, be called "IDX"
• Adapter index field columns will, by default, be called "IDX"

Version:

$Revision: 1.31 $

Field Summary

Fields inherited from class org.jpox.store.rdbms.sqlidentifier.AbstractRDBMSIdentifierFactory

candidates, columns, defaultCatalogName, defaultSchemaName, foreignkeys, indexes, primarykeys, rdba, references, sequences, tables, wordSeparator

Fields inherited from class org.jpox.store.mapped.AbstractIdentifierFactory

CASE_LOWER, CASE_PRESERVE, CASE_UPPER, dba, identifierCase, LOCALISER

Fields inherited from interface org.jpox.store.mapped.IdentifierFactory

CANDIDATE_KEY, COLUMN, FOREIGN_KEY, IDENTIFIER_LOWER_CASE, IDENTIFIER_LOWER_CASE_QUOTED, IDENTIFIER_MIXED_CASE, IDENTIFIER_MIXED_CASE_QUOTED, IDENTIFIER_UPPER_CASE, IDENTIFIER_UPPER_CASE_QUOTED, INDEX, PRIMARY_KEY, SEQUENCE, TABLE

Constructor Summary

JPAIdentifierFactory(org.jpox.store.mapped.DatastoreAdapter dba, java.lang.String defaultCatalog, java.lang.String defaultSchema, java.lang.String requiredCase, java.lang.String wordSeparator, java.lang.String tablePrefix, java.lang.String tableSuffix)
Constructor.

Method Summary

java.lang.String	generateIdentifierNameForJavaName(java.lang.String javaName) Generate a datastore identifier from a Java identifier.
protected java.lang.String	getColumnIdentifierSuffix(int role, boolean embedded) Accessor for the suffix to add to any column identifier, based on the role type.
org.jpox.store.mapped.DatastoreIdentifier	newAdapterIndexFieldIdentifier() Method to return an identifier for an adapter index datastore field.
org.jpox.store.mapped.DatastoreIdentifier	newDatastoreContainerIdentifier(org.jpox.ClassLoaderResolver clr, org.jpox.metadata.AbstractClassMetaData cmd) Method to return a Table identifier for the specified class.
org.jpox.store.mapped.DatastoreIdentifier	newDatastoreContainerIdentifier(org.jpox.ClassLoaderResolver clr, org.jpox.metadata.AbstractMemberMetaData fmd) Method to return a Table identifier for the join table of the specified field.
org.jpox.store.mapped.DatastoreIdentifier	newDiscriminatorFieldIdentifier() Method to return an identifier for a discriminator column.
org.jpox.store.mapped.DatastoreIdentifier	newForeignKeyFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData ownerFmd, org.jpox.metadata.AbstractMemberMetaData relatedFmd, org.jpox.store.mapped.DatastoreIdentifier destinationId, boolean embedded, int fieldRole) Method to generate a FK/FK-index field identifier.
org.jpox.store.mapped.DatastoreIdentifier	newIndexFieldIdentifier() Method to return an identifier for an index datastore field.
org.jpox.store.mapped.DatastoreIdentifier	newJoinTableFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData ownerFmd, org.jpox.metadata.AbstractMemberMetaData relatedFmd, org.jpox.store.mapped.DatastoreIdentifier destinationId, boolean embedded, int fieldRole) Method to generate a join-table identifier.
org.jpox.store.mapped.DatastoreIdentifier	newReferenceFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData refMetaData, org.jpox.metadata.AbstractClassMetaData implMetaData, org.jpox.store.mapped.DatastoreIdentifier implIdentifier, boolean embedded, int fieldRole) Method to generate an identifier name for reference field, based on the metadata for the field, and the ClassMetaData for the implementation.
org.jpox.store.mapped.DatastoreIdentifier	newVersionFieldIdentifier() Method to return an identifier for a version datastore field.

Methods inherited from class org.jpox.store.rdbms.sqlidentifier.AbstractRDBMSIdentifierFactory

getIdentifierInAdapterCase, getIdentifierNamePartsFromName, getMaxLengthForIdentifierType, getWordSeparator, newCandidateKeyIdentifier, newDatastoreContainerIdentifier, newDatastoreFieldIdentifier, newDatastoreFieldIdentifier, newForeignKeyIdentifier, newIdentifier, newIdentifier, newIndexIdentifier, newPrimaryKeyIdentifier, newSequenceIdentifier, setCatalogSchemaForTable

Methods inherited from class org.jpox.store.mapped.AbstractIdentifierFactory

getDatastoreAdapter, getIdentifierCase, getNameOfIdentifierCase, truncate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpox.store.mapped.IdentifierFactory

getDatastoreAdapter, getIdentifierCase, getNameOfIdentifierCase

Constructor Detail

JPAIdentifierFactory

public JPAIdentifierFactory(org.jpox.store.mapped.DatastoreAdapter dba,
                            java.lang.String defaultCatalog,
                            java.lang.String defaultSchema,
                            java.lang.String requiredCase,
                            java.lang.String wordSeparator,
                            java.lang.String tablePrefix,
                            java.lang.String tableSuffix)

Constructor. TODO Allow specification of multiple properties in PMF to control the id generation and just pass in a Properties into here

Parameters:

dba - Datastore adapter

defaultCatalog - Name of the default catalog (if any)

defaultSchema - Name of the default schema (if any)

requiredCase - The case the user requires

wordSeparator - Word separator for identifiers

tablePrefix - Prefix for table names when being generated

tableSuffix - Suffix for table names when being generated

Method Detail

newDatastoreContainerIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newDatastoreContainerIdentifier(org.jpox.ClassLoaderResolver clr,
                                                                                 org.jpox.metadata.AbstractMemberMetaData fmd)

Method to return a Table identifier for the join table of the specified field.

Parameters:

clr - the ClassLoaderResolver

fmd - Meta data for the field

Returns:

The identifier for the table

newDatastoreContainerIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newDatastoreContainerIdentifier(org.jpox.ClassLoaderResolver clr,
                                                                                 org.jpox.metadata.AbstractClassMetaData cmd)

Method to return a Table identifier for the specified class.

Parameters:

clr - the ClassLoaderResolver

cmd - Meta data for the class

Returns:

The identifier for the table

newReferenceFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newReferenceFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData refMetaData,
                                                                             org.jpox.metadata.AbstractClassMetaData implMetaData,
                                                                             org.jpox.store.mapped.DatastoreIdentifier implIdentifier,
                                                                             boolean embedded,
                                                                             int fieldRole)

Method to generate an identifier name for reference field, based on the metadata for the field, and the ClassMetaData for the implementation.

Parameters:

refMetaData - the metadata for the reference field

implMetaData - the AbstractClassMetaData for this implementation

implIdentifier - PK identifier for the implementation

embedded - Whether the identifier is for a field embedded

fieldRole - The role to be performed by this column e.g FK, collection element ?

Returns:

The DatastoreIdentifier

newJoinTableFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newJoinTableFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData ownerFmd,
                                                                             org.jpox.metadata.AbstractMemberMetaData relatedFmd,
                                                                             org.jpox.store.mapped.DatastoreIdentifier destinationId,
                                                                             boolean embedded,
                                                                             int fieldRole)

Method to generate a join-table identifier. The identifier could be for a foreign-key to another table (if the destinationId is provided), or could be for a simple column in the join table.

Parameters:

ownerFmd - MetaData for the owner field

relatedFmd - MetaData for the related field

destinationId - Identifier for the identity field of the destination (if FK)

embedded - Whether the identifier is for a field embedded

fieldRole - The role to be performed by this column e.g FK, collection element ?

Returns:

The identifier.

newForeignKeyFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newForeignKeyFieldIdentifier(org.jpox.metadata.AbstractMemberMetaData ownerFmd,
                                                                              org.jpox.metadata.AbstractMemberMetaData relatedFmd,
                                                                              org.jpox.store.mapped.DatastoreIdentifier destinationId,
                                                                              boolean embedded,
                                                                              int fieldRole)

Method to generate a FK/FK-index field identifier. The identifier could be for the FK field itself, or for a related index for the FK.

Parameters:

ownerFmd - MetaData for the owner field

relatedFmd - MetaData for the related field

destinationId - Identifier for the identity field of the destination table (if strict FK)

embedded - Whether the identifier is for a field embedded

fieldRole - The role to be performed by this column e.g ROLE_OWNER, ROLE_INDEX

Returns:

The identifier

newDiscriminatorFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newDiscriminatorFieldIdentifier()

Method to return an identifier for a discriminator column. Returns an identifier "DTYPE"

Returns:

The discriminator column identifier

newVersionFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newVersionFieldIdentifier()

Method to return an identifier for a version datastore field.

Returns:

The version datastore field identifier

newIndexFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newIndexFieldIdentifier()

Method to return an identifier for an index datastore field.

Returns:

The index datastore field identifier

newAdapterIndexFieldIdentifier

public org.jpox.store.mapped.DatastoreIdentifier newAdapterIndexFieldIdentifier()

Method to return an identifier for an adapter index datastore field. An "adapter index" is a column added to be part of a primary key when some other column cant perform that role.

Returns:

The index datastore field identifier

generateIdentifierNameForJavaName

public java.lang.String generateIdentifierNameForJavaName(java.lang.String javaName)

Generate a datastore identifier from a Java identifier.

Conversion consists of breaking the identifier into words, converting each word to upper-case, and separating each one with an underscore "_". Words are identified by a leading upper-case character. Any leading or trailing underscores are removed.

Specified by:

generateIdentifierNameForJavaName in class AbstractRDBMSIdentifierFactory

Parameters:

javaName - the Java identifier.

Returns:

The datastore identifier

getColumnIdentifierSuffix

protected java.lang.String getColumnIdentifierSuffix(int role,
                                                     boolean embedded)

Accessor for the suffix to add to any column identifier, based on the role type.

Specified by:

getColumnIdentifierSuffix in class AbstractRDBMSIdentifierFactory

Parameters:

role - Datastore field role

embedded - Whether the DatastoreField is stored embedded

Returns:

The suffix (e.g _ID for id columns).