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

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

public class InterM4ChainStep
extends InterM4Communicator

Helper class for standard communication between Chain (container) and Step.

Version:

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

Author:

Martin Scholz

Constructor Summary

InterM4ChainStep()

Method Summary

java.util.Collection	getCollection(java.lang.Object chain) 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 step) 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

InterM4ChainStep

public InterM4ChainStep()

Method Detail

getSingleRef

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

Description copied from class: InterM4Communicator

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

Parameters:

step - a Step

Returns:

the Step's Chain

Throws:

M4Exception

See Also:

InterM4Communicator.getSingleRef(M4Object)

getCollection

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

chain - a Chain

Returns:

the Chain's Collection of Steps

Throws:

M4Exception

See Also:

InterM4Communicator#getCollection(M4Object)