edu.udo.cs.yale.operator
Class AbstractModel

java.lang.Object
  edu.udo.cs.yale.operator.AbstractIOObject
      edu.udo.cs.yale.operator.ResultObjectAdapter
          edu.udo.cs.yale.operator.AbstractModel

All Implemented Interfaces:

IOObject, Model, ResultObject, Saveable

Direct Known Subclasses:

IOModel, SerializableModel

public abstract class AbstractModel
extends ResultObjectAdapter
implements Model

Abstract model is the superclass for all objects which change a data set. For example, a model generated by a learner might add a predicted attribute. Other models can be created during preprocessing, e.g. a transformation model containing the parameters for a z-transformation. Models can be combined by using a CombinedModel. All models can be applied with a ModelApplier operator.

Version:

$Id: AbstractModel.java,v 2.5 2006/08/03 14:39:31 ingomierswa Exp $

Author:

Ingo Mierswa

Constructor Summary

AbstractModel()

Method Summary

boolean	equals(java.lang.Object o) Returns true iff the given object has the same class.
java.lang.String	getExtension() Returns the default extension in file choosers.
java.lang.String	getFileDescription() Returns the file description used in file choosers.
static Model	readModel(java.io.File file) Reads the model from a file.
static Model	readModel(java.io.ObjectInputStream in) Reads the model from an ObjectInput.
void	save(java.io.File file) Writes the object into the given file.
void	setParameter(java.lang.String key, java.lang.Object value) Throws a UserError since most models should not allow additional parameters during application.
abstract void	writeData(java.io.ObjectOutputStream out) Writes the model to a stream.
void	writeModel(java.io.File file) Writes the model to a file by writing its class and calling writeModel(ObjectOutput).
void	writeModel(java.io.ObjectOutputStream out) Writes the model to a file by writing its class and calling writeModel(ObjectOutput).

Methods inherited from class edu.udo.cs.yale.operator.ResultObjectAdapter

addAction, getActions, getName, getVisualisationComponent, toHTML, toResultString

Methods inherited from class edu.udo.cs.yale.operator.AbstractIOObject

copy, read, read, read, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.udo.cs.yale.operator.Model

apply

Methods inherited from interface edu.udo.cs.yale.operator.ResultObject

getActions, getName, getVisualisationComponent, toResultString

Methods inherited from interface edu.udo.cs.yale.operator.IOObject

copy, write, write

Constructor Detail

AbstractModel

public AbstractModel()

Method Detail

writeData

public abstract void writeData(java.io.ObjectOutputStream out)
                        throws java.io.IOException

Writes the model to a stream.

Throws:

java.io.IOException

setParameter

public void setParameter(java.lang.String key,
                         java.lang.Object value)
                  throws OperatorException

Throws a UserError since most models should not allow additional parameters during application. However, subclasses may overwrite this method.

Specified by:

setParameter in interface Model

Throws:

OperatorException

save

public void save(java.io.File file)
          throws java.io.IOException

Description copied from interface: Saveable

Writes the object into the given file.

Specified by:

save in interface Saveable

Throws:

java.io.IOException

getExtension

public java.lang.String getExtension()

Description copied from interface: Saveable

Returns the default extension in file choosers.

Specified by:

getExtension in interface Saveable

getFileDescription

public java.lang.String getFileDescription()

Description copied from interface: Saveable

Returns the file description used in file choosers.

Specified by:

getFileDescription in interface Saveable

writeModel

public final void writeModel(java.io.File file)
                      throws java.io.IOException

Writes the model to a file by writing its class and calling writeModel(ObjectOutput).

Specified by:

writeModel in interface Model

Throws:

java.io.IOException

writeModel

public final void writeModel(java.io.ObjectOutputStream out)
                      throws java.io.IOException

Writes the model to a file by writing its class and calling writeModel(ObjectOutput).

Specified by:

writeModel in interface Model

Throws:

java.io.IOException

readModel

public static final Model readModel(java.io.File file)
                             throws OperatorException,
                                    java.io.IOException

Reads the model from a file.

Throws:

OperatorException

java.io.IOException

readModel

public static final Model readModel(java.io.ObjectInputStream in)
                             throws java.io.IOException

Reads the model from an ObjectInput.

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Returns true iff the given object has the same class.

Overrides:

equals in class java.lang.Object