ProgramDb Class Reference

#include <xmipp_program_sql.h>

Inheritance diagram for ProgramDb:

Collaboration diagram for ProgramDb:

Public Member Functions
void	init (const FileName &dbName)
	ProgramDb ()
	ProgramDb (const FileName &dbName)
virtual	~ProgramDb ()
bool	execStmt (const String &stmt, const String &error="")
bool	beginTrans ()
bool	commitTrans ()
bool	createProgramTables ()
bool	insertProgram (DictDB &program)
String	getLabelComment (const MDLabel &label)
virtual void	printProgram (const ProgramDef &program, int v=0)
virtual void	printSection (const SectionDef &section, int v=0)
virtual void	printParam (const ParamDef &param, int v=0)
virtual void	printArgument (const ArgumentDef &argument, int v=0)
virtual void	printCommentList (const CommentList &comments, int v=0)
Public Member Functions inherited from Printer
virtual	~Printer ()
virtual void	printToken (ArgToken *token)

Detailed Description

Class that will encapsulate the Xmipp objects representation on Sqlite db. Program are a kind of this objects. Programas db storing will be useful for handle meta-info.

Definition at line 45 of file xmipp_program_sql.h.

Constructor & Destructor Documentation

ProgramDb() [1/2]

ProgramDb::ProgramDb

(

)

Empty constructor

Definition at line 44 of file xmipp_program_sql.cpp.

{
  init(formatString("%s/.xmipp_programs.sqlite", getXmippPath()));
}

ProgramDb() [2/2]

ProgramDb::ProgramDb

(

const FileName &

dbName

)

Constructor, it will create the Sqlite db.

Definition at line 39 of file xmipp_program_sql.cpp.

{
    init(dbName);
}

~ProgramDb()

virtual ProgramDb::~ProgramDb ( )

inlinevirtual

Destructor

Definition at line 61 of file xmipp_program_sql.h.

{}

Member Function Documentation

beginTrans()

bool ProgramDb::beginTrans

(

)

Definition at line 59 of file xmipp_program_sql.cpp.

{
    return execStmt("BEGIN TRANSACTION", "Couldn't begin transaction:  ");
}

commitTrans()

bool ProgramDb::commitTrans

(

)

Definition at line 64 of file xmipp_program_sql.cpp.

{
    return execStmt("COMMIT TRANSACTION", "Couldn't commit transaction:  ");
}

createProgramTables()

bool ProgramDb::createProgramTables

(

)

Create tables related with programs

Definition at line 70 of file xmipp_program_sql.cpp.

{
    const char * cmdStr =
        "DROP TABLE IF EXISTS Category;"
        "CREATE TABLE Category ("
        "   id INTEGER PRIMARY KEY ASC AUTOINCREMENT, "
        "   name TEXT UNIQUE, "
        "   desc TEXT, "
        "   prefixes TEXT);"
        "INSERT INTO Category VALUES(NULL, 'Classification', NULL, 'classify_ ml_ mlf_');"
        "INSERT INTO Category VALUES(NULL, 'CTF', NULL, 'ctf_');"
        "INSERT INTO Category VALUES(NULL, 'Images', NULL, 'image_');"
        "INSERT INTO Category VALUES(NULL, 'Metadatas', NULL, 'metadata_');"
        "INSERT INTO Category VALUES(NULL, 'Phantoms', NULL, 'phantom_ pdb_');"
        "INSERT INTO Category VALUES(NULL, 'Angular assignment', NULL, 'angular_');"
        "INSERT INTO Category VALUES(NULL, 'Tomography', NULL, 'tomo_ xray_');"
        "INSERT INTO Category VALUES(NULL, 'Transformations', NULL, 'transform_');"
        "INSERT INTO Category VALUES(NULL, 'Volumes', NULL, 'volume_ reconstruct_ resolution_');"
        "DROP TABLE IF EXISTS Program;"
        "CREATE TABLE Program ("
        "id INTEGER PRIMARY KEY ASC AUTOINCREMENT,"
        "category_id INTEGER, name TEXT UNIQUE, usage TEXT, examples TEXT,"
        "keywords TEXT);";

    return execStmt(cmdStr, "Couldn't create Program table:  ");
}

execStmt()

bool ProgramDb::execStmt	(	const String &	stmt,
		const String &	error = ""
	)

Begin and end transaction

Definition at line 49 of file xmipp_program_sql.cpp.

