com.rapidminer.parameter
Interface ParameterHandler

All Known Subinterfaces:

Renderer

All Known Implementing Classes:

AbsoluteDiscretization, AbsoluteSampling, AbsoluteSplitChain, AbsoluteStratifiedSampling, AbsoluteValueFilter, AbstractBootstrapping, AbstractBootstrappingValidation, AbstractClusterer, AbstractDataProcessing, AbstractDataReader, AbstractDataResultSetReader, AbstractDataTablePlotterRenderer, AbstractDataTableTableRenderer, AbstractDateDataProcessing, AbstractDiscretizationOperator, AbstractEntropyWeighting, AbstractExampleSetEvaluator, AbstractExampleSetJoin, AbstractExampleSetProcessing, AbstractExampleSetWriter, AbstractExampleSource, AbstractExampleWeighting, AbstractFeatureConstruction, AbstractFeatureProcessing, AbstractFeatureSelection, AbstractFeatureTransformation, AbstractFilteredDataProcessing, AbstractGeneratingGeneticAlgorithm, AbstractGeneticAlgorithm, AbstractGraphRenderer, AbstractIteratingOperatorChain, AbstractKernelBasedLearner, AbstractLearner, AbstractMetaLearner, AbstractModelLoader, AbstractMySVMLearner, AbstractOutlierDetection, AbstractPairwiseMatrixOperator, AbstractPerformanceEvaluator, AbstractReader, AbstractRenderer, AbstractSamplingOperator, AbstractSplitChain, AbstractStacking, AbstractStratifiedSampling, AbstractTableModelTableRenderer, AbstractTreeLearner, AbstractValueProcessing, AbstractWeighting, AbstractWriter, AccessDataReader, AccessDataWriter, AdaBoost, AdditiveRegression, AddNominalValue, AGA, AgglomerativeClustering, AggregationOperator, AnnotationsRenderer, AnovaCalculatorViewerRenderer, ANOVAMatrixOperator, AnovaMatrixRenderer, AnovaSignificanceTestOperator, AppendingExampleSetWriter, AreaUnderCurveRenderer, ArffExampleSetWriter, ArffExampleSource, AssociationRuleGenerator, AssociationRulesApplier, AssociationRulesGraphRenderer, AssociationRulesTableRenderer, Attribute2ExamplePivoting, AttributeAdd, AttributeAggregationOperator, AttributeBasedVotingLearner, AttributeConstruction, AttributeConstructionsLoader, AttributeConstructionsWriter, AttributeCopy, AttributeCounter, AttributeFilter, AttributeMerge, AttributeSubsetPreprocessing, AttributeValueMapper, AttributeValueReplace, AttributeValueSplit, AttributeValueSubstring, AttributeValueTrim, AttributeWeights2ExampleSet, AttributeWeightsApplier, AttributeWeightSelection, AttributeWeightsLoader, AttributeWeightsPlotRenderer, AttributeWeightsTableRenderer, AttributeWeightsWriter, AverageBuilder, AverageVectorRenderer, BackwardAttributeEliminationOperator, BackwardWeighting, Bagging, BatchProcessing, BatchXValidation, BayBoostStream, BayesianBoosting, BestRuleInduction, BibtexExampleSource, Binary2MultiClassLearner, BinaryClassificationPerformanceRenderer, BinDiscretization, BinominalClassificationPerformanceEvaluator, Bootstrapping, BootstrappingOperator, BootstrappingValidation, BruteForceSelection, BytewiseExampleSource, C45ExampleSource, CachedDatabaseExampleSource, CentroidBasedEvaluator, CHAIDLearner, ChangeAttributeName, ChangeAttributeNames2Generic, ChangeAttributeNamesReplace, ChangeAttributeRole, ChangeAttributeType, ChiSquaredWeighting, ChurnReductionExampleSetGenerator, ClassificationByRegression, ClearProcessLog, ClusterDensityEvaluator, ClusterIterator, ClusterModel2ExampleSet, ClusterModelCentroidPlotRenderer, ClusterModelCentroidTableRenderer, ClusterModelDendogrammRenderer, ClusterModelFolderRenderer, ClusterModelGraphRenderer, ClusterModelReader, ClusterModelWriter, ClusterNumberEvaluator, ClusterToPrediction, CollectionIterationOperator, CollectionOperator, CollectionRenderer, CommandLineOperator, CompleteFeatureGenerationOperator, ComponentWeights, ConditionedFeatureGeneration, ConsolePrintOperator, Construction2Names, CorpusBasedFeatureWeighting, CorrelationMatrixOperator, CorrelationWeighting, CostBasedThresholdLearner, CostEvaluator, CovarianceMatrixOperator, CrossDistancesOperator, CSVDataReader, CSVExampleSetWriter, CSVExampleSource, CSVExampleSource, DasyLabDataReader, Data2Log, Data2Performance, DatabaseDataReader, DatabaseExampleSetWriter, DatabaseExampleVisualizationOperator, DataMacroDefinitionOperator, DataStatisticsOperator, Date2Nominal, Date2Numerical, DateAdjust, DBaseExampleSource, DBOutlierOperator, DBScan, DecisionStumpLearner, DecisionTreeLearner, DeclareMissingValueOperator, DefaultComponentRenderer, DefaultLearner, DefaultTextRenderer, DelayOperator, DelegationModelRenderer, Deobfuscator, DimensionalityReducer, DirectedGGA, DirectMailingExampleSetGenerator, DistributionModelPlotRenderer, DistributionModelTableRenderer, DKNOutlierOperator, DummyOperator, EcodbOperator, EigenvectorModelEigenvalueRenderer, EigenvectorModelEigenvectorRenderer, EigenvectorModelVariancePlotRenderer, EMClusterer, EqualLabelWeighting, EvolutionaryFeatureAggregation, EvolutionaryParameterOptimizationOperator, EvolutionaryWeighting, EvoSVM, Example2AttributePivoting, ExampleDistributionEvaluator, ExampleFilter, ExampleIterator, ExampleRangeFilter, ExampleSet2AttributeWeights, ExampleSet2ClusterModel, ExampleSet2Similarity, ExampleSet2SimilarityExampleSet, ExampleSetBasedFeatureOperator, ExampleSetCartesian, ExampleSetDataRenderer, ExampleSetGenerator, ExampleSetIntersect, ExampleSetIterator, ExampleSetJoin, ExampleSetMerge, ExampleSetMetaDataRenderer, ExampleSetMinus, ExampleSetPlotRenderer, ExampleSetSuperset, ExampleSetToDictionary, ExampleSetTransformationOperator, ExampleSetTranspose, ExampleSetUnion, ExampleSetWriter, ExampleSource, ExampleVisualizationOperator, ExcelExampleSetWriter, ExcelExampleSource, ExcelExampleSource, ExceptionHandling, ExchangeAttributeRoles, ExtractClusterPrototypes, FastICA, FastKMeans, FastLargeMargin, FeatureBlockTypeFilter, FeatureFilter, FeatureGenerationOperator, FeatureIterator, FeatureNameFilter, FeatureOperator, FeatureRangeRemoval, FeatureSelectionOperator, FeatureSubsetIteration, FeatureValueTypeFilter, FeatureWeighting, FileEchoOperator, FileIterator, FillDataGaps, FixedSplitValidationChain, FlattenClusterModel, ForestBasedWeighting, FormulaExtractor, ForwardAttributeSelectionOperator, ForwardSelectionOperator, ForwardWeighting, FourierGGA, FourierTransform, FPGrowth, FrequencyDiscretization, FrequentItemSetAttributeCreator, FrequentItemSetsTableRenderer, FrequentItemSetUnificator, GaussFeatureConstructionOperator, GeneratePredictionOperator, GeneratePredictionRankingOperator, GeneratingGeneticAlgorithm, GeneticAlgorithm, GHA, GiniWeighting, GNUPlotOperator, GPLearner, GridSearchParameterOptimizationOperator, GroupByOperator, GroupedANOVAOperator, GSPOperator, GSPRenderer, GuessValueTypes, HierarchicalLearner, HierarchicalMultiClassLearner, HyperHyper, HyperModelWeightsRenderer, HyperplaneModelRenderer, ID3Learner, ID3NumericalLearner, IdTagging, ImprovedNeuralNetLearner, ImprovedNeuralNetModelRenderer, InfiniteValueReplenishment, InfoGainRatioWeighting, InfoGainWeighting, InteractiveAttributeWeighting, InternalBinominalRemapping, IOConsumeOperator, IOContainerReader, IOContainerWriter, IOMerger, IOMultiplier, IOMultiplyOperator, IOObjectReader, IOObjectWriter, IORetrievalOperator, IOSelectOperator, IOStorageOperator, IteratingGSS, IteratingOperatorChain, IteratingPerformanceAverage, JamaDimensionalityReduction, JMySVMLearner, KDBExampleSource, KennardStoneSampling, KernelKMeans, KernelLogisticRegression, KernelModelPlotRenderer, KernelModelSupportVectorRenderer, KernelModelWeightsRenderer, KernelNaiveBayes, KernelPCA, KMeans, KMedoids, KNNLearner, LearningCurveOperator, LibSVMLearner, LiftChartGenerator, LiftChartRenderer, LiftParetoChartGenerator, LinearCombinationOperator, LinearDiscriminantAnalysis, LinearMySVMLearner, LinearRegression, LinearRegressionModelTableRenderer, LocalPolynomialExampleWeightingOperator, LocalPolynomialRegressionModelPlotRenderer, LocalPolynomialRegressionModelTableRenderer, LocalPolynomialRegressionOperator, LOFOutlierOperator, LogisticRegression, Macro2Log, MacroConstructionOperator, MacroDefinitionOperator, MassiveDataGenerator, MaterializeDataInMemory, MemoryCleanUp, MergeNominalValues, MetaCost, MetaModelRenderer, MinimalEntropyDiscretization, MinMaxBinDiscretization, MinMaxWrapper, MissingValueImputation, MissingValueReplenishment, MissingValueReplenishmentView, ModelApplier, ModelBasedSampling, ModelGrouper, ModelLoader, ModelUngrouper, ModelUpdater, ModelWriter, MultiClassificationPerformanceRenderer, MultiCriterionDecisionStumps, MultipleLabelGenerator, MultipleLabelIterator, MultiwayDecisionTree, MutualInformationMatrixOperator, MyKLRLearner, NaiveBayes, NameBasedWeighting, NeuralNetGraphRenderer, NeuralNetLearner, NoiseOperator, Nominal2Date, Nominal2String, NominalExampleSetGenerator, NominalNumbers2Numerical, NominalToBinominal, NominalToNumeric, NonDominatedSorting, NonGraphicalRenderer, Normalization, Numerical2Date, Numerical2Real, NumericalMatrixPairwiseRenderer, NumericalMatrixPlotRenderer, NumericalMatrixTableRenderer, NumericToBinominal, NumericToFormattedNominal, NumericToNominal, NumericToPolynominal, Obfuscator, OneRErrorWeighting, Operator, OperatorChain, OperatorEnabler, OperatorSelector, ParameterCloner, ParameterIteratingOperatorChain, ParameterIteration, ParameterOptimizationOperator, ParameterSetLoader, ParameterSetter, ParameterSetWriter, PartialExampleSetLearner, PartitionOperator, PCA, PCAWeighting, Perceptron, PerformanceEvaluator, PerformanceLoader, PerformanceVectorRenderer, PerformanceWriter, PermutationOperator, PlattScaling, PolynomialRegression, PolynominalClassificationPerformanceEvaluator, PreprocessingOperator, ProcessBranch, ProcessEmbeddingOperator, ProcessLog2AttributeWeights, ProcessLog2ExampleSet, ProcessLogOperator, ProcessRootOperator, ProductGenerationOperator, PSOSVM, PSOWeighting, QuadraticDiscriminantAnalysis, QuadraticParameterOptimizationOperator, RainflowMatrixOperator, RainflowMatrixPlotRenderer, RainflowMatrixTableRenderer, RandomClustering, RandomForestLearner, RandomOptimizationChain, RandomSelection, RandomSplitValidationChain, RandomSplitWrapperValidationChain, RandomTreeLearner, RankingEvaluator, RatioSplitChain, RatioStratifiedSampling, Real2Integer, RegressionPerformanceEvaluator, RegularizedDiscriminantAnalysis, RelativeRegression, RelevanceTreeLearner, ReliefWeighting, RemoveCorrelatedFeatures, RemoveDuplicates, RemoveUselessFeatures, RepeatUntilOperatorChain, RepositorySource, RepositoryStorer, ResultSetExampleSource, ResultWriter, RMAbstractClusterer, ROCBasedComparisonOperator, ROCChartGenerator, ROCComparisonRenderer, RuleLearner, RuleSetRenderer, RVMLearner, SalesExampleSetGenerator, SamplingOperator, ScriptingOperator, SDRulesetInduction, SeeminglyUnrelatedRegressionOperator, SelectionOperator, SendMailOperator, SetData, SignificanceTestOperator, Similarity2ExampleSet, SimilarityGraphRenderer, SimilarityHistogramRenderer, SimilarityKDistanceRenderer, SimilarityTableRenderer, SimpleExampleSource, SimpleNeuralNetGraphRenderer, SimpleNeuralNetLearner, SimpleOperatorChain, SimplePerformanceEvaluator, SimpleRuleLearner, SimpleUncertainPredictionsTransformation, SingleMacroDefinitionOperator, SingleRuleLearner, SOMDimensionalityReduction, SOMModelVisualization, SOMModelVisualizationRenderer, Sorting, SparseFormatExampleSource, SpecialFormatExampleSetWriter, SplitValidationOperator, SPSSExampleSource, SQLExecution, Stacking, StandardDeviationWeighting, StataExampleSource, StratifiedSamplingOperator, String2Nominal, SubgroupDiscovery, SupportVectorCounter, SVClustering, SVDReduction, SVMWeighting, SymmetricalUncertaintyOperator, TeamProfitExampleSetGenerator, TFIDFFilter, ThresholdApplier, ThresholdCreator, ThresholdFinder, ThresholdLoader, ThresholdWriter, TopDownClustering, TransactionClustersExampleSetGenerator, TransfersExampleSetGenerator, TransformedRegression, TransitionGraphOperator, TransitionGraphRenderer, TransitionMatrixOperator, Tree2RuleConverter, TreeModelGraphRenderer, TTestSignificanceTestOperator, TTestSignificanceTestRenderer, UnfoldOperator, UnsetMacroOperator, UpSellingExampleSetGenerator, URLExampleSource, UserBasedDiscretization, UserBasedPerformanceEvaluator, UseRowAsAttributeNames, ValidationChain, ValueIteration, ValueReplenishment, ValueSubgroupIteration, VectorLinearRegression, Vote, WeightedBootstrapping, WeightedBootstrappingValidation, WeightedMultiClassPerformanceRenderer, WeightedPerformanceCreator, WeightGuidedSelectionOperator, WrapperValidationChain, WrapperXValidation, XrffExampleSetWriter, XrffExampleSource, XValidation, XVPrediction, YAGGA, YAGGA2

