Uses of Class
org.apache.openjpa.jdbc.schema.ForeignKey

Packages that use ForeignKey

Package	Description
org.apache.openjpa.jdbc.meta	OpenJPA-JDBC ORM Metadata This package extends the standard persistence metadata with object-relational mapping information.
org.apache.openjpa.jdbc.meta.strats	OpenJPA-JDBC ORM Strategies Library of mapping strategies.
org.apache.openjpa.jdbc.schema	OpenJPA-JDBC Schema Management This package provides utilities for managing the schema of persistent objects stored in a relational database.
org.apache.openjpa.jdbc.sql	OpenJPA-JDBC SQL Abstraction Utilities for generating SQL.

Uses of ForeignKey in org.apache.openjpa.jdbc.meta

Methods in org.apache.openjpa.jdbc.meta that return ForeignKey

Modifier and Type	Method and Description
protected ForeignKey	MappingInfo.createForeignKey(MetaDataContext context, String prefix, List<Column> given, MappingInfo.ForeignKeyDefaults def, Table table, ClassMapping cls, ClassMapping rel, boolean inversable, boolean adapt) Retrieve/create a foreign key (possibly logical) on the given columns by merging the given template information with any user-provided information.
ForeignKey	MappingInfo.ForeignKeyDefaults.get(Table local, Table foreign, boolean inverse) Return a default foreign key for the given tables, or null to create a logical foreign key only.
ForeignKey	FieldMapping.getBi1ToMElemFK()
ForeignKey	FieldMapping.getBi1ToMJoinFK()
ForeignKey	ValueMapping.getForeignKey() If this value joins to another record, the foreign key.
ForeignKey	MappingInfo.getForeignKey() Raw foreign key information.
ForeignKey	ValueMappingImpl.getForeignKey()
ForeignKey	FieldMapping.getForeignKey()
ForeignKey	ValueMapping.getForeignKey(ClassMapping target) Return an equivalent of this value's foreign key, but joining to the given target, which may be an unjoined subclass of this value's related type.
ForeignKey	ValueMappingImpl.getForeignKey(ClassMapping target)
ForeignKey	FieldMapping.getForeignKey(ClassMapping target)
ForeignKey	ValueMappingImpl.getForeignKey(ClassMapping target, int targetNumber)
ForeignKey	NoneMappingDefaults.getForeignKey(ValueMapping vm, DBIdentifier name, Table local, Table foreign, boolean inverse)
ForeignKey	MappingDefaultsImpl.getForeignKey(ValueMapping vm, DBIdentifier name, Table local, Table foreign, boolean inverse)
ForeignKey	MappingDefaults.getForeignKey(ValueMapping vm, DBIdentifier name, Table local, Table foreign, boolean inverse) Return a default foreign key for the join from this value to its related type, or null for a logical foreign key only.
ForeignKey	NoneMappingDefaults.getForeignKey(ValueMapping vm, String name, Table local, Table foreign, boolean inverse) Deprecated.
ForeignKey	MappingDefaultsImpl.getForeignKey(ValueMapping vm, String name, Table local, Table foreign, boolean inverse) Deprecated.
ForeignKey	MappingDefaults.getForeignKey(ValueMapping vm, String name, Table local, Table foreign, boolean inverse) Deprecated.
ForeignKey	ValueMappingInfo.getInverseTypeJoin(ValueMapping val, DBIdentifier name, boolean adapt)
ForeignKey	ValueMappingInfo.getInverseTypeJoin(ValueMapping val, String name, boolean adapt) Deprecated.
ForeignKey	FieldMappingInfo.getJoin(FieldMapping field, Table table, boolean adapt) Return the join from the field table to the owning class table.
ForeignKey	FieldMappingInfo.getJoin(FieldMapping field, Table table, boolean adapt, List<Column> cols)
ForeignKey	ClassMapping.getJoinForeignKey() Foreign key linking the primary key columns to the superclass table, or null if none.
ForeignKey	FieldMapping.getJoinForeignKey() Foreign key linking the field table to the class' primary table.
ForeignKey	NoneMappingDefaults.getJoinForeignKey(ClassMapping cls, Table local, Table foreign)
ForeignKey	MappingDefaultsImpl.getJoinForeignKey(ClassMapping cls, Table local, Table foreign)
ForeignKey	MappingDefaults.getJoinForeignKey(ClassMapping cls, Table local, Table foreign) Return a default foreign key for the join from this class' table to its superclass' table, or null for a logical foreign key only.
ForeignKey	FieldMappingInfo.getJoinForeignKey(FieldMapping field, Table table, boolean adapt)
ForeignKey	NoneMappingDefaults.getJoinForeignKey(FieldMapping fm, Table local, Table foreign)
ForeignKey	MappingDefaultsImpl.getJoinForeignKey(FieldMapping fm, Table local, Table foreign)
ForeignKey	MappingDefaults.getJoinForeignKey(FieldMapping fm, Table local, Table foreign) Return a default foreign key for the join from this field's table to its defining class' table, or null for a logical foreign key only.
ForeignKey	ClassMappingInfo.getSuperclassJoin(ClassMapping cls, Table table, boolean adapt) Return the join from this class to its superclass.
ForeignKey	ValueMappingInfo.getTypeJoin(ValueMapping val, DBIdentifier name, boolean inversable, boolean adapt)
ForeignKey	ValueMappingInfo.getTypeJoin(ValueMapping val, String name, boolean inversable, boolean adapt) Deprecated.
ForeignKey	ReverseMappingTool.getUniqueForeignKey(Table table) If the given table has a single unique foreign key or a foreign key that matches the primary key, return it.

