WocProcessor Class Reference

central processing singleton More...

#include <processor.h>

Inheritance diagram for WocProcessor:

Public Types
enum	MessageEncoding { WobEncoding =0, Soap12Encoding =1, SoapEncoding =1, DefaultEncoding =-1 }
	describes the way message are encoded in transport More...
enum	AuthMode { NoAuth =0, SessionAuth =1, BasicAuth =2, UnknownAuth =-1 }
	describes the authentication mode of the project More...

Public Slots
void	errorFound ()

Signals
void	sfinalize ()
void	newClass (const WocClass &)
void	newTable (const WocTable &)
void	newTransaction (const WocTransaction &)

Public Member Functions
	WocProcessor ()
bool	processFile (QString)
	called from main loop to parse a file More...
void	finalize ()
	called from main loop to finalize its work More...
QString	baseDir () const
	returns the base directory of the project (all other pathes are relative to it) More...
QString	wobDir () const
	returns the directory where WOLFs are found, should normally not be used outside this class More...
QString	projectName () const
	returns the project name (default="WobProject") More...
QString	verComm () const
	returns the current communication protocol version More...
QString	verNeedComm () const
	returns the communication protocol version that is at least needed to be compatible More...
QString	verHR () const
	returns a human readable version string More...
QMap< QString, QString >	versionInfo () const
	returns version information about the project More...
QString	dbInst () const
	returns the variable name that will contain the database driver instance More...
QString	dbSchema () const
	returns the variable name that will contain the database schema object More...
QString	dbVersion () const
	returns the database schema version More...
QString	dbConfigTable () const
	returns the config table name More...
QString	dbConfigKeyColumn () const
	returns the config key column More...
QString	dbConfigValueColumn () const
	returns the config value column More...
QString	dbVersionRow () const
	returns the row containing the DB version in the config table More...
QString	xmlProjectNamespace () const
	returns the XML namespace of the project More...
QString	xmlPackNamespace () const
	returns the XML namespace for Wob base elements More...
QString	xmlSoap12Namespace () const
	returns the XML namespace for SOAP 1.2 elements More...
QString	xmlSchemaNamespace () const
	returns the XML namespace for Schema itself More...
QString	xmlXmlNamespace () const
	returns the XML namespace for XML base elements More...
MessageEncoding	messageEncoding () const
	returns the message encoding mode More...
AuthMode	authMode () const
	returns the authentication mode More...
bool	hasTable (QString) const
	returns whether a table exists More...
WocTable	table (QString) const
	returns the requested table More...
bool	hasClass (QString) const
	returns whether a class exists More...
QStringList	transactionNames () const
	returns a list of transaction names More...
QStringList	classNames () const
	returns a list of class names More...
QStringList	tableNames () const
	returns a list of table names More...
QStringList	docStrings () const
	returns global docu More...
QStringList	privilegeNames () const
	returns the qualified names of all privileges More...
bool	dbUpdatingDefault () const
	returns the default for the database "updating" attribute More...

Static Public Member Functions
static WocProcessor *	instance ()
	returns the instance of the processor (if it exists yet) More...

Private Member Functions
bool	callSvn ()
	helper: calls SVN and parses its output More...
bool	callGit ()
	helper: calls GIT and parses its output More...
bool	callNoVer ()
	helper: fallback for version control check More...
void	parseNamespaces ()
	helper: looks up some schema files and finds the corresponding namespaces More...
AuthMode	str2AuthMode (QString)
	helper: converts Project/auth attribute to enum More...

Private Attributes
QString	m_baseDir
QString	m_wobDir
QString	m_verComm
QString	m_verNeedComm
QString	m_verHR
QString	m_projname
QString	m_verTarget
QString	m_svnExe
QString	m_gitExe
QMap< QString, QString >	m_verInfo
QStringList	m_verSys
QString	m_dbInst
QString	m_dbSchema
QString	m_dbVer
QString	m_dbConfigTable
QString	m_dbConfigKey
QString	m_dbConfigVal
QString	m_dbVersionRow
QString	m_xmlNS
QString	m_xmlPackNS
QString	m_xmlSoap12NS
QString	m_xmlSchemaNS
QString	m_xmlXmlNS
QStringList	m_docstrings
bool	m_error
bool	m_dbUpd
MessageEncoding	m_encmode
AuthMode	m_auth
QList< WocTable >	m_tables
QList< WocClass >	m_classes
QList< WocTransaction >	m_transactions

Static Private Attributes
static WocProcessor *	inst =0

Detailed Description

central processing singleton

Member Enumeration Documentation

enum WocProcessor::AuthMode

describes the authentication mode of the project

Enumerator
NoAuth	no authentication
SessionAuth	session ID authentication
BasicAuth	basic user/password authentication
UnknownAuth	helper value: unknown authentication type, signifies an error condition

enum WocProcessor::MessageEncoding

describes the way message are encoded in transport

Enumerator
WobEncoding	encode as standard WOB transactions
Soap12Encoding	encode as SOAP 1.2
SoapEncoding	encode according to the current SOAP standard
DefaultEncoding	helper value: used in some parts of the code to simply query the processor for the encoding, never used in the processor itself

Constructor & Destructor Documentation

WocProcessor::WocProcessor

(

)

Member Function Documentation

AuthMode WocProcessor::authMode ( ) const

inline

returns the authentication mode

QString WocProcessor::baseDir ( ) const

inline

