Main | License | Installation | FAQ | Screenshots | Contact | Links | Sf.net | Freshmeat.net | KDE-Apps.org

CookBook Class Reference

#include <cookBook.hpp>

Inheritance diagram for CookBook:

[legend]

Public Member Functions
	CookBook (DatabasePtr _database, const std::string &inputXSLFileName, const std::string &outputXSLFileName, bool performVersionCheck=true) throw (Error)
CompilerPtr	getXMLLayer (void) const
DatabasePtr	getDatabase (void) const
int	getVersion (void) const throw (Error)
	Query database version.
void	update (void) throw (Error)
	Update database version.
Static Protected Member Functions
static CompilerPtr	createXMLLayer (DatabasePtr _database, const std::string &inputXSLFileName, const std::string &outputXSLFileName)
Protected Attributes
DatabasePtr	database
	Database.
CompilerPtr	xmlLayer
	Compiler-chain.

---

Detailed Description

Specialized database class for accessing cookbook database. This class encapsulates the knowledge about the special structure of the cookbook database.

Todo:

Porting of old databases using a wizard.

Use transactions.

Date:

Thu Mar 10 2005

Author:

Jan Wedekind (wedesoft@users.sourceforge.net)

Definition at line 31 of file cookBook.hpp.

---

Constructor & Destructor Documentation

CookBook::CookBook	(	DatabasePtr	_database,
		const std::string &	inputXSLFileName,
		const std::string &	outputXSLFileName,
		bool	performVersionCheck = true
	)			throw (Error)

Constructor.

Parameters:

	_database	Database holding the recipes.
	inputXSLFileName	Filename of XSL-script translating XML-queries to the SQL-dialec of the database.
	outputXSLFileName	Filename of XSL-script adapting the structure of the output generated by the XSU-utility.
	performVersionCheck	This boolean has to be set to false, if the database is empty (no tables have been created yet).

See also:

XSU

XSLCompiler

---

Member Function Documentation

CompilerPtr CookBook::getXMLLayer

(

void

)

const [inline]

Get compiler-chain for accessing database. The returned compiler-chain is an XSU-utility with two XSL-scripts for pre- and postprocessing. The XSL-scripts are providing an abstraction- layer to hide the SQL-dialect of the database.

The following picture illustrates, how the compiler-chain is being used to extract a recipe for example:

Example for using compiler-chain

Returns:

Compiler-chain for accessing database.

Definition at line 57 of file cookBook.hpp.

References xmlLayer.

{ return xmlLayer; }

DatabasePtr CookBook::getDatabase

(

void

)

const [inline]

Get direct access to database.

See also:

Database

Definition at line 60 of file cookBook.hpp.

References database.

{ return database; }

int CookBook::getVersion

(

void

)

const throw (Error)

Query database version.

Definition at line 56 of file cookBook.cpp.

References XMLDocument::fromString(), XMLDocument::getDocumentElement(), and xmlLayer.

Referenced by update().

{
  XMLDocument xmlDocument( "" );
  xmlDocument.fromString
    ( xmlLayer->translate
      ( "<?xml version='1.0' encoding='UTF-8'?><version/>" ) );
  int
    version = atoi( xmlDocument.getDocumentElement().selectNode( "version" ).
                    getNodeText().c_str() );
  return version;
}

void CookBook::update

(

void

)

throw (Error)

Update database version.

Definition at line 68 of file cookBook.cpp.

References ERRORMACRO, getVersion(), versionText(), and xmlLayer.

{
  // Read version number.
  int version = getVersion();
  
  // Check for minimum version requirement.
  ERRORMACRO( version >= 13, Error, ,
              i18n( "Update for database versions 0.1 to 0.12 is not "
                    "supported." ) );
  
  // Check against maximum version constraint.
  ERRORMACRO( version <= DATABASEVERSION, Error, ,
              i18n( "Recipe database is of version %1. This software can "
                    "only handle databases up to version %2. You need to "
                    "update AnyMeal to access this database." ).
              arg( versionText( version ) ).
              arg( versionText( DATABASEVERSION ) ) );

  // Update database.
  stringstream query;
  query << "<?xml version='1.0' encoding='UTF-8'?>" << endl
        << "<update><version>" << version << "</version></update>"
        << endl;
  ofstream nullDevice( "/dev/null" );
  xmlLayer->translate( query, nullDevice );
}

static CompilerPtr CookBook::createXMLLayer	(	DatabasePtr	_database,
		const std::string &	inputXSLFileName,
		const std::string &	outputXSLFileName
	)			[static, protected]

---

Field Documentation

DatabasePtr CookBook::database [protected]

Database.

Definition at line 71 of file cookBook.hpp.

Referenced by getDatabase().

CompilerPtr CookBook::xmlLayer [protected]

Compiler-chain.

Definition at line 73 of file cookBook.hpp.

Referenced by getVersion(), getXMLLayer(), and update().

---

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

• cookBook.hpp
• cookBook.cpp

---