weka.classifiers.pmml.consumer

Class RuleSetModel

java.lang.Object

weka.classifiers.AbstractClassifier

weka.classifiers.pmml.consumer.PMMLClassifier

weka.classifiers.pmml.consumer.RuleSetModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Classifier, BatchPredictor, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, PMMLModel, RevisionHandler

public class RuleSetModel
extends PMMLClassifier

Class implementing import of PMML RuleSetModel. Can be used as a Weka classifier for prediction only (buildClassifier() raises an Exception).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_algorithmName The algorithm name (if defined)
protected weka.classifiers.pmml.consumer.TreeModel.MiningFunction	m_functionType The mining function
protected java.lang.String	m_modelName The model name (if defined)
protected weka.classifiers.pmml.consumer.RuleSetModel.RuleSet	m_ruleSet The set of rules

Fields inherited from class weka.classifiers.pmml.consumer.PMMLClassifier

m_creatorApplication, m_dataDictionary, m_fieldsMap, m_initialized, m_log, m_miningSchema, m_pmmlVersion

Fields inherited from class weka.classifiers.AbstractClassifier

BATCH_SIZE_DEFAULT, m_BatchSize, m_Debug, m_DoNotCheckCapabilities, m_numDecimalPlaces, NUM_DECIMAL_PLACES_DEFAULT

Constructor Summary

Constructors

Constructor and Description
RuleSetModel(org.w3c.dom.Element model, Instances dataDictionary, MiningSchema miningSchema) Constructor for a RuleSetModel

Method Summary

Modifier and Type	Method and Description
double[]	distributionForInstance(Instance inst) Classifies the given test instance.
java.lang.String	getRevision() Get the revision string for this class
java.lang.String	toString() Return a textual description of this model.

Methods inherited from class weka.classifiers.pmml.consumer.PMMLClassifier

buildClassifier, done, getCreatorApplication, getDataDictionary, getFieldsMappingString, getLog, getMiningSchema, getPMMLVersion, mapToMiningSchema, setCreatorApplication, setLog, setPMMLVersion

Methods inherited from class weka.classifiers.AbstractClassifier

batchSizeTipText, classifyInstance, debugTipText, distributionsForInstances, doNotCheckCapabilitiesTipText, forName, getBatchSize, getCapabilities, getDebug, getDoNotCheckCapabilities, getNumDecimalPlaces, getOptions, implementsMoreEfficientBatchPrediction, listOptions, makeCopies, makeCopy, numDecimalPlacesTipText, postExecution, preExecution, run, runClassifier, setBatchSize, setDebug, setDoNotCheckCapabilities, setNumDecimalPlaces, setOptions

Methods inherited from class java.lang.Object

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

Field Detail

m_functionType

protected weka.classifiers.pmml.consumer.TreeModel.MiningFunction m_functionType

The mining function

m_modelName

protected java.lang.String m_modelName

The model name (if defined)

m_algorithmName

protected java.lang.String m_algorithmName

The algorithm name (if defined)

m_ruleSet

protected weka.classifiers.pmml.consumer.RuleSetModel.RuleSet m_ruleSet

The set of rules

Constructor Detail

RuleSetModel

public RuleSetModel(org.w3c.dom.Element model,
                    Instances dataDictionary,
                    MiningSchema miningSchema)
             throws java.lang.Exception

Constructor for a RuleSetModel

Parameters:

model - the XML element encapsulating the RuleSetModel

dataDictionary - the data dictionary to use

miningSchema - the mining schema to use

Throws:

java.lang.Exception - if something goes wrong

Method Detail

distributionForInstance

public double[] distributionForInstance(Instance inst)
                                 throws java.lang.Exception

Classifies the given test instance. The instance has to belong to a dataset when it's being classified.

Specified by:

distributionForInstance in interface Classifier

Overrides:

distributionForInstance in class AbstractClassifier

Parameters:

inst - the instance to be classified

Returns:

the predicted most likely class for the instance or Utils.missingValue() if no prediction is made

Throws:

java.lang.Exception - if an error occurred during the prediction

toString

public java.lang.String toString()

Return a textual description of this model.

Overrides:

toString in class java.lang.Object

Returns:

a textual description of this model

getRevision

public java.lang.String getRevision()

Get the revision string for this class

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class AbstractClassifier

Returns:

the revision string