org.dbunit.database.search

Class ForeignKeyRelationshipEdge

java.lang.Object

org.dbunit.util.search.Edge

org.dbunit.database.search.ForeignKeyRelationshipEdge

All Implemented Interfaces:

java.lang.Comparable, IEdge

public class ForeignKeyRelationshipEdge
extends Edge

Implementation of an edge representing a foreign key (FK) relationship between two tables.
The from node is the table which have the FK, while the to node is the table with the PK. In other words, the edge A->B means FK(A) = PK(B).
NOTE: only single-column PKs are supported at this moment

Since:

2.2 (Sep 9, 2005)

Version:

$Revision$ $Date$

Author:

Felipe Leme (dbunit@felipeal.net), Last changed by: $Author$

Constructor Summary

Constructors

Constructor and Description
ForeignKeyRelationshipEdge(java.lang.String tableFrom, java.lang.String tableTo, java.lang.String fkColumn, java.lang.String pkColumn) Creates an edge representing a FK.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compares this edge to the given one using the Edge.getFrom() nodes first.
boolean	equals(java.lang.Object obj)
java.lang.String	getFKColumn() Gets the name of the foreign key column in the relationship.
java.lang.String	getPKColumn() Gets the name of the primary key column in the relationship.
int	hashCode()
java.lang.String	toString()

Methods inherited from class org.dbunit.util.search.Edge

getFrom, getTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ForeignKeyRelationshipEdge

public ForeignKeyRelationshipEdge(java.lang.String tableFrom,
                                  java.lang.String tableTo,
                                  java.lang.String fkColumn,
                                  java.lang.String pkColumn)

Creates an edge representing a FK.

Parameters:

tableFrom - table that has the FK

tableTo - table that has the PK

fkColumn - name of the FK column on tableFrom

pkColumn - name of the PK column on tableTo

Method Detail

getFKColumn

public java.lang.String getFKColumn()

Gets the name of the foreign key column in the relationship.

Returns:

name of the foreign key column in the relationship.

getPKColumn

public java.lang.String getPKColumn()

Gets the name of the primary key column in the relationship.

Returns:

name of the primary key column in the relationship.

toString

public java.lang.String toString()

Overrides:

toString in class Edge

hashCode

public int hashCode()

Overrides:

hashCode in class Edge

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Edge

compareTo

public int compareTo(java.lang.Object o)

Description copied from class: Edge

Compares this edge to the given one using the Edge.getFrom() nodes first. If those are equal the Edge.getTo()} is used for comparison.

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class Edge

See Also:

Comparable.compareTo(java.lang.Object)