Methods in org.apache.openjpa.jdbc.meta with parameters of type ForeignKey

Modifier and Type	Method and Description
String	ReverseCustomizer.getFieldName(ClassMapping dec, Column[] cols, ForeignKey fk, String defaultName) Return the field name used to map the given columns, or null to prevent the columns from being mapped.
String	PropertiesReverseCustomizer.getFieldName(ClassMapping dec, Column[] cols, ForeignKey fk, String defaultName)
Object	ClassMapping.getObjectId(JDBCStore store, Result res, ForeignKey fk, boolean subs, Joins joins) Return the oid value stored in the result.
Object	Joinable.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins) Return the value for this joinable from the given result, using the given columns.
Object	DelegatingJoinable.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins)
Boolean	ClassMapping.isForeignKeyObjectId(ForeignKey fk) Return whether the columns of the given foreign key to this mapping can be used to construct an object id for this type.
boolean	ReverseMappingTool.isUnique(ForeignKey fk) Return whether the given foreign key is unique.
FieldMapping	ReverseMappingTool.newFieldMapping(String name, Class type, Column col, ForeignKey fk, ClassMapping dec) Create a field mapping for the given info, or return null if customizer rejects.
void	ValueMapping.setForeignKey(ForeignKey fk) If this value joins to another record, the foreign key.
void	MappingInfo.setForeignKey(ForeignKey fk) Raw foreign key information.
void	ValueMappingImpl.setForeignKey(ForeignKey fk)
void	FieldMapping.setForeignKey(ForeignKey fk)
void	ClassMapping.setJoinForeignKey(ForeignKey fk) Foreign key linking the primary key columns to the superclass table, or null if none.
void	FieldMapping.setJoinForeignKey(ForeignKey fk) Foreign key linking the field table to the class' primary table.
protected void	MappingInfo.syncForeignKey(MetaDataContext context, ForeignKey fk, Table local, Table target) Sets internal constraint and column information to match given mapped constraint.

Constructors in org.apache.openjpa.jdbc.meta with parameters of type ForeignKey

Constructor and Description
DelegatingJoinable(Joinable join, ForeignKey fk) Constructor.

Uses of ForeignKey in org.apache.openjpa.jdbc.meta.strats

Methods in org.apache.openjpa.jdbc.meta.strats that return ForeignKey

