edu.udo.cs.miningmart.m4.utils
Class InterM4ForeignColumnsetForeignKey

java.lang.Object
  edu.udo.cs.miningmart.m4.utils.InterM4Communicator
      edu.udo.cs.miningmart.m4.utils.InterM4ForeignColumnsetForeignKey

public class InterM4ForeignColumnsetForeignKey
extends InterM4Communicator

Helper class for standard communication between Columnset (container) and ForeignKey. Each ForeignKey has two links to Columnsets, one for the primary key columnset and one for the foreign key columnset. This class is used for the link to the foreign key columnset.

Version:

$Id: InterM4ForeignColumnsetForeignKey.java,v 1.5 2006/09/27 14:59:55 euler Exp $

Author:

Martin Scholz

Constructor Summary

InterM4ForeignColumnsetForeignKey()

Method Summary

java.util.Collection	getCollection(java.lang.Object columnset) Each container object contains a collection, which has to be backed, so an "add" or "remove" to the collection results in a corresponding "add" or "remove" to the underlying container data structure.
java.lang.Object	getSingleRef(M4Object fKey) The M4Object different from the container object needs to have a reference to the container class.
void	setSingleRefPrimitive(M4Object fKey, java.lang.Object columnset) The M4Object different from the container object needs to have a reference to the container class.

Methods inherited from class edu.udo.cs.miningmart.m4.utils.InterM4Communicator

add, checkNameExists, remove, setCollectionTo, updateReferenceTo

Methods inherited from class java.lang.Object

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

Constructor Detail

InterM4ForeignColumnsetForeignKey

public InterM4ForeignColumnsetForeignKey()

Method Detail

getSingleRef

public java.lang.Object getSingleRef(M4Object fKey)
                              throws M4Exception

Description copied from class: InterM4Communicator

The M4Object different from the container object needs to have a reference to the container class.

Parameters:

fKey - a ForeignKey

Returns:

the current container object

Throws:

M4Exception

See Also:

InterM4Communicator.getSingleRef(M4Object)

getCollection

public java.util.Collection getCollection(java.lang.Object columnset)
                                   throws M4Exception

Description copied from class: InterM4Communicator

Each container object contains a collection, which has to be backed, so an "add" or "remove" to the collection results in a corresponding "add" or "remove" to the underlying container data structure. This method must never return null, but a backed empty Collection instead!

Parameters:

columnset - a Columnset

Returns:

the container object's collection

Throws:

M4Exception

See Also:

InterM4Communicator#getCollection(M4Object)

setSingleRefPrimitive

public void setSingleRefPrimitive(M4Object fKey,
                                  java.lang.Object columnset)
                           throws M4Exception

Description copied from class: InterM4Communicator

The M4Object different from the container object needs to have a reference to the container class. This method is a primitive setter for this field. It should consist of a single assignment.

Parameters:

fKkey - a ForeignKey

columnset - a Columnset

Throws:

M4Exception

See Also:

InterM4Communicator#setSingleRefPrimitive(M4Object, M4Object)