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

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

public class InterM4ParameterArrayParameter
extends InterM4Communicator

Helper class for standard communication between ParameterArray (container) and Parameter.

Version:

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

Author:

Martin Scholz

Constructor Summary

InterM4ParameterArrayParameter()

Method Summary

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

InterM4ParameterArrayParameter

public InterM4ParameterArrayParameter()

Method Detail

getSingleRef

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

Description copied from class: InterM4Communicator

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

Parameters:

parameter - a Parameter

Returns:

the ParameterArray of the Parameter

Throws:

M4Exception

See Also:

InterM4Communicator.getSingleRef(M4Object)

getCollection

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

paramArray - a ParameterArray

Returns:

a backed Collection of Objects

Throws:

M4Exception

See Also:

InterM4Communicator#getCollection(M4Object)

setSingleRefPrimitive

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

parameter - a Parameter

paramArray - a ParameterArray

Throws:

M4Exception

See Also:

InterM4Communicator#setSingleRefPrimitive(M4Object, M4Object)