Modifier and Type	Method and Description
abstract ForeignKey	ContainerFieldStrategy.getJoinForeignKey()
ForeignKey	MapTableFieldStrategy.getJoinForeignKey()
ForeignKey	StoreCollectionFieldStrategy.getJoinForeignKey()
ForeignKey	RelationMapInverseKeyFieldStrategy.getJoinForeignKey(ClassMapping cls)
ForeignKey	HandlerCollectionTableFieldStrategy.getJoinForeignKey(ClassMapping elem)
protected ForeignKey	RelationToManyInverseKeyFieldStrategy.getJoinForeignKey(ClassMapping elem)
ForeignKey	LRSMapFieldStrategy.getJoinForeignKey(ClassMapping cls) Return the foreign key used to join to the owning field for the given mapping from either LRSMapFieldStrategy.getIndependentKeyMappings(boolean) or LRSMapFieldStrategy.getIndependentValueMappings(boolean) (or null).
ForeignKey	RelationCollectionInverseKeyFieldStrategy.getJoinForeignKey(ClassMapping elem)
protected ForeignKey	RelationToManyTableFieldStrategy.getJoinForeignKey(ClassMapping elem)
ForeignKey	RelationCollectionTableFieldStrategy.getJoinForeignKey(ClassMapping elem)
ForeignKey	RelationMapTableFieldStrategy.getJoinForeignKey(ClassMapping cls)
ForeignKey	MapTableFieldStrategy.getJoinForeignKey(ClassMapping cls)
ForeignKey	LRSCollectionFieldStrategy.getJoinForeignKey(ClassMapping elem) Return the foreign key used to join to the owning field for the given element mapping from LRSCollectionFieldStrategy.getIndependentElementMappings(boolean) (or null).
protected abstract ForeignKey	StoreCollectionFieldStrategy.getJoinForeignKey(ClassMapping elem) Return the foreign key used to join to the owning field for the given element mapping from ContainerFieldStrategy.getIndependentElementMappings(boolean) (or null).

Methods in org.apache.openjpa.jdbc.meta.strats with parameters of type ForeignKey

Modifier and Type	Method and Description
protected static void	ContainerFieldStrategy.appendJoinCount(SQLBuffer sql, Select sel, Joins joins, DBDictionary dict, FieldMapping field, ForeignKey fk)
static void	ContainerFieldStrategy.appendUnaliasedJoin(SQLBuffer sql, Select sel, Joins joins, DBDictionary dict, FieldMapping field, ForeignKey fk)
Object	HandlerFieldStrategy.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins)
Object	PrimitiveFieldStrategy.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins)
Object	StringFieldStrategy.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins)
Object	RelationFieldStrategy.getPrimaryKeyValue(Result res, Column[] cols, ForeignKey fk, JDBCStore store, Joins joins)
static boolean	RelationStrategies.isRelationId(ForeignKey fk) Affirms if all of the foreign key columns represent a relationship identifier.

Uses of ForeignKey in org.apache.openjpa.jdbc.schema

Fields in org.apache.openjpa.jdbc.schema declared as ForeignKey

Modifier and Type	Field and Description
static ForeignKey[]	Schemas.EMPTY_FOREIGN_KEYS

Methods in org.apache.openjpa.jdbc.schema that return ForeignKey

Modifier and Type	Method and Description
ForeignKey	Table.addForeignKey() Add a foreign key to the table.
ForeignKey	Table.addForeignKey(DBIdentifier name)
ForeignKey	Table.addForeignKey(String name) Deprecated.
ForeignKey[]	SchemaGroup.findExportedForeignKeys(PrimaryKey pk) Find all foreign keys exported by a given primary key (all foreign keys that link to the primary key).
protected ForeignKey	SchemaTool.findForeignKey(Table dbTable, ForeignKey fk) Find a foreign key in the given table that matches the given one.
ForeignKey	ForeignKey.FKMapKey.getFk()
ForeignKey	Table.getForeignKey(DBIdentifier name)
ForeignKey	Table.getForeignKey(String name) Deprecated.
ForeignKey[]	Table.getForeignKeys() Return all foreign keys for the table.
ForeignKey	Table.importForeignKey(ForeignKey fk) Import a foreign key; column names must match columns of this table.
protected ForeignKey	SchemaGroup.newForeignKey(DBIdentifier name, Table table)
protected ForeignKey	SchemaGroup.newForeignKey(String name, Table table) Deprecated.

Methods in org.apache.openjpa.jdbc.schema with parameters of type ForeignKey

