com.rapidminer.operator
Interface ResultObject

All Superinterfaces:

IOObject, java.io.Serializable

All Known Subinterfaces:

ExampleSet, FormulaProvider, Model, ViewModel

All Known Implementing Classes:

AbsoluteError, AbstractExampleSet, AbstractModel, AbstractMySVMModel, AdaBoostModel, AdditiveRegressionModel, AnovaCalculator.AnovaSignificanceTestResult, ANOVAMatrix, AreaUnderCurve, AssociationRules, AttributeBasedVotingModel, 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, GSSModel, HeaderExampleSet, HierarchicalClusterModel, HyperModel, HyperplaneModel, IGSSResult, ImprovedNeuralNetModel, JMySVMModel, KernelDistributionModel, KernelLogisticRegressionModel, KernelModel, KernelPCAModel, KNNClassificationModel, KNNRegressionModel, LenientRelativeError, LibSVMModel, LiftParetoChart, LinearRegressionModel, LogisticLoss, LogisticRegressionModel, MappedExampleSet, Margin, MDLCriterion, MeasuredPerformance, MetaCostModel, MinMaxCriterion, MinMaxNormalizationModel, ModelViewExampleSet, MultiClassificationPerformance, MultiCriterionDecisionStumps.DecisionStumpModel, MultiModel, MultiModelByRegression, MyKLRModel, NeuralNetModel, NominalToBinominalModel, NonSpecialAttributesExampleSet, NormalizedAbsoluteError, NumericalMatrix, ParameterSet, PCAModel, PerformanceCriterion, PerformanceVector, PlattScalingModel, PolynomialRegressionModel, PredictionAverage, PredictionModel, PredictionTrendAccuracy, PreprocessingModel, ProportionNormalizationModel, RainflowMatrix, RankCorrelation, RelativeError, RelativeRegressionModel, RemappedExampleSet, ReplaceMissingExampleSet, ResultObjectAdapter, ROCComparison, RootMeanSquaredError, RootRelativeSquaredError, RuleModel, RuleSet, RunVector, RVMModel, SDEnsemble, SignificanceTestResult, SimilarityExampleSet, SimilarityMeasure, SimpleBinaryPredictionModel, SimpleClassificationError, SimpleCriterion, SimpleDistributionModel, SimpleExampleSet, SimpleNeuralNetModel, SimplePredictionModel, SimpleResultObject, SimpleVoteModel, SingleExampleExampleSet, SoftMarginLoss, SOMDimensionalityReductionModel, SortedExampleSet, SplittedExampleSet, SquaredCorrelationCriterion, SquaredError, StackingModel, StrictRelativeError, TextObject, Threshold, ThresholdModel, TransformedRegressionModel, TransitionGraph, TreeModel, TTestSignificanceTestOperator.TTestSignificanceTestResult, VectorRegressionModel, WeightedMultiClassPerformance, WekaAssociator, WekaClassifier, WekaClusterModel, ZTransformationModel

public interface ResultObject
extends IOObject

This interface extends IOObject and is hence an object which can be handled by operators. Additionally this object is a result and can be of interest for a user. ResultWriters can write the results in a result file.

Author:

Ingo Mierswa

See Also:

ResultWriter

Method Summary

java.util.List	getActions() Returns a list of actions (e.g.
java.lang.String	getName() Defines the name of this result object.
javax.swing.Icon	getResultIcon() Returns an icon used for displaying the results.
java.awt.Component	getVisualizationComponent(IOContainer container) Returns a component that can visualize this result in the GUI.
java.lang.String	toResultString() Result string will be displayed in result files written with a ResultWriter operator.

Methods inherited from interface com.rapidminer.operator.IOObject

copy, getLog, getSource, setLoggingHandler, setSource, write

Method Detail

getName

java.lang.String getName()

Defines the name of this result object.

toResultString

java.lang.String toResultString()

Result string will be displayed in result files written with a ResultWriter operator.

getVisualizationComponent

java.awt.Component getVisualizationComponent(IOContainer container)

Returns a component that can visualize this result in the GUI. Please note that the delivered visualization component is _not_ enclosed by a JScrollPane and implementing classes must ensure themself that the component is scrollable if desired. It is suggested that an instance of the class ExtendedJScrollPane is used for that purpose. The given IOContainer can usually be ignored but can be used in order to allow a sort of combined visualization of two or more results, e.g. a ExampleSet visualization containing also the weights for the attributes (AttributeWeights). Please note that the given container might be null which must not lead to a NullPointerExcepton!

getResultIcon

javax.swing.Icon getResultIcon()

Returns an icon used for displaying the results. May return null.

getActions

java.util.List getActions()

Returns a list of actions (e.g. "save") that is displayed below (or near to) the visualisation component.