weka.core.pmml

Class PMMLFactory

java.lang.Object

weka.core.pmml.PMMLFactory

public class PMMLFactory
extends Object

This class is a factory class for reading/writing PMML models

Version:

$Revision: 5562 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PMMLFactory.ModelType for serialization

Constructor Summary

Constructors

Constructor and Description
PMMLFactory()

Method Summary

Modifier and Type	Method and Description
static String	applyClassifier(PMMLModel model, Instances test)
protected static Instances	getDataDictionaryAsInstances(Document doc) Get the data dictionary as an Instances object
protected static Instances	getMiningSchemaAsInstances(Element model, Instances dataDictionary) Deprecated. Use the MiningSchema class instead
protected static Element	getModelElement(Document doc, PMMLFactory.ModelType modelType) Get the Element that contains the pmml model
protected static PMMLModel	getModelInstance(Document doc, PMMLFactory.ModelType modelType, Element model, Instances dataDictionary, MiningSchema miningSchema) Get an instance of a PMMLModel from the supplied Document
protected static PMMLFactory.ModelType	getModelType(Document doc) Get the type of model
static PMMLModel	getPMMLModel(File file) Read and return a PMML model.
static PMMLModel	getPMMLModel(File file, Logger log) Read and return a PMML model.
static PMMLModel	getPMMLModel(InputStream stream) Read and return a PMML model.
static PMMLModel	getPMMLModel(InputStream stream, Logger log) Read and return a PMML model.
static PMMLModel	getPMMLModel(String filename) Read and return a PMML model.
static PMMLModel	getPMMLModel(String filename, Logger log) Read and return a PMML model.
protected static weka.core.pmml.TransformationDictionary	getTransformationDictionary(Document doc, Instances dataDictionary) Get the transformation dictionary (if there is one).
static void	main(String[] args)
static void	serializePMMLModel(PMMLModel model, File file) Serialize a PMMLModel object that encapsulates a PMML model
static void	serializePMMLModel(PMMLModel model, OutputStream stream) Serialize a PMMLModel object that encapsulates a PMML model
static void	serializePMMLModel(PMMLModel model, String filename) Serialize a PMMLModel object that encapsulates a PMML model

Methods inherited from class java.lang.Object

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

Constructor Detail

PMMLFactory

public PMMLFactory()

Method Detail

getPMMLModel

public static PMMLModel getPMMLModel(String filename)
                              throws Exception

Read and return a PMML model.

Parameters:

filename - the name of the file to read from

Returns:

a PMML model

Throws:

Exception - if there is a problem while reading the file

getPMMLModel

public static PMMLModel getPMMLModel(File file)
                              throws Exception

Read and return a PMML model.

Parameters:

file - a File to read from

Returns:

a PMML model

Throws:

Exception - if there is a problem while reading the file

getPMMLModel

public static PMMLModel getPMMLModel(InputStream stream)
                              throws Exception

Read and return a PMML model.

Parameters:

stream - the InputStream to read from

Returns:

a PMML model

Throws:

Exception - if there is a problem while reading from the stream

getPMMLModel

public static PMMLModel getPMMLModel(String filename,
                                     Logger log)
                              throws Exception

Read and return a PMML model.

Parameters:

filename - the name of the file to read from

log - the logging object to use (or null if none is to be used)

Returns:

a PMML model

Throws:

Exception - if there is a problem while reading the file

getPMMLModel

public static PMMLModel getPMMLModel(File file,
                                     Logger log)
                              throws Exception

Read and return a PMML model.

Parameters:

file - a File to read from

log - the logging object to use (or null if none is to be used)

Returns:

a PMML model

Throws:

Exception - if there is a problem while reading the file

getPMMLModel

public static PMMLModel getPMMLModel(InputStream stream,
                                     Logger log)
                              throws Exception

Read and return a PMML model.

Parameters:

stream - the InputStream to read from

log - the logging object to use (or null if none is to be used)

Throws:

Exception - if there is a problem while reading from the stream

getTransformationDictionary

protected static weka.core.pmml.TransformationDictionary getTransformationDictionary(Document doc,
                                                                                     Instances dataDictionary)
                                                                              throws Exception

Get the transformation dictionary (if there is one).

Parameters:

doc - the Document containing the PMML model

dataDictionary - the data dictionary as an Instances object

Returns:

the transformation dictionary or null if there is none defined in the Document

Throws:

Exception - if there is a problem getting the transformation dictionary

serializePMMLModel

public static void serializePMMLModel(PMMLModel model,
                                      String filename)
                               throws Exception

Serialize a PMMLModel object that encapsulates a PMML model

Parameters:

model - the PMMLModel to serialize

filename - the name of the file to save to

Throws:

Exception - if something goes wrong during serialization

serializePMMLModel

public static void serializePMMLModel(PMMLModel model,
                                      File file)
                               throws Exception

Serialize a PMMLModel object that encapsulates a PMML model

Parameters:

model - the PMMLModel to serialize

file - the File to save to

Throws:

Exception - if something goes wrong during serialization

serializePMMLModel

public static void serializePMMLModel(PMMLModel model,
                                      OutputStream stream)
                               throws Exception

Serialize a PMMLModel object that encapsulates a PMML model

Parameters:

model - the PMMLModel to serialize

stream - the OutputStream to serialize to

Throws:

Exception - if something goes wrong during serialization

getModelInstance

protected static PMMLModel getModelInstance(Document doc,
                                            PMMLFactory.ModelType modelType,
                                            Element model,
                                            Instances dataDictionary,
                                            MiningSchema miningSchema)
                                     throws Exception

Get an instance of a PMMLModel from the supplied Document

Parameters:

doc - the Document holding the pmml

modelType - the type of model

model - the Element encapsulating the model part of the Document

dataDictionary - the data dictionary as an Instances object

miningSchema - the mining schema

Returns:

a PMMLModel object

Throws:

Exception - if there is a problem constructing the model or if the model type is not supported

getModelType

protected static PMMLFactory.ModelType getModelType(Document doc)

Get the type of model

Parameters:

doc - the Document encapsulating the pmml

Returns:

the type of model

getModelElement

protected static Element getModelElement(Document doc,
                                         PMMLFactory.ModelType modelType)
                                  throws Exception

Get the Element that contains the pmml model

Parameters:

doc - the Document encapsulating the pmml

modelType - the type of model

Throws:

Exception - if the model type is unsupported/unknown

getMiningSchemaAsInstances

protected static Instances getMiningSchemaAsInstances(Element model,
                                                      Instances dataDictionary)
                                               throws Exception

Deprecated. Use the MiningSchema class instead

Get the mining schema as an Instances object

Parameters:

model - the Element containing the pmml model

dataDictionary - the data dictionary as an Instances object

Returns:

the mining schema as an Instances object

Throws:

Exception - if something goes wrong during reading the mining schema

getDataDictionaryAsInstances

protected static Instances getDataDictionaryAsInstances(Document doc)
                                                 throws Exception

Get the data dictionary as an Instances object

Parameters:

doc - the Document encapsulating the pmml

Returns:

the data dictionary as an Instances object

Throws:

Exception - if there are fields that are not continuous, ordinal or categorical in the data dictionary

applyClassifier

public static String applyClassifier(PMMLModel model,
                                     Instances test)
                              throws Exception

Throws:

Exception

main

public static void main(String[] args)