returns the base directory of the project (all other pathes are relative to it)

bool WocProcessor::callGit ( )

private

helper: calls GIT and parses its output

bool WocProcessor::callNoVer ( )

private

helper: fallback for version control check

bool WocProcessor::callSvn ( )

private

helper: calls SVN and parses its output

QStringList WocProcessor::classNames

(

)

const

returns a list of class names

QString WocProcessor::dbConfigKeyColumn ( ) const

inline

returns the config key column

QString WocProcessor::dbConfigTable ( ) const

inline

returns the config table name

QString WocProcessor::dbConfigValueColumn ( ) const

inline

returns the config value column

QString WocProcessor::dbInst ( ) const

inline

returns the variable name that will contain the database driver instance

QString WocProcessor::dbSchema ( ) const

inline

returns the variable name that will contain the database schema object

bool WocProcessor::dbUpdatingDefault ( ) const

inline

returns the default for the database "updating" attribute

QString WocProcessor::dbVersion ( ) const

inline

returns the database schema version

QString WocProcessor::dbVersionRow ( ) const

inline

returns the row containing the DB version in the config table

QStringList WocProcessor::docStrings ( ) const

inline

returns global docu

void WocProcessor::errorFound ( )

slot

void WocProcessor::finalize

(

)

called from main loop to finalize its work

bool WocProcessor::hasClass

(

QString

n

)

const

returns whether a class exists

bool WocProcessor::hasTable

(

QString

n

)

const

returns whether a table exists

static WocProcessor* WocProcessor::instance ( )

inlinestatic

returns the instance of the processor (if it exists yet)

MessageEncoding WocProcessor::messageEncoding ( ) const

inline

returns the message encoding mode

void WocProcessor::newClass ( const WocClass &  )

signal

void WocProcessor::newTable ( const WocTable &  )

signal

void WocProcessor::newTransaction ( const WocTransaction &  )

signal

void WocProcessor::parseNamespaces ( )

private

helper: looks up some schema files and finds the corresponding namespaces

QStringList WocProcessor::privilegeNames

(

)

const

returns the qualified names of all privileges

bool WocProcessor::processFile

(

QString

fn

)

called from main loop to parse a file

QString WocProcessor::projectName ( ) const

inline

returns the project name (default="WobProject")

void WocProcessor::sfinalize ( )

signal

WocProcessor::AuthMode WocProcessor::str2AuthMode ( QString  s )

private

helper: converts Project/auth attribute to enum

WocTable WocProcessor::table

(

QString

n

)

const

returns the requested table

QStringList WocProcessor::tableNames

(

)

const

returns a list of table names

QStringList WocProcessor::transactionNames

(

)

const

returns a list of transaction names

QString WocProcessor::verComm ( ) const

inline

returns the current communication protocol version

QString WocProcessor::verHR ( ) const

inline

returns a human readable version string

QString WocProcessor::verNeedComm ( ) const

inline

returns the communication protocol version that is at least needed to be compatible

QMap<QString,QString> WocProcessor::versionInfo ( ) const

inline

returns version information about the project

QString WocProcessor::wobDir ( ) const

inline

returns the directory where WOLFs are found, should normally not be used outside this class

QString WocProcessor::xmlPackNamespace ( ) const

inline

returns the XML namespace for Wob base elements

QString WocProcessor::xmlProjectNamespace ( ) const

inline

returns the XML namespace of the project

QString WocProcessor::xmlSchemaNamespace ( ) const

inline

returns the XML namespace for Schema itself

QString WocProcessor::xmlSoap12Namespace ( ) const

inline

returns the XML namespace for SOAP 1.2 elements

QString WocProcessor::xmlXmlNamespace ( ) const

inline

returns the XML namespace for XML base elements

Member Data Documentation

WocProcessor * WocProcessor::inst =0

staticprivate

AuthMode WocProcessor::m_auth

private

QString WocProcessor::m_baseDir

private

QList<WocClass> WocProcessor::m_classes

private

QString WocProcessor::m_dbConfigKey

private

QString WocProcessor::m_dbConfigTable

private

QString WocProcessor::m_dbConfigVal

private

QString WocProcessor::m_dbInst

private

QString WocProcessor::m_dbSchema

private

bool WocProcessor::m_dbUpd

private

QString WocProcessor::m_dbVer

private

QString WocProcessor::m_dbVersionRow

private

QStringList WocProcessor::m_docstrings

private

MessageEncoding WocProcessor::m_encmode

private

bool WocProcessor::m_error

private

QString WocProcessor::m_gitExe

private

QString WocProcessor::m_projname

private

QString WocProcessor::m_svnExe

private

QList<WocTable> WocProcessor::m_tables

private

QList<WocTransaction> WocProcessor::m_transactions

private

QString WocProcessor::m_verComm

private

QString WocProcessor::m_verHR

private

QMap<QString,QString> WocProcessor::m_verInfo

private

QString WocProcessor::m_verNeedComm

private

QStringList WocProcessor::m_verSys

private

QString WocProcessor::m_verTarget

private

QString WocProcessor::m_wobDir

private

QString WocProcessor::m_xmlNS

private

QString WocProcessor::m_xmlPackNS

private

QString WocProcessor::m_xmlSchemaNS

private

QString WocProcessor::m_xmlSoap12NS

private

QString WocProcessor::m_xmlXmlNS

private

---

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

• proc/processor.h
• proc/processor.cpp