General methods

Functions
PMMLLIB_EXPORT	PMMLlib::PMMLlib::PMMLlib (std::string file, bool log=false)
PMMLLIB_EXPORT	PMMLlib::PMMLlib::PMMLlib (bool log=false)
	This constructor is mandatory for Swig because it can be used with no parameters. More...
PMMLLIB_EXPORT	PMMLlib::PMMLlib::~PMMLlib ()
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::SetCurrentModel (std::string modelName, PMMLType type)
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::SetCurrentModel (std::string modelName)
	Throw an exception if there is no model or more than one model with name "modelName" in the PMML file. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::SetCurrentModel ()
	Throw an exception if no model is found or if there are more than one model in the PMLL file. More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::makeLog () const
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::printLog () const
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddDataField (std::string name, std::string displayName, std::string optype, std::string dataType, std::string closure, double leftMargin, double rightMargin, bool interval=false)
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::AddMiningSchema (std::string name, std::string usageType)
	Common to all models. More...
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::SetHeader (std::string copyright, std::string description, std::string appName, std::string appVersion, std::string annotation)
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::UnlinkNode ()
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::BackupNode ()
PMMLLIB_EXPORT int	PMMLlib::PMMLlib::GetModelsNb ()
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::Write ()
PMMLLIB_EXPORT void	PMMLlib::PMMLlib::Write (std::string file)
PMMLLIB_EXPORT PMMLType	PMMLlib::PMMLlib::GetCurrentModelType ()
	type is kUNDEFINED if no model is set or if model type is not handled More...
PMMLLIB_EXPORT std::string	PMMLlib::PMMLlib::GetCurrentModelName ()
	name is "" if no model is set More...
xmlNodePtr	PMMLlib::PMMLlib::GetChildByName (xmlNodePtr node, std::string nodename)
xmlNodePtr	PMMLlib::PMMLlib::GetPtr (int ann_index, std::string name)
xmlNodePtr	PMMLlib::PMMLlib::GetPtr (std::string ann_name, std::string name)
void	PMMLlib::PMMLlib::CountModels ()
int	PMMLlib::PMMLlib::CountNeuralNetModels ()
int	PMMLlib::PMMLlib::CountRegressionModels ()
void	PMMLlib::PMMLlib::SetRootNode ()
std::string	PMMLlib::PMMLlib::GetModelName (xmlNodePtr node)
std::string	PMMLlib::PMMLlib::GetTypeString ()

Detailed Description

Common methods to all kinds of PMML files and models

Function Documentation

AddDataField()

void PMMLlib::PMMLlib::AddDataField	(	std::string	fieldName,
		std::string	displayName,
		std::string	optype,
		std::string	dataType,
		std::string	closure,
		double	leftMargin,
		double	rightMargin,
		bool	interval = false
	)

Add a DataField node to the DataDictionnary node

Parameters

fieldName	Value of property "name"
displayName	Value of property "displayName"
optype	Value of property "optype"
dataType	Value of property "dataType"
closure	Value of property "closure" in node Interval
leftMargin	Value of property "leftMargin" in node Interval
rightMargin	Value of property "rightMargin" in node Interval
interval	Flag to add a node Interval (if true)

Definition at line 1317 of file PMMLlib.cxx.

{
    // if 'DataDictionary' node does not exist, create it
    xmlNodePtr dataDictNode = GetChildByName(_rootNode, "DataDictionary");
    if(!dataDictNode)
    {
        dataDictNode = xmlNewChild(_rootNode, 0, (const xmlChar*)"DataDictionary", 0);
    }
 
    // then append the node
    xmlNodePtr dataFieldNode = xmlNewChild(dataDictNode, 0, (const xmlChar*)"DataField", 0);
    xmlNewProp(dataFieldNode, (const xmlChar*)"name", (const xmlChar*)(fieldName.c_str()) );
    xmlNewProp(dataFieldNode, (const xmlChar*)"displayName", (const xmlChar*)(displayName.c_str()) );
    xmlNewProp(dataFieldNode, (const xmlChar*)"optype", (const xmlChar*)(optype.c_str()) );
    xmlNewProp(dataFieldNode, (const xmlChar*)"dataType", (const xmlChar*)(dataType.c_str()) );
 
    if ( interval ) 
    {
        xmlNodePtr intervalNode = xmlNewChild(dataFieldNode, 0, (const xmlChar*)"Interval", 0);
        xmlNewProp(intervalNode, (const xmlChar*)"closure", (const xmlChar*)(closure.c_str()) );
        stringstream ss;
        ss << scientific << leftMargin;
        xmlNewProp(intervalNode, (const xmlChar*)"leftMargin", (const xmlChar*)(ss.str().c_str()) );
        ss.str("");
        ss << scientific << rightMargin;
        xmlNewProp(intervalNode, (const xmlChar*)"rightMargin", (const xmlChar*)(ss.str().c_str()) );
    }
}