public interface ParameterHandler

This interface defines that instance are able to handle parameters. In RapidMiner, this if for example true for the class Operator but also for the Renderers.

Author:

Ingo Mierswa

Method Summary

java.lang.Object	getParameter(java.lang.String key) Returns a single parameter retrieved from the Parameters of this Operator.
boolean	getParameterAsBoolean(java.lang.String key) Returns a single named parameter and casts it to boolean.
char	getParameterAsChar(java.lang.String key) Returns a single named parameter and casts it to char.
java.awt.Color	getParameterAsColor(java.lang.String key) Returns a single named parameter and casts it to Color.
double	getParameterAsDouble(java.lang.String key) Returns a single named parameter and casts it to double.
java.io.File	getParameterAsFile(java.lang.String key) Returns a single named parameter and casts it to File.
java.io.File	getParameterAsFile(java.lang.String key, boolean createMissingDirectories) Returns a single named parameter and casts it to File.
java.io.InputStream	getParameterAsInputStream(java.lang.String key) Returns a single named parameter and tries to handle it as URL.
int	getParameterAsInt(java.lang.String key) Returns a single named parameter and casts it to int.
double[][]	getParameterAsMatrix(java.lang.String key) Returns a single named parameter and casts it to a double matrix.
java.lang.String	getParameterAsString(java.lang.String key) Returns a single named parameter and casts it to String.
java.util.List<java.lang.String[]>	getParameterList(java.lang.String key) Returns a single named parameter and casts it to List.
Parameters	getParameters() Returns a collection of all parameters of this parameter handler.
java.lang.String[]	getParameterTupel(java.lang.String key) Returns a Pair of Strings, the Strings are in the order of type definition of the subtypes.
java.util.List<ParameterType>	getParameterTypes() Returns a list of all defined parameter types for this handler.
boolean	isParameterSet(java.lang.String key) Returns true iff the parameter with the given name is set.
void	setListParameter(java.lang.String key, java.util.List<java.lang.String[]> list) Sets the given parameter list to the Parameters object of this operator.
void	setParameter(java.lang.String key, java.lang.String value) Sets the given single parameter to the Parameters object of this operator.
void	setParameters(Parameters parameters) Sets all parameters of this operator.

