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

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

public class InterM4ChainToParentChain
extends InterM4Communicator

Helper class for standard communication between a Chain (container) and its subchains

Version:

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

Author:

Timm Euler

Constructor Summary

InterM4ChainToParentChain()

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 subchain) 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

InterM4ChainToParentChain

public InterM4ChainToParentChain()

Method Detail

getSingleRef

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

Description copied from class: InterM4Communicator

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

Parameters:

subchain - a Chain

Returns:

the given Chain's parent 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 DIRECT Sub-Chains

Throws:

M4Exception

See Also:

InterM4Communicator#getCollection(M4Object)