AddMiningSchema()

void PMMLlib::PMMLlib::AddMiningSchema	(	std::string	name,
		std::string	usageType
	)

Common to all models.

Add the MiningSchema node.

Parameters

name	Value of property "name".
usageType	Value of property "usageType".

Definition at line 286 of file PMMLlib.cxx.

{
    xmlNodePtr netNode = _currentModelNode; 
 
    // if 'MiningSchema' node does not exist, create it
    xmlNodePtr miningSchemaNode = GetChildByName(netNode, "MiningSchema");
    if(!miningSchemaNode)
    {
        miningSchemaNode = xmlNewChild(netNode, 0, (const xmlChar*)"MiningSchema", 0);
    }
 
    // then append the node
    xmlNodePtr miningFieldNode = xmlNewChild(miningSchemaNode, 0, (const xmlChar*)"MiningField", 0);
    xmlNewProp(miningFieldNode, (const xmlChar*)"name", (const xmlChar*)(name.c_str()) );
    xmlNewProp(miningFieldNode, (const xmlChar*)"usageType", (const xmlChar*)(usageType.c_str()) );
}

BackupNode()

void PMMLlib::PMMLlib::BackupNode

(

)

Make a backup of the current model node.

Definition at line 535 of file PMMLlib.cxx.

{
    // Node name depending of PMML type
    string name = GetTypeString();
    // Find the last save index number
    int nCrtIndex = 0;
    stringstream ss;
    ss << _currentModelName << "_" << nCrtIndex;
    xmlNodePtr ptr = GetPtr(ss.str(), name);
    while( ptr )
    {
        nCrtIndex++;
        if (_log)
            cout << " ** nCrtIndex[" << nCrtIndex << "]" << endl;
 
        ss.str("");
        ss << _currentModelName << "_" << nCrtIndex;
        ptr = GetPtr(ss.str(), name);
    }
    if(_log)
        cout << " *** Node \"" << _currentModelName << "\" found, then backup it with index [" << nCrtIndex << "]" << endl;
    // Rename model
    xmlUnsetProp(_currentModelNode, (const xmlChar*)"modelName");
    xmlNewProp(_currentModelNode, (const xmlChar*)"modelName", (const xmlChar*)(ss.str().c_str()));
}

CountModels()

void PMMLlib::PMMLlib::CountModels ( )

private

Count the tags of all types of models (NeuralNetwork and RegressionModel).

Returns

Number of models

Definition at line 341 of file PMMLlib.cxx.

{
    int nCount = 0;
    nCount = CountNeuralNetModels() + CountRegressionModels();
    if ( _log)
        cout << " ** End Of Count Models nCount[" << nCount << "]" << endl;
    _nbModels = nCount ; 
}

CountNeuralNetModels()

int PMMLlib::PMMLlib::CountNeuralNetModels ( )

private

Count NeuralNetwork models tags in the PMML file.

Returns

Number of models

Definition at line 354 of file PMMLlib.cxx.

{
    int nCount = 0;
    xmlNodePtr ptr = GetChildByName(_rootNode,"NeuralNetwork");  
    // Count the models
    while (ptr != NULL && _xmlCharToString(ptr->name) == "NeuralNetwork")
    {
        nCount++;
        if (_log)
            cout << " ** nCount[" << nCount << "]" << endl;
        ptr = ptr->next;
    }   
    if ( _log)
        cout << " ** End Of CountNetworks nCount[" << nCount << "]" << endl;    
    return nCount;
}

CountRegressionModels()

int PMMLlib::PMMLlib::CountRegressionModels ( )

private

Count RegressionModel models tags in the PMML file.

Returns

Number of models

Definition at line 375 of file PMMLlib.cxx.

{
    int nCount = 0;
    xmlNodePtr ptr = GetChildByName(_rootNode,"RegressionModel");  
    // Count the models
    while (ptr != NULL && _xmlCharToString(ptr->name) == "RegressionModel")
    {
        nCount++;
        if (_log)
            cout << " ** nCount[" << nCount << "]" << endl;
        ptr = ptr->next;
    }   
    if ( _log)
        cout << " ** End Of CountRegressions nCount[" << nCount << "]" << endl;    
    return nCount;
}

GetChildByName()

xmlNodePtr PMMLlib::PMMLlib::GetChildByName ( xmlNodePtr  node, std::string  nodeName  )

