| org.jpox.store.IdentifierFactory
All known Subclasses: org.jpox.store.AbstractIdentifierFactory,
| IdentifierFactory | | public interface IdentifierFactory (Code) | | Factory that creates immutable instances of DatastoreIdentifier.
Identifiers are of a particular type. Each datastore could invent its own particular types
as required, just that the ones here should be the principal types required.
version:
$Revision: 1.16 $ |
| Method Summary | |
| DatastoreAdapter | getDatastoreAdapter()
Accessor for the datastore adapter that we are creating identifiers for. | | int | getIdentifierCase()
Accessor for the identifier case being used. | | String | getIdentifierInAdapterCase(String identifier)
| | String | getNameOfIdentifierCase()
Convenience method to return the name for the identifier case. | | DatastoreIdentifier | newDatastoreContainerIdentifier(String identifierName)
Method to use to generate an identifier for a datastore field with the supplied name. | | DatastoreIdentifier | newDatastoreContainerIdentifier(ClassLoaderResolver clr, AbstractClassMetaData md)
Method to return a Table identifier for the specified class. | | DatastoreIdentifier | newDatastoreContainerIdentifier(ClassLoaderResolver clr, AbstractMemberMetaData fmd)
Method to return a Table identifier for the specified field. | | DatastoreIdentifier | newDatastoreFieldIdentifier(String identifierName)
Method to use to generate an identifier for a datastore field with the supplied name. | | DatastoreIdentifier | newDatastoreFieldIdentifier(String javaName, boolean embedded, int fieldRole)
Method to create an identifier for a datastore field where we want the
name based on the supplied java name, and the field has a particular
role (and so could have its naming set according to the role). | | DatastoreIdentifier | newDiscriminatorFieldIdentifier()
Method to return an identifier for a discriminator datastore field. | | DatastoreIdentifier | newIdentifier(int identifierType, String sqlIdentifier)
To be called when we want an identifier name creating based on the
identifier. | | DatastoreIdentifier | newIdentifier(DatastoreIdentifier identifier, String suffix)
| | DatastoreIdentifier | newReferenceFieldIdentifier(AbstractMemberMetaData refMetaData, AbstractClassMetaData implMetaData, 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. | | DatastoreIdentifier | newVersionFieldIdentifier()
Method to return an identifier for a version datastore field. |
| CANDIDATE_KEY | | final public static int CANDIDATE_KEY(Code) | | candidate key - unique index constraint *
|
| COLUMN | | final public static int COLUMN(Code) | | column *
|
| FOREIGN_KEY | | final public static int FOREIGN_KEY(Code) | | foreign key *
|
| IDENTIFIER_LOWER_CASE | | final public static int IDENTIFIER_LOWER_CASE(Code) | | Representation of an identifier specified in lower case.
|
| IDENTIFIER_LOWER_CASE_QUOTED | | final public static int IDENTIFIER_LOWER_CASE_QUOTED(Code) | | Representation of an identifier specified in "lower case"
|
| IDENTIFIER_MIXED_CASE | | final public static int IDENTIFIER_MIXED_CASE(Code) | | Representation of an identifier specified in Mixed Case.
|
| IDENTIFIER_MIXED_CASE_QUOTED | | final public static int IDENTIFIER_MIXED_CASE_QUOTED(Code) | | Representation of an identifier specified in "Mixed Case".
|
| IDENTIFIER_UPPER_CASE | | final public static int IDENTIFIER_UPPER_CASE(Code) | | Representation of an identifier specified in UPPER CASE
|
| IDENTIFIER_UPPER_CASE_QUOTED | | final public static int IDENTIFIER_UPPER_CASE_QUOTED(Code) | | Representation of an identifier specified in "UPPER CASE"
|
| INDEX | | final public static int INDEX(Code) | | index *
|
| PRIMARY_KEY | | final public static int PRIMARY_KEY(Code) | | primary key *
|
| SEQUENCE | | final public static int SEQUENCE(Code) | | identifier for datastore sequence.
|
| TABLE | | final public static int TABLE(Code) | | identifier for table names *
|
| getDatastoreAdapter | | DatastoreAdapter getDatastoreAdapter()(Code) | | Accessor for the datastore adapter that we are creating identifiers for.
The datastore adapter |
| getIdentifierCase | | int getIdentifierCase()(Code) | | Accessor for the identifier case being used.
The identifier case |
| getIdentifierInAdapterCase | | String getIdentifierInAdapterCase(String identifier)(Code) | | Accessor for an identifier for use in the datastore adapter
Parameters:
identifier - The identifier name Identifier name for use with the datastore adapter |
| getNameOfIdentifierCase | | String getNameOfIdentifierCase()(Code) | | Convenience method to return the name for the identifier case.
Identifier case name |
| newDatastoreContainerIdentifier | | DatastoreIdentifier newDatastoreContainerIdentifier(String identifierName)(Code) | | Method to use to generate an identifier for a datastore field with the supplied name.
The passed name will not be changed (other than in its case) although it may
be truncated to fit the maximum length permitted for a datastore field identifier.
Parameters:
identifierName - The identifier name The DatastoreIdentifier for the table |
| newDatastoreFieldIdentifier | | DatastoreIdentifier newDatastoreFieldIdentifier(String identifierName)(Code) | | Method to use to generate an identifier for a datastore field with the supplied name.
The passed name will not be changed (other than in its case) although it may
be truncated to fit the maximum length permitted for a datastore field identifier.
Parameters:
identifierName - The identifier name The DatastoreIdentifier |
| newDatastoreFieldIdentifier | | DatastoreIdentifier newDatastoreFieldIdentifier(String javaName, boolean embedded, int fieldRole)(Code) | | Method to create an identifier for a datastore field where we want the
name based on the supplied java name, and the field has a particular
role (and so could have its naming set according to the role).
Parameters:
javaName - The java field name
Parameters:
embedded - Whether the identifier is for a field embedded
Parameters:
fieldRole - The role to be performed by this column e.g FK, Index ? The DatastoreIdentifier |
| newDiscriminatorFieldIdentifier | | DatastoreIdentifier newDiscriminatorFieldIdentifier()(Code) | | Method to return an identifier for a discriminator datastore field.
The discriminator datastore field identifier |
| newIdentifier | | DatastoreIdentifier newIdentifier(int identifierType, String sqlIdentifier)(Code) | | To be called when we want an identifier name creating based on the
identifier. Creates identifier for COLUMN, FOREIGN KEY, INDEX and TABLE
Parameters:
identifierType - the type of identifier to be created
Parameters:
sqlIdentifier - The SQL identifier name The DatastoreIdentifier |
| newIdentifier | | DatastoreIdentifier newIdentifier(DatastoreIdentifier identifier, String suffix)(Code) | | Method to return a new Identifier based on the passed identifier, but adding on the passed suffix
Parameters:
identifier - The current identifier
Parameters:
suffix - The suffix The new identifier |
| newReferenceFieldIdentifier | | DatastoreIdentifier newReferenceFieldIdentifier(AbstractMemberMetaData refMetaData, AbstractClassMetaData implMetaData, DatastoreIdentifier implIdentifier, boolean embedded, int fieldRole)(Code) | | 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
Parameters:
implMetaData - the AbstractClassMetaData for this implementation
Parameters:
implIdentifier - PK identifier for the implementation
Parameters:
embedded - Whether the identifier is for a field embedded
Parameters:
fieldRole - The role to be performed by this column e.g FK, collection element ? The DatastoreIdentifier |
| newVersionFieldIdentifier | | DatastoreIdentifier newVersionFieldIdentifier()(Code) | | Method to return an identifier for a version datastore field.
The version datastore field identifier |
|
|