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

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

public class InterM4ColumnForeignKeyMember
extends InterM4Communicator

Helper class for standard communication between Column (container) and KeyMember.

Version:

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

Author:

Martin Scholz

Constructor Summary

InterM4ColumnForeignKeyMember()

Method Summary

java.util.Collection	getCollection(java.lang.Object column) 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 keymem) The M4Object different from the container object needs to have a reference to the container class.
void	setSingleRefPrimitive(M4Object keymem, java.lang.Object column) 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

InterM4ColumnForeignKeyMember

public InterM4ColumnForeignKeyMember()

Method Detail

getSingleRef

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

Description copied from class: InterM4Communicator

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

Parameters:

keymem - a KeyMember

Returns:

the KeyMember's foreign key Column

Throws:

M4Exception

See Also:

InterM4Communicator.getSingleRef(M4Object)

getCollection

public java.util.Collection getCollection(java.lang.Object column)
                                   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:

column - a Column

Returns:

the Column's Collection

Throws:

M4Exception

See Also:

InterM4Communicator#getCollection(M4Object)

setSingleRefPrimitive

public void setSingleRefPrimitive(M4Object keymem,
                                  java.lang.Object column)
                           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:

keymem - a KeyMember

column - a Column to be set as the foreign key

Throws:

M4Exception

See Also:

InterM4Communicator#setSingleRefPrimitive(M4Object, M4Object)