private

Get the child of a node from the name of this node

Parameters

node	Start node for the research
nodeName	Name of the node to find

Returns

Pointer to the node found

Definition at line 310 of file PMMLlib.cxx.

{
    if ( node == NULL )
        return node;
    
    xmlNodePtr childNode = node->children;
    if ( childNode == NULL )   
        return childNode;
    
    const xmlChar* name = childNode->name;
    string strName("");  
    if ( name != NULL )
        strName =  _xmlCharToString(name);        
    
    while( (childNode != NULL) && (strName != nodeName) )
    {
      childNode = childNode->next;
      if ( childNode == NULL )
          return childNode;
      name = childNode->name; 
      if ( name != NULL )
          strName =  _xmlCharToString(name);        
    }
    return childNode;
}

GetCurrentModelName()

std::string PMMLlib::PMMLlib::GetCurrentModelName

(

)

name is "" if no model is set

Get the current model name.

Returns

the type

Definition at line 514 of file PMMLlib.cxx.

{
    if ( ! _currentModelNode )
        return string("");
    string name = _getProp(_currentModelNode, string("modelName"));
    return name;  
}

GetCurrentModelType()

PMMLType PMMLlib::PMMLlib::GetCurrentModelType

(

)

type is kUNDEFINED if no model is set or if model type is not handled

Get the current model type.

Returns

the type

Definition at line 496 of file PMMLlib.cxx.

{
    PMMLType type = kUNDEFINED ; 
    if ( ! _currentModelNode )
        return type;
    string name = _xmlCharToString(_currentModelNode->name);
    if ( name == "NeuralNetwork" )
        type = kANN;
    else if ( name == "RegressionModel" )
        type = kLR;
    return type;
}

References PMMLlib::kANN, PMMLlib::kLR, and PMMLlib::kUNDEFINED.

GetModelName()

std::string PMMLlib::PMMLlib::GetModelName ( xmlNodePtr  node )

private

Get the name of the XML node of a given model

Parameters

node	Model node

Returns

value of attribute "modelName" of the model node

Definition at line 406 of file PMMLlib.cxx.

{
    string name("");
    name = _getProp(node, string("modelName") );
    return name;
}

GetModelsNb()

int PMMLlib::PMMLlib::GetModelsNb

(

)

Get the number of models

Returns

Number of models

Definition at line 396 of file PMMLlib.cxx.

{
    return _nbModels;
}

GetPtr() [1/2]

xmlNodePtr PMMLlib::PMMLlib::GetPtr ( int  index, std::string  name  )

private

Get a pointer to the index-th node named name

Parameters

index	Index of the node to search
name	Name of the node

Returns

Pointer to the node found

Definition at line 419 of file PMMLlib.cxx.

{
    xmlNodePtr node = NULL;
 
    if (_doc != NULL)
    {
        _rootNode = xmlDocGetRootElement(_doc);
        node = GetChildByName(_rootNode, name);
 
        int i=0;
        while ((i != index) && (node != NULL))
        {
            node = node->next;
            i++;
        }
    }
    return node;
}

References yacsorb.CORBAEngineTest::i.

GetPtr() [2/2]

xmlNodePtr PMMLlib::PMMLlib::GetPtr ( std::string  myModelName, std::string  nodeName  )

private

Get a pointer to the node named name whose 'modelName' attribute is ann_name

Parameters

modelName	Model name of the node to search
nodeName	Name of the node

Returns

Pointer to the node found

Definition at line 445 of file PMMLlib.cxx.

{
    xmlNodePtr node = NULL;
    if (_doc != NULL)
    {
        node = GetChildByName(_rootNode, nodeName);
        if( node )
        {
            string modelName = _getProp(node, string("modelName"));
 
            while ( (node != NULL) && modelName != myModelName )
            {
                node = node->next;
                if( node )
                {
                    modelName = _getProp(node, string("modelName"));
                }
            }
        }
    }
    return node;
}

GetTypeString()

std::string PMMLlib::PMMLlib::GetTypeString ( )

private

Get the tag of the current model.

Returns

Current model tag

Definition at line 473 of file PMMLlib.cxx.

{
    string name = "";
    switch(_currentModelType)
    {
    case kANN:
        name = "NeuralNetwork";
        break;
    case kLR:
        name = "RegressionModel";
        break;
    default:
        throw string("Unknown PMML type.");
        break;
    }
    return name;
}

References PMMLlib::kANN, and PMMLlib::kLR.

makeLog()

std::string PMMLlib::PMMLlib::makeLog

(

)

const

Make the string used by PMMLlib::printLog.

Returns

The log

