edu.udo.cs.miningmart.m4.core
Class ParameterObject

java.lang.Object
  edu.udo.cs.miningmart.m4.core.M4Object
      edu.udo.cs.miningmart.m4.core.M4Data
          edu.udo.cs.miningmart.m4.core.GraphicalM4Object
              edu.udo.cs.miningmart.m4.core.ParameterObject

All Implemented Interfaces:

GraphicalM4Object, M4Data, M4Object, ParameterObject, M4Table, XmlInfo, java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

Concept, Feature, Relation, Value

public abstract class ParameterObject
extends GraphicalM4Object
implements XmlInfo, ParameterObject

Superclass for all M4Objects that might be a Steps parameter.

Version:

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

Author:

Martin Scholz

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.udo.cs.miningmart.m4.core.GraphicalM4Object

graph2coord

Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Data

myDocumentation

Fields inherited from class edu.udo.cs.miningmart.m4.core.M4Object

myId, myName

Fields inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo

M4_XML_VERSION, TAG_COLLECTION, TAG_DOUBLE, TAG_INTEGER, TAG_LONG, TAG_M4_ID, TAG_SHORT, TAG_STRING, TAG_XML_ID

Fields inherited from interface edu.udo.cs.miningmart.m4.utils.M4Table

NOT_NULL

Constructor Summary

ParameterObject(DB db)

Method Summary

void	addParameterReference(Parameter par) Informs this object that a Parameter references it.
java.util.Collection	getDependentObjects() This method is part of the XML-serialization and needs to be implemented by all M4Data sub-classes that need to be serialized.
java.util.Collection	getParameterReferences()
protected void	removeAllM4References() This method needs to be implemented by all M4Data objects.
boolean	removeParameterReference(Parameter par)

Methods inherited from class edu.udo.cs.miningmart.m4.core.GraphicalM4Object

deleteLocal, deleteSoon, getCoordinates, getPoint, hasCoordinates, primitiveSetCoordinates, print, setCoordinatesDirty, setName, setPoint, storeLocal

Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Data

exportLocal, genericGetter, genericSetter, getDocumentation, getObjectsInNamespace, getObjectsReferencingMe, getObjectsReferencingMe, getObjectTag, getUniqueName, getValidName, getValidName, getXmlIdTag, getXmlVersion, hasDeleteStatus, importLocal, isDirty, isWaitingForDelete, primitiveGetDocObject, primitiveSetDocObject, readFromDb, readFromDbLocal, removeDocObject, removeFromDb, removeSetFromDb, setDirty, setDocumentation, setId, updateObjectsFromTable

Methods inherited from class edu.udo.cs.miningmart.m4.core.M4Object

compareTo, doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, putM4ObjectToCache, replaceSpacesInName, setNotNew

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.udo.cs.miningmart.m4.utils.XmlInfo

doPrint, doPrint, exportLocal, genericGetter, genericSetter, getObjectTag, getXmlIdTag, getXmlInfo, getXmlVersion, importLocal

Methods inherited from interface edu.udo.cs.miningmart.m4.GraphicalM4Object

getPoint, setPoint

Methods inherited from interface edu.udo.cs.miningmart.m4.M4Data

deleteSoon, getDocumentation, getValidName, isDirty, isWaitingForDelete, setDocumentation

Methods inherited from interface edu.udo.cs.miningmart.m4.M4Object

doPrint, doPrint, equals, executeBusinessSingleValueSqlRead, executeBusinessSingleValueSqlReadL, executeBusinessSqlRead, executeBusinessSqlWrite, executeM4SingleValueSqlRead, executeM4SingleValueSqlReadL, executeM4SqlRead, executeM4SqlWrite, getCasePrintObject, getId, getM4Db, getM4ObjectFromCache, getName, getNextM4SequenceValue, isNew, load, print, putM4ObjectToCache, replaceSpacesInName, setId, setName, setNotNew

Methods inherited from interface edu.udo.cs.miningmart.m4.utils.M4Table

getIdAttributeName, getM4Info, getM4TableName

Constructor Detail

ParameterObject

public ParameterObject(DB db)

Method Detail

addParameterReference

public void addParameterReference(Parameter par)
                           throws M4Exception

Informs this object that a Parameter references it.

Specified by:

addParameterReference in interface ParameterObject

Parameters:

par - the Parameter

Throws:

M4Exception

getParameterReferences

public java.util.Collection getParameterReferences()
                                            throws M4Exception

Specified by:

getParameterReferences in interface ParameterObject

Returns:

a Collection of all Parameters referencing this object

Throws:

M4Exception

removeParameterReference

public boolean removeParameterReference(Parameter par)
                                 throws M4Exception

Specified by:

removeParameterReference in interface ParameterObject

Parameters:

a - Parameter no longer referencing this object

Returns:

true if the Parameter specified could be removed from the list of referencing Parameters

Throws:

M4Exception

getDependentObjects

public java.util.Collection getDependentObjects()
                                         throws M4Exception

Description copied from class: M4Data

This method is part of the XML-serialization and needs to be implemented by all M4Data sub-classes that need to be serialized.

Specified by:

getDependentObjects in interface XmlInfo

Overrides:

getDependentObjects in class GraphicalM4Object

Returns:

a Collection of all M4Data Java objects holding a foreign key reference to this object. This method must never return null.

Throws:

M4Exception

See Also:

M4Data.getDependentObjects()

removeAllM4References

protected void removeAllM4References()
                              throws M4Exception

Description copied from class: M4Data

This method needs to be implemented by all M4Data objects. It has to remove all references to other M4Objects.

Specified by:

removeAllM4References in class M4Data

Throws:

M4Exception

See Also:

M4Data.removeAllM4References()