magpie.utility.interfaces

Interface Options

All Known Implementing Classes:

AbstractNonlinearRegression, AbstractParsedNonlinearRegression, AdaptiveScalarizingEntryRanker, AddPropertyModifier, AllMetalsFilter, AllMetalsSplitter, AlloyingCompositionEntryGenerator, APEAttributeGenerator, APRDFAttributeGenerator, AreaUnderROCEvaluator, ARFFOutput, AttributeFilter, AttributeIntervalSplitter, AveragingDuplicateResolver, BaseAttributeEvaluator, BaseAttributeExpander, BaseAttributeGenerator, BaseAttributeSelector, BaseClassifier, BaseClusterer, BaseDatasetFilter, BaseDatasetModifier, BaseDatasetNormalizer, BaseDatasetOutput, BaseDatasetSplitter, BaseDuplicateResolver, BaseEntryGenerator, BaseEntryRanker, BaseModel, BaseRegression, BaseStatistics, BatchAttributeGenerator, BatchModelEvaluator, BestInAlloySystemFilter, BestIndividualSelector, ChargeDependentAttributeGenerator, ChemicalOrderingAttributeGenerator, ClassEliminationModifier, ClassFilter, ClassificationRegression, ClassificationStatistics, ClassIntervalModifier, ClassProbabilityFilter, ClassProbabilityRanker, ClassRangeFilter, ClustererSplitter, CombinatorialSubstitutionGenerator, ComparisonOperatorFilter, CompositeRegression, CompositionBasedCSPEngine, CompositionDataset, CompositionDistanceFilter, CompositionDistanceRanker, CompositionOutput, CompositionRangeEntryGenerator, CompositionSetDistanceFilter, CompositionSetDistanceModifier, ContainsElementFilter, CoordinationNumberAttributeGenerator, CoulombEwaldMatrixRegression, CoulombMatrixAttributeGenerator, CoulombSineMatrixRegression, CrossExpander, CrystalStructureDataset, CSPEngine, CumulantExpansionClassifier, Dataset, DelimitedClassOutput, DelimitedOutput, DiscreteToContinuousModifier, DMSPEngine, EffectiveCoordinationNumberAttributeGenerator, ElementalPropertyAttributeGenerator, ElementalPropertyAttributeGenerator, ElementDataset, ElementFractionAttributeGenerator, ElementPairPropertyAttributeGenerator, EntryRankerFilter, ErrorSignalModifier, ExhaustiveAttributeSelector, FilterSplitter, FixedStoichiometryCompositionEntryGenerator, FunctionExpander, GCLPAttributeGenerator, GridBaseEntryGenerator, GuessMeanRegression, HHICalculationModifier, IndependentVariableNormalizer, InverseNormalizer, IonicCompoundGenerator, IonicCompoundProximityAttributeGenerator, IonicityAttributeGenerator, IQROutlierFilter, JSONOutput, LassoAttributeSelector, LASSORegression, LatticeSimilarityAttributeGenerator, LinearCorrectedRegression, LocalPropertyDifferenceAttributeGenerator, LocalPropertyVarianceAttributeGenerator, LookupTableAttributeGenerator, MeasuredClassSplitter, MeredigAttributeGenerator, MeredigAttributeSelector, MetallurgicalHeuristicRegression, MixedMetalsSplitter, MixingRuleRegression, ModelPredictionAttributeGenerator, MultiFilter, MultiNormalizer, MultiObjectiveEntryRanker, MultiObjectiveRegression, MultipleElementGroupsSplitter, MultiPropertyDataset, MultiPropertyRegression, NaNToMeanModifier, NonlinearRegressionExpr, NonZeroClassificationSplitter, NonZeroClassModifier, ObjectiveFunctionSplitter, OxidationStateGuesser, PackingEfficiencyAttributeGenerator, PairSiteAttributeGenerator, PartitionToClassModifier, PearsonsCorrelationEvaluator, PhaseDiagramCompositionEntryGenerator, PhaseDiagramExclusionFilter, PhaseDiagramExclusionValidator, PolynomialFitEvaluator, PolynomialRegression, PowerExpander, PRDFAttributeGenerator, PRDFRegression, PredictedClassIntervalSplitter, PredictionOutlierFilter, PropertiesOutput, PropertyAsAttributeGenerator, PropertyFilter, PropertyFormulaRanker, PropertyRangeFilter, PropertyRanker, PrototypeDataset, PrototypeEntryGenerator, PythonBasedAttributeSelector, RandomForestAttributeSelector, RandomGuessRegression, RankingDuplicateResolver, RegexAttributeSelector, RegressionErrorFilter, RegressionStatistics, RegularSolutionNormalizer, RemoveCorrelatedAttributeSelector, RemoveDuplicateAttributeSelector, RemoveNaNAttributeSelector, RescalingNormalizer, ScikitLearnClassifier, ScikitLearnRegression, SetClassNamesModifier, SetPropertyValueModifier, SimpleEntryRanker, SimpleLinearModelExample, SimpleOutput, SingleElementGroupSplitter, SingleGuessRegression, SingleSiteAttributeGenerator, SoftmaxNormalizer, SpearmansCorrelationEvaluator, SplitClassifier, SplitModel, SplitRegression, StabilityCalculationModifier, StabilityFilter, StagedAttributeSelector, StagedRegression, StoichiometricAttributeGenerator, StructuralHeterogeneityAttributeGenerator, StructureKRRBasedRegression, TargetEntryRanker, TargetRegressionStatistics, UserSpecifiedAttributeSelector, UserSpecifiedExcludingAttributeSelector, ValenceShellAttributeGenerator, VolumeToLatticeParamModifier, WekaAttributeSelector, WekaClassifier, WekaClusterer, WekaRegression, YangOmegaAttributeGenerator, ZScoreNormalizer, ZScoreOutlierFilter

public interface Options

This interface signals that the options of a class can be set by a properly-parsed string. This is a simple version of the one included in weka.core: OptionHandler.

Method Summary

Modifier and Type	Method and Description
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.

Method Detail

setOptions

void setOptions(java.util.List<java.lang.Object> Options)
         throws java.lang.Exception

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

java.lang.String printUsage()

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function