Definition at line 213 of file PMMLlib.cxx.

{
    ostringstream out;
    out << "**\n**** Display of PMMLlib ****" << endl;
    out << " **  _pmmlFile[" << _pmmlFile << "]" << endl;
    out << " **  _log[" << (_log?1:0) << "]" << endl;
    out << "**\n**** End of display of PMMLlib ****" << endl;
    return out.str(); 
}

PMMLlib() [1/2]

PMMLlib::PMMLlib::PMMLlib

(

bool

log = false

)

This constructor is mandatory for Swig because it can be used with no parameters.

Constructor to create a PMML file.

Parameters

log	Flag to print logs or not

Definition at line 94 of file PMMLlib.cxx.

                        :
            _log(log),
            _pmmlFile(""),
            _doc(NULL),
            _rootNode(NULL),
            _currentNode(NULL),
            _nbModels(0),
            _currentModelName(""),
            _currentModelType(kUNDEFINED)           
{
    SetRootNode();
}

PMMLlib() [2/2]

PMMLlib::PMMLlib::PMMLlib	(	std::string	file,
		bool	log = false
	)

Constructor to read a PMML file.

Parameters

file	Name of the PMML file to read
log	Flag to print logs or not

Definition at line 57 of file PMMLlib.cxx.

                                        : 
            _log(log),
            _pmmlFile(file),
            _doc(NULL),
            _rootNode(NULL),
            _currentNode(NULL),
            _nbModels(0),
            _currentModelName(""),
            _currentModelType(kUNDEFINED)   
{
    try
    {
        xmlKeepBlanksDefault(0);
        xmlInitParser();
        _doc = xmlParseFile(_pmmlFile.c_str());         
        if ( _doc != NULL )
        {
            _rootNode = xmlDocGetRootElement(_doc);
            CountModels(); 
        }
        else 
            throw string("Unable to read PMML file.");
    }
    catch ( std::string msg )
    {
        std::cerr << msg;
        xmlFreeDoc(_doc);
        xmlCleanupParser();  
        throw;
    }
}

printLog()

void PMMLlib::PMMLlib::printLog

(

)

const

Print some information about the current PMML object.

Definition at line 226 of file PMMLlib.cxx.

{
    string log = makeLog();
    cout << log << endl;
}

References gui.logview::log.

SetCurrentModel() [1/3]

void PMMLlib::PMMLlib::SetCurrentModel

(

)

Throw an exception if no model is found or if there are more than one model in the PMLL file.

Set the current model and its type.

Definition at line 183 of file PMMLlib.cxx.

{
    int nC = _nbModels;
    if ( nC != 1 ) 
    {
        std::ostringstream oss;
        oss << nC;
        string msg = "SetCurrentModel() : found " + oss.str() + " model(s) in PMML file.\n";
        msg += "Use SetCurrentModel(modelName) or SetCurrentModel(modelName,type).";
        throw msg;
    }   
    _currentModelNode = GetChildByName(_rootNode,"NeuralNetwork"); 
    _currentModelType = kANN;  
    if (_currentModelNode == NULL)
    {
        _currentModelNode = GetChildByName(_rootNode,"RegressionModel"); 
        _currentModelType = kLR;
    }
    if (_currentModelNode == NULL)
    {
        string msg("Couldn't get node in SetCurrentModel().");
        throw msg;      
    }
    _currentModelName = _getProp(_currentModelNode, string("modelName"));
}

References PMMLlib::kANN, and PMMLlib::kLR.

SetCurrentModel() [2/3]

void PMMLlib::PMMLlib::SetCurrentModel

(

std::string

modelName

)

Throw an exception if there is no model or more than one model with name "modelName" in the PMML file.

Set the current model and its type.

Parameters

modelName

Name of the model to load (ie content of 'modelName' attribute)

Definition at line 150 of file PMMLlib.cxx.

{
    if (_rootNode == NULL)
        throw string("No PMML file set.");
    xmlNodePtr node = NULL;
    int nC = 0;
    node = _rootNode->children;
    while (node)
    {         
        string nodeModelName = _getProp(node, string("modelName"));
        if ( nodeModelName == modelName )
        {
            nC++;
            _currentModelNode = node;
            _currentModelName = modelName;
            _currentModelType = GetCurrentModelType();
        }
        node = node->next;
    }
    if ( nC != 1 ) 
    {
        std::ostringstream oss;
        oss << nC;
        string msg = "SetCurrentModel(modelName) : found " + oss.str() + " model(s) in PMML file.\n";
        msg += "Use SetCurrentModel(modelName,type).";
        throw msg;
    }   
}

SetCurrentModel() [3/3]