Modifier and Type	Method and Description
void	ForeignKey.addColumn(ForeignKey fk) Joins the column of a single column FK to this FK.
boolean	SchemaTool.addForeignKey(ForeignKey fk) Add the given foreign key to the database schema.
boolean	SchemaTool.dropForeignKey(ForeignKey fk) Drop the given foreign key from the database schema.
boolean	ForeignKey.equalsForeignKey(ForeignKey fk) Foreign keys are equal if the satisfy the equality constraints of Constraint and they have the same local and primary key columns and action.
protected ForeignKey	SchemaTool.findForeignKey(Table dbTable, ForeignKey fk) Find a foreign key in the given table that matches the given one.
ForeignKey	Table.importForeignKey(ForeignKey fk) Import a foreign key; column names must match columns of this table.
boolean	ColumnIO.isAllInsertable(ForeignKey fk, boolean nullValue) Return true if all columns for the given key are insertable.
boolean	ColumnIO.isAllUpdatable(ForeignKey fk, boolean nullValue) Return true if all columns for the given key are updatable.
boolean	ColumnIO.isAnyInsertable(ForeignKey fk, boolean nullValue) Return true if any columns for the given key are insertable.
boolean	ColumnIO.isAnyUpdatable(ForeignKey fk, boolean nullValue) Return true if any columns for the given key are updatable.
boolean	Table.removeForeignKey(ForeignKey fk) Remove the given foreign key from the table.

Constructors in org.apache.openjpa.jdbc.schema with parameters of type ForeignKey

Constructor and Description
FKMapKey(ForeignKey fk)

Uses of ForeignKey in org.apache.openjpa.jdbc.sql

Methods in org.apache.openjpa.jdbc.sql that return ForeignKey

Modifier and Type	Method and Description
protected ForeignKey	DBDictionary.combineForeignKey(Map<ForeignKey.FKMapKey,ForeignKey> fkMap, ForeignKey fk) Combines partial foreign keys into singular key
ForeignKey	Join.getForeignKey()
ForeignKey[]	DBDictionary.getImportedKeys(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, Connection conn) Reflect on the schema to return foreign keys imported by the given table pattern.
ForeignKey[]	DBDictionary.getImportedKeys(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, Connection conn, boolean partialKeys) Reflect on the schema to return full foreign keys imported by the given table pattern.
ForeignKey[]	OracleDictionary.getImportedKeys(DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, Connection conn, boolean partialKeys)
ForeignKey[]	DBDictionary.getImportedKeys(DatabaseMetaData meta, String catalog, String schemaName, String tableName, Connection conn) Deprecated.
ForeignKey[]	DBDictionary.getImportedKeys(DatabaseMetaData meta, String catalog, String schemaName, String tableName, Connection conn, boolean partialKeys) Deprecated.
ForeignKey[]	OracleDictionary.getImportedKeys(DatabaseMetaData meta, String catalog, String schemaName, String tableName, Connection conn, boolean partialKeys)
protected ForeignKey	DBDictionary.newForeignKey(ResultSet fkMeta) Create a new foreign key from the information in the schema metadata.
protected ForeignKey	SolidDBDictionary.newForeignKey(ResultSet fkMeta) Solid does not support deferred referential integrity checking.

Methods in org.apache.openjpa.jdbc.sql with parameters of type ForeignKey