Method Detail

getParameters

Parameters getParameters()

Returns a collection of all parameters of this parameter handler.

setParameters

void setParameters(Parameters parameters)

Sets all parameters of this operator. The given parameters are not allowed to be null and must correspond to the parameter types defined by this parameter handler.

setParameter

void setParameter(java.lang.String key,
                  java.lang.String value)

Sets the given single parameter to the Parameters object of this operator. For parameter list the method setListParameter(String, List) should be used.

setListParameter

void setListParameter(java.lang.String key,
                      java.util.List<java.lang.String[]> list)

Sets the given parameter list to the Parameters object of this operator. For single parameters the method setParameter(String, String) should be used.

getParameter

java.lang.Object getParameter(java.lang.String key)
                              throws UndefinedParameterError

Returns a single parameter retrieved from the Parameters of this Operator.

Throws:

UndefinedParameterError

isParameterSet

boolean isParameterSet(java.lang.String key)
                       throws UndefinedParameterError

Returns true iff the parameter with the given name is set.

Throws:

UndefinedParameterError

getParameterAsString

java.lang.String getParameterAsString(java.lang.String key)
                                      throws UndefinedParameterError

Returns a single named parameter and casts it to String.

Throws:

UndefinedParameterError

getParameterAsChar

char getParameterAsChar(java.lang.String key)
                        throws UndefinedParameterError