void PMMLlib::PMMLlib::SetCurrentModel	(	std::string	modelName,
		PMMLType	type
	)

Set the current model and its type.

Parameters

modelName	Name of the model to load (ie content of 'modelName' attribute)
type	Type of PMML to read: one of kANN or kLR

Definition at line 124 of file PMMLlib.cxx.

{
    _currentModelName = modelName;
    _currentModelType = type;
    switch(type)
    {
        case kANN:
            _currentModelNode = GetNeuralNetPtr(modelName);
            break;
        case kLR:
            _currentModelNode = GetRegressionPtr(modelName);
            break;
        default:
            throw string("Unknown PMML type.");
            break;
    } 
    if ( _currentModelNode == NULL )
        throw string("Model not found.");
}

References PMMLlib::kANN, and PMMLlib::kLR.

SetHeader()

void PMMLlib::PMMLlib::SetHeader	(	std::string	copyright,
		std::string	description,
		std::string	appName,
		std::string	appVersion,
		std::string	annotation
	)

Set the header node in the tree.

Parameters

copyright	Copyright of the PMML file
description	Description of the model
appName	Name of the application that produced the file
appVersion	Version of the application that produced the file
annotation	Some annotation

Definition at line 263 of file PMMLlib.cxx.

{
    xmlNodePtr headerNode = xmlNewChild(_rootNode, 0, (const xmlChar*)"Header", 0);
    xmlNewProp(headerNode, (const xmlChar*)"copyright", (const xmlChar*)(copyright.c_str()));
    xmlNewProp(headerNode, (const xmlChar*)"description", (const xmlChar*)(description.c_str()));
 
    xmlNodePtr appNode = xmlNewChild(headerNode, 0, (const xmlChar*)"Application", 0);
    xmlNewProp(appNode, (const xmlChar*)"name", (const xmlChar*)(appName.c_str()));
    xmlNewProp(appNode, (const xmlChar*)"version", (const xmlChar*)(appVersion.c_str()));
 
    xmlNewChild(headerNode, 0, (const xmlChar*)"Annotation", (const xmlChar*)(annotation.c_str()));
}

SetRootNode()

void PMMLlib::PMMLlib::SetRootNode ( )

private

Set the root node in the tree:

<PMML version="4.1" xmlns="http://www.dmg.org/PMML-4_1">

Definition at line 238 of file PMMLlib.cxx.

{ 
    xmlChar * xs = _stringToXmlChar("1.0");
    _doc = xmlNewDoc(xs);
    xmlFree(xs);
    
    xmlChar *xp = _stringToXmlChar("PMML");
    _rootNode = xmlNewNode(0, xp);
    xmlFree(xp);
    
    xmlNewProp(_rootNode, (const xmlChar*)"xmlns", (const xmlChar*)"http://www.dmg.org/PMML-4_1");
    xmlNewProp(_rootNode, (const xmlChar*)"version", (const xmlChar*)"4.1");
    
    xmlDocSetRootElement(_doc, _rootNode);
}

UnlinkNode()

void PMMLlib::PMMLlib::UnlinkNode

(

)

Unlink the current model node.

Definition at line 525 of file PMMLlib.cxx.

{
    xmlNodePtr ptr = _currentModelNode ;
    xmlUnlinkNode( ptr );
    xmlFreeNode( ptr );
}

Write() [1/2]

void PMMLlib::PMMLlib::Write

(

)

Save the XML tree in the PMML file

Definition at line 564 of file PMMLlib.cxx.

{
    // Enregistrement de l'arbre DOM dans le fichier pmml
    Write(_pmmlFile);
    // Mise à jour du nombre de modèles
    CountModels();
}

Write() [2/2]

void PMMLlib::PMMLlib::Write

(

std::string

file

)

Save the XML tree in a given file

Parameters

Name	of the file

Definition at line 576 of file PMMLlib.cxx.

{
    // Enregistrement de l'arbre DOM sous forme de fichier pmml
    int ret = xmlSaveFormatFile( file.c_str(), _doc, 1);
    if ( ret == -1 )
    {
        std::string msg("  *** Error :: unable to write the PMML file \"" + file + "\"") ; 
        cout << msg << endl;
        throw msg;
    } 
    if ( _log )
        cout << "  *** Write the PMML file \"" << file <<"\"" << endl;
}

~PMMLlib()

PMMLlib::PMMLlib::~PMMLlib

(

)

Destructor of the class.

Definition at line 110 of file PMMLlib.cxx.

{
    if (_doc)
        xmlFreeDoc(_doc);
    xmlCleanupParser();
    if ( _log )
        cout << "~PMMLlib" << endl;
}