Modifier and Type	Method and Description
boolean	DBDictionary.canOuterJoin(int syntax, ForeignKey fk) Returns if the given foreign key can be eagerly loaded using other joins.
boolean	OracleDictionary.canOuterJoin(int syntax, ForeignKey fk)
void	PrimaryRow.clearForeignKey(ForeignKey fk)
void	RowImpl.clearForeignKey(ForeignKey fk) Clear a circular foreign key.
protected ForeignKey	DBDictionary.combineForeignKey(Map<ForeignKey.FKMapKey,ForeignKey> fkMap, ForeignKey fk) Combines partial foreign keys into singular key
String[]	DBDictionary.getAddForeignKeySQL(ForeignKey fk) Return a series of SQL statements to add the given foreign key to its table.
String[]	InformixDictionary.getAddForeignKeySQL(ForeignKey fk)
String[]	DBDictionary.getDropForeignKeySQL(ForeignKey fk, Connection conn) Return a series of SQL statements to drop the given foreign key from its table.
String[]	MySQLDictionary.getDropForeignKeySQL(ForeignKey fk, Connection conn) Return ALTER TABLE <table name> DROP FOREIGN KEY <fk name>.
String[]	MariaDBDictionary.getDropForeignKeySQL(ForeignKey fk, Connection conn) Return ALTER TABLE <table name> DROP FOREIGN KEY <fk name>.
protected String	DBDictionary.getForeignKeyConstraintSQL(ForeignKey fk) Return the declaration SQL for the given foreign key, or null if it is not supported.
ColumnIO	PrimaryRow.getForeignKeyIO(ForeignKey fk) Return the I/O information for the given set foreign key.
OpenJPAStateManager	PrimaryRow.getForeignKeySet(ForeignKey fk) Return the value for the given foreign key.
OpenJPAStateManager	PrimaryRow.getForeignKeyWhere(ForeignKey fk) Return the value for the given foreign key.
Joins	Joins.join(ForeignKey fk, boolean inverse, boolean toMany) Join the columns of the given foreign key.
Joins	SelectImpl.join(ForeignKey fk, boolean inverse, boolean toMany)
Joins	SelectImpl.SelectResult.join(ForeignKey fk, boolean inverse, boolean toMany)
Joins	Joins.joinRelation(String name, ForeignKey fk, ClassMapping target, int subclasses, boolean inverse, boolean toMany) Join the columns of the given foreign key, which represents a relation via the given field name.
Joins	SelectImpl.joinRelation(String name, ForeignKey fk, ClassMapping target, int subs, boolean inverse, boolean toMany)
Joins	SelectImpl.SelectResult.joinRelation(String name, ForeignKey fk, ClassMapping target, int subs, boolean inverse, boolean toMany)
Joins	Joins.outerJoin(ForeignKey fk, boolean inverse, boolean toMany) Join the columns of the given foreign key.
Joins	SelectImpl.outerJoin(ForeignKey fk, boolean inverse, boolean toMany)
Joins	SelectImpl.SelectResult.outerJoin(ForeignKey fk, boolean inverse, boolean toMany)
Joins	Joins.outerJoinRelation(String name, ForeignKey fk, ClassMapping target, int subclasses, boolean inverse, boolean toMany) Join the columns of the given foreign key, which represents a relation via the given field name.
Joins	SelectImpl.outerJoinRelation(String name, ForeignKey fk, ClassMapping target, int subs, boolean inverse, boolean toMany)
Joins	SelectImpl.SelectResult.outerJoinRelation(String name, ForeignKey fk, ClassMapping target, int subs, boolean inverse, boolean toMany)
void	PrimaryRow.setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm)
void	Row.setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm) Set the value of the given foreign key to the given object.
void	RowImpl.setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm)
void	SecondaryRow.setForeignKey(ForeignKey fk, ColumnIO io, OpenJPAStateManager sm)
void	PrimaryRow.setForeignKey(ForeignKey fk, OpenJPAStateManager sm)
void	Row.setForeignKey(ForeignKey fk, OpenJPAStateManager sm) Set the value of the given foreign key to the given object.
void	RowImpl.setForeignKey(ForeignKey fk, OpenJPAStateManager sm)
void	SecondaryRow.setForeignKey(ForeignKey fk, OpenJPAStateManager sm)
void	Select.whereForeignKey(ForeignKey fk, Object oid, ClassMapping mapping, JDBCStore store) Add where conditions setting the given foreign key to the given oid values.
void	LogicalUnion.UnionSelect.whereForeignKey(ForeignKey fk, Object oid, ClassMapping mapping, JDBCStore store)
void	SelectImpl.whereForeignKey(ForeignKey fk, Object oid, ClassMapping mapping, JDBCStore store)
void	PrimaryRow.whereForeignKey(ForeignKey fk, OpenJPAStateManager sm)
void	Row.whereForeignKey(ForeignKey fk, OpenJPAStateManager sm) Set the foreign key equality criteria to link to the given object.
void	RowImpl.whereForeignKey(ForeignKey fk, OpenJPAStateManager sm)

Method parameters in org.apache.openjpa.jdbc.sql with type arguments of type ForeignKey

Modifier and Type	Method and Description
protected ForeignKey	DBDictionary.combineForeignKey(Map<ForeignKey.FKMapKey,ForeignKey> fkMap, ForeignKey fk) Combines partial foreign keys into singular key