org.apache.metamodel.schema

Class MutableRelationship

java.lang.Object

org.apache.metamodel.util.BaseObject

org.apache.metamodel.schema.AbstractRelationship

org.apache.metamodel.schema.MutableRelationship

All Implemented Interfaces:

Serializable, Comparable<Relationship>, Relationship

public class MutableRelationship
extends AbstractRelationship
implements Serializable, Relationship

Immutable implementation of the Relationship interface. The immutability help ensure integrity of object-relationships. To create relationships use the createRelationship method.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Relationship	createRelationship(Column primaryColumn, Column foreignColumn)
static Relationship	createRelationship(List<Column> primaryColumns, List<Column> foreignColumns) Factory method to create relations between two tables by specifying which columns from the tables that enforce the relationship.
List<Column>	getForeignColumns() Gets the foreign key columns of this relationship.
List<Column>	getPrimaryColumns() Gets the primary key columns of this relationship.
void	remove()

Methods inherited from class org.apache.metamodel.schema.AbstractRelationship

checkSameTable, classEquals, compareTo, containsColumnPair, decorateIdentity, getForeignTable, getPrimaryTable, toString

Methods inherited from class org.apache.metamodel.util.BaseObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.metamodel.schema.Relationship

containsColumnPair, getForeignTable, getPrimaryTable

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

createRelationship

public static Relationship createRelationship(List<Column> primaryColumns,
                                              List<Column> foreignColumns)

Factory method to create relations between two tables by specifying which columns from the tables that enforce the relationship.

Parameters:

primaryColumns - the columns from the primary key table

foreignColumns - the columns from the foreign key table

Returns:

the relation created

remove

public void remove()

createRelationship

public static Relationship createRelationship(Column primaryColumn,
                                              Column foreignColumn)

getPrimaryColumns

public List<Column> getPrimaryColumns()

Description copied from interface: Relationship

Gets the primary key columns of this relationship.

Specified by:

getPrimaryColumns in interface Relationship

Returns:

an array of primary key columns.

getForeignColumns

public List<Column> getForeignColumns()

Description copied from interface: Relationship

Gets the foreign key columns of this relationship.

Specified by:

getForeignColumns in interface Relationship

Returns:

an array of foreign key columns.