Returns a single named parameter and casts it to char.

Throws:

UndefinedParameterError

getParameterAsInt

int getParameterAsInt(java.lang.String key)
                      throws UndefinedParameterError

Returns a single named parameter and casts it to int.

Throws:

UndefinedParameterError

getParameterAsDouble

double getParameterAsDouble(java.lang.String key)
                            throws UndefinedParameterError

Returns a single named parameter and casts it to double.

Throws:

UndefinedParameterError

getParameterAsBoolean

boolean getParameterAsBoolean(java.lang.String key)

Returns a single named parameter and casts it to boolean. This method never throws an exception since there are no non-optional boolean parameters.

getParameterList

java.util.List<java.lang.String[]> getParameterList(java.lang.String key)
                                                    throws UndefinedParameterError

Returns a single named parameter and casts it to List. The list returned by this method contains the user defined key-value pairs. Each element is an String array of length 2. The first element is the key, the second the parameter value.

Throws:

UndefinedParameterError

getParameterTupel

java.lang.String[] getParameterTupel(java.lang.String key)
                                     throws UndefinedParameterError

Returns a Pair of Strings, the Strings are in the order of type definition of the subtypes.

Throws:

UndefinedParameterError

getParameterAsColor

java.awt.Color getParameterAsColor(java.lang.String key)
                                   throws UndefinedParameterError