{
    if (sqlite3_exec(db, stmt.c_str(), NULL, NULL, &errmsg) != SQLITE_OK)
    {
        std::cerr << error << ":  " << errmsg << std::endl;
        return false;
    }
    return true;
}

getLabelComment()

String ProgramDb::getLabelComment

(

const MDLabel &

label

)

Get from the db the comment for a label

Select programs from db Update program data, id must be valid

Definition at line 162 of file xmipp_program_sql.cpp.

{
      sqlite3_stmt *stmt;
      String aux = MDL::label2Str(label);
      String cmd = formatString("SELECT * FROM Label WHERE name='%s';", aux.c_str());

      rc = sqlite3_prepare_v2(db, cmd.c_str(), -1, &stmt, NULL);

      if ((rc = sqlite3_step(stmt)) == SQLITE_ROW)
      {
          aux.assign((char*)sqlite3_column_text(stmt, 4));
      }
      rc = sqlite3_finalize(stmt);

      return aux;
}

init()

void ProgramDb::init

(

const FileName &

dbName

)

Some initialization

Definition at line 30 of file xmipp_program_sql.cpp.

{
  rc = sqlite3_open(dbName.c_str(), &db);
  sqlite3_exec(db, "PRAGMA temp_store=MEMORY",NULL, NULL, &errmsg);
  sqlite3_exec(db, "PRAGMA synchronous=OFF",NULL, NULL, &errmsg);
  sqlite3_exec(db, "PRAGMA count_changes=OFF",NULL, NULL, &errmsg);
  sqlite3_exec(db, "PRAGMA page_size=4092",NULL, NULL, &errmsg);
}

insertProgram()

bool ProgramDb::insertProgram

(

DictDB &

program

)

Insert a program into db, the id field will be filled

Insert program into db, the id field will be filled

Delete first the program if exist

Definition at line 110 of file xmipp_program_sql.cpp.

{
    //deleteProgramByName(program["name"]);
    std::stringstream ss;
    String &progName = escapeSqliteStr(program["name"]);
    ss
    << "DELETE FROM Program WHERE name=" << progName
    << ";INSERT INTO Program VALUES(NULL, NULL,"
    << progName << ","
    << escapeSqliteStr(program["usage"]) << ", "
    << escapeSqliteStr(program["examples"]) << ", "
    << escapeSqliteStr(program["keywords"]) << ");";
    bool result = execStmt(ss.str(), "Couldn't insert program");
    //program["id"] = sqlite3_last_insert_rowid(db);
    return result;
}

printArgument()

void ProgramDb::printArgument ( const ArgumentDef &  argument, int  v = 0  )

virtual

Implements Printer.

Definition at line 221 of file xmipp_program_sql.cpp.

{
}

printCommentList()

void ProgramDb::printCommentList ( const CommentList &  comments, int  v = 0  )

virtual

Implements Printer.

Definition at line 225 of file xmipp_program_sql.cpp.

{
}

printParam()

void ProgramDb::printParam ( const ParamDef &  param, int  v = 0  )

virtual

Implements Printer.

Definition at line 217 of file xmipp_program_sql.cpp.

{
}

printProgram()

void ProgramDb::printProgram ( const ProgramDef &  program, int  v = 0  )

virtual

Implements Printer.

Definition at line 180 of file xmipp_program_sql.cpp.

{
    //print program name and usage
    String usage, examples;
    DictDB dict;

    dict["name"] = program.name;
    dict["usage"] = "";
    dict["examples"] = "";
    dict["keywords"] = program.keywords;
    //print usage
    if (program.usageComments.size() > 0)
    {
        for (size_t i = 0; i < program.usageComments.size(); ++i)
          dict["usage"] += program.usageComments.comments[i] + '\n';
    }
    //print examples
    if (program.examples.size() > 0)
    {
        for (size_t i = 0; i < program.examples.size(); ++i)
          dict["examples"] += program.examples.comments[i] + '\n';
    }
    insertProgram(dict);
    //std::cerr << "DEBUG_JM: program.name: " << program.name << std::endl;

    //print sections and params
    if (program.sections.size() > 0)
    {
        for (size_t i = 0; i < program.sections.size(); ++i)
            printSection(*program.sections[i], v);
    }
}

printSection()

void ProgramDb::printSection ( const SectionDef &  section, int  v = 0  )

virtual

Implements Printer.

Definition at line 213 of file xmipp_program_sql.cpp.

{
}

---

The documentation for this class was generated from the following files:

• xmippCore/core/xmipp_program_sql.h
• xmippCore/core/xmipp_program_sql.cpp