com.rapidminer.operator.ports.metadata
Class ModelMetaData

java.lang.Object
  com.rapidminer.operator.ports.metadata.MetaData
      com.rapidminer.operator.ports.metadata.ModelMetaData

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PredictionModelMetaData

public class ModelMetaData
extends MetaData

This class is holds the informations for all models. It is the parent class of each more model specific implementation, which should be able to simulate all changes on the data of a model application during meta data transformation. This super class remembers the meta data of the trainings set and already checks compatibility of the application meta data with the trainings meta data. This is done in an equal way to the PredictionModel. TODO: This model needs to become abstract in order to force all operators to implement a proper and problem specific ModelMetaData object.

Author:

Simon Fischer, Sebastian Land

See Also:

Serialized Form

Constructor Summary

protected	ModelMetaData() Clone constructor
	ModelMetaData(java.lang.Class<? extends Model> mclass, ExampleSetMetaData trainingSetMetaData)
	ModelMetaData(ExampleSetMetaData trainingSetMetaData)

Method Summary

ExampleSetMetaData	apply(ExampleSetMetaData emd, InputPort inputPort) This method simulates the application of a model.
protected ExampleSetMetaData	applyEffects(ExampleSetMetaData emd, InputPort inputPort) This method must be implemented by subclasses in order to apply any changes on the meta data, that would occur on application of the real model.
ModelMetaData	clone()
java.lang.String	getDescription()
ExampleSetMetaData	getTrainingSetMetaData()

Methods inherited from class com.rapidminer.operator.ports.metadata.MetaData

addToHistory, forIOObject, forIOObject, getAnnotations, getErrorsForInput, getGenerationHistory, getGenerationHistoryAsHTML, getMetaData, getObjectClass, isCompatible, putMetaData, readResolve, setAnnotations, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelMetaData

protected ModelMetaData()

Clone constructor

ModelMetaData

public ModelMetaData(ExampleSetMetaData trainingSetMetaData)

ModelMetaData

public ModelMetaData(java.lang.Class<? extends Model> mclass,
                     ExampleSetMetaData trainingSetMetaData)

Method Detail

getDescription

public java.lang.String getDescription()

Overrides:

getDescription in class MetaData

apply

public final ExampleSetMetaData apply(ExampleSetMetaData emd,
                                      InputPort inputPort)

This method simulates the application of a model. First the compatibility of the model with the current example set is checked and then the effects are applied.

applyEffects

protected ExampleSetMetaData applyEffects(ExampleSetMetaData emd,
                                          InputPort inputPort)

This method must be implemented by subclasses in order to apply any changes on the meta data, that would occur on application of the real model. TODO: This method should be abstract.

clone

public ModelMetaData clone()

Overrides:

clone in class MetaData

getTrainingSetMetaData

public ExampleSetMetaData getTrainingSetMetaData()