Returns a single named parameter and casts it to Color.

Throws:

UndefinedParameterError

getParameterAsInputStream

java.io.InputStream getParameterAsInputStream(java.lang.String key)
                                              throws UndefinedParameterError,
                                                     java.io.IOException

Returns a single named parameter and tries to handle it as URL. If this works, this method creates an input stream from this URL and delivers it. If not, this method tries to cast the parameter value to a file. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Throws:

UndefinedParameterError

java.io.IOException

getParameterAsFile

java.io.File getParameterAsFile(java.lang.String key)
                                throws UndefinedParameterError

Returns a single named parameter and casts it to File. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Throws:

UndefinedParameterError

getParameterAsFile

java.io.File getParameterAsFile(java.lang.String key,
                                boolean createMissingDirectories)
                                throws UndefinedParameterError

Returns a single named parameter and casts it to File. This file is already resolved against the process definition file. If the parameter name defines a non-optional parameter which is not set and has no default value, a UndefinedParameterError will be thrown. If the parameter is optional and was not set this method returns null. Operators should always use this method instead of directly using the method Process.resolveFileName(String).

Throws:

UndefinedParameterError

getParameterAsMatrix

double[][] getParameterAsMatrix(java.lang.String key)
                                throws UndefinedParameterError

Returns a single named parameter and casts it to a double matrix.

Throws:

UndefinedParameterError

getParameterTypes

java.util.List<ParameterType> getParameterTypes()

Returns a list of all defined parameter types for this handler.