com.rapidminer.operator
Interface IOObject

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ClusterModelInterface, ExampleSet, FormulaProvider, Model, ResultObject, ViewModel

All Known Implementing Classes:

AbsoluteError, AbstractEigenvectorModel, AbstractExampleSet, AbstractIOObject, AbstractModel, AbstractMySVMModel, AbstractNormalizationModel, AdaBoostModel, AdditiveRegressionModel, AnovaCalculator.AnovaSignificanceTestResult, ANOVAMatrix, AreaUnderCurve, AreaUnderCurve.Neutral, AreaUnderCurve.Optimistic, AreaUnderCurve.Pessimistic, AssociationRules, AttributeBasedVotingModel, AttributeDefaultModel, AttributeSelectionExampleSet, AttributeWeight, AttributeWeightedExampleSet, AttributeWeights, Averagable, AverageVector, BaggingModel, BayBoostModel, Binary2MultiClassModel, BinaryClassificationPerformance, CentroidClusterModel, ClassificationCostCriterion, ClusterModel, ConditionedExampleSet, ConjunctiveRuleModel, CorrelationCriterion, CrossEntropy, DataStatistics, DefaultModel, DendogramHierarchicalClusterModel, Dictionary, DimensionalityReducerModel, DiscretizationModel, DiscriminantModel, DistributionModel, EstimatedPerformance, EvoSVMModel, FastICAModel, FastMarginModel, FlatFuzzyClusterModel, FrequentItemSets, GHAModel, GPModel, GroupedModel, GSPSet, GSSModel, HeaderExampleSet, HierarchicalClusterModel, HierarchicalModel, HierarchicalMultiClassModel, HyperModel, HyperplaneModel, IGSSResult, ImprovedNeuralNetModel, IOObjectCollection, IQRNormalizationModel, JMySVMModel, KernelDistributionModel, KernelLogisticRegressionModel, KernelModel, KernelPCAModel, KNNClassificationModel, KNNRegressionModel, LenientRelativeError, LibSVMModel, LiftParetoChart, LinearMySVMModel, LinearRegressionModel, LocalPolynomialRegressionModel, LogisticLoss, LogisticRegressionModel, MappedExampleSet, Margin, MDLCriterion, MeasuredPerformance, MetaCostModel, MinMaxCriterion, MinMaxNormalizationModel, ModelViewExampleSet, MultiClassificationPerformance, MultiCriterionDecisionStumps.DecisionStumpModel, MultiModelByRegression, MyKLRModel, NeuralNetModel, NoiseModel, NominalToBinominalModel, NonSpecialAttributesExampleSet, NormalizedAbsoluteError, NumericalMatrix, ParameterSet, PCAModel, PerformanceCriterion, PerformanceVector, PlattScalingModel, PolynomialRegressionModel, PredictionAverage, PredictionModel, PreprocessingModel, ProportionNormalizationModel, RainflowMatrix, RandomForestModel, RankCorrelation, RankingCriterion, RelativeError, RelativeRegressionModel, RemappedExampleSet, ReplaceMissingExampleSet, ResultObjectAdapter, ROCComparison, RootMeanSquaredError, RootRelativeSquaredError, RuleModel, RuleSet, RunVector, RVMModel, SDEnsemble, SeeminglyUnrelatedRegressionModel, SignificanceTestResult, SimilarityExampleSet, SimilarityMeasureObject, SimpleBinaryPredictionModel, SimpleClassificationError, SimpleCriterion, SimpleDistributionModel, SimpleExampleSet, SimpleNeuralNetModel, SimplePredictionModel, SimpleResultObject, SimpleVoteModel, SingleExampleExampleSet, SoftMarginLoss, SOMDimensionalityReductionModel, SOMModelVisualization.SOMModelVisualizationResult, SortedExampleSet, SplittedExampleSet, SquaredCorrelationCriterion, SquaredError, StackingModel, StrictRelativeError, Threshold, ThresholdModel, TransformedRegressionModel, TransitionGraph, TreeModel, TTestSignificanceTestOperator.TTestSignificanceTestResult, UpdateablePredictionModel, ValueReplenishmentModel, VectorRegressionModel, WeightedMultiClassPerformance, ZTransformationModel

public interface IOObject
extends java.io.Serializable

This interface must be implemented by all objects that can be input/output objects for Operators. The copy method is necessary in cases where meta operator chains want to copy the input IOContainer before it is given to the children operators. Please note that the method only need to be implemented like a usual clone method for IO objects which can be altered after creation. In all other cases the implementation can simply return the same object. Hence, we use the name copy instead of clone.

Author:

Ingo Mierswa

Method Summary

void	appendOperatorToHistory(Operator operator, OutputPort port) This method is called if this IOObject is put out of the specified port after being created or processed by the given operator.
IOObject	copy() Should return a copy of this IOObject.
Annotations	getAnnotations()
LoggingHandler	getLog() Gets the logging associated with the operator currently working on this IOObject or the global log service if no operator was set.
java.util.List<ProcessingStep>	getProcessingHistory() This method must return a list of each step of processing steps this IOObject has been made including it's creating operator.
java.lang.String	getSource() Returns the source of this IOObject (might return null if the source is unknown).
void	setLoggingHandler(LoggingHandler loggingHandler) Sets the current working operator, i.e. the operator which is currently working on this IOObject.
void	setSource(java.lang.String sourceName) Sets the source of this IOObject.
void	write(java.io.OutputStream out) Writes the object data into a stream.

Method Detail

setSource

void setSource(java.lang.String sourceName)

Sets the source of this IOObject.

getSource

java.lang.String getSource()

Returns the source of this IOObject (might return null if the source is unknown).

appendOperatorToHistory

void appendOperatorToHistory(Operator operator,
                             OutputPort port)

This method is called if this IOObject is put out of the specified port after being created or processed by the given operator. This method has to keep track of the processing stations of this object, so that they are remembered and might be returned by the method getProcessingHistory.

getProcessingHistory

java.util.List<ProcessingStep> getProcessingHistory()

This method must return a list of each step of processing steps this IOObject has been made including it's creating operator.

copy

IOObject copy()

Should return a copy of this IOObject. Please note that the method can usually be implemented by simply returning the same object (i.e. return this;). The object needs only to be cloned in cases the IOObject can be altered after creation. This is for example the case for ExampleSets.

write

void write(java.io.OutputStream out)
           throws java.io.IOException

Writes the object data into a stream.

Throws:

java.io.IOException

getLog

LoggingHandler getLog()

Gets the logging associated with the operator currently working on this IOObject or the global log service if no operator was set.

setLoggingHandler

void setLoggingHandler(LoggingHandler loggingHandler)

Sets the current working operator, i.e. the operator which is currently working on this IOObject. This might be used for example for logging.

getAnnotations

Annotations getAnnotations()