OSB_LIB::InvoiceDir Class Reference

Collaboration diagram for OSB_LIB::InvoiceDir:

[legend]List of all members.

Detailed Description

InvoiceDir is used to store invoices on the file system.

This class provides a mechanism to store invoices in a directory tree. The structure of the tree is as follows:

User defined base directory where all invoices will be kept.
User defined layers of sorting directories.
A directory named with a sequential number.
The invoices are stored in these sequence directories.

This class provides public functions to

Create a file for user application to write to.
Close the file after user application wrote it.
Accept the newly written files.
Delete files not yet confirmed.

Example:

      // ...
      InvoiceDir myDir("/home/invoices", 90);
      ofstream os = myDir.create("M1/Jan", "inv001.txt");
      os << "Sample data" << endl;
      myDir.close();
      // ...
      if (success) {
          myDir.confirm();
      }
      else {
          myDir.deleteUnconfirm();
      }
      // ...

Definition at line 178 of file invoicedir.h.

Public Member Functions

~InvoiceDir ()
Destructor of the InvoiceDir class.
InvoiceDir (const std::string &basePath, long maxEntry)
Constructor of the InvoiceDir class.
std::ostream & create (const std::string &dirPath, const std::string &fileName)
Create, return an ostream for application to write to.
void deleteCurrentFile ()
Delete current file.
void close (const OSB_DB::Session &session, const InvoiceInfo &invInfo)
Close the ostream and insert the invoice info in the DB.
void confirm ()
Accept all the newly written invoices.
void deleteUnconfirm ()
Delete all the invoices that are not yet confirmed.
const std::string & currentFile ()
Accessor to the private member currentFile_.
const std::string & tmpExtension ()
Accessor to the private member tmpExtension_.

Private Member Functions

void mkTree (const std::string &dirTree, mode_t mode)
Build a directory tree.
std::string i2a (long i)
Transform a long integer to a string.
void padding (std::string &str, char pad, int size)
Padding a string variable value to have a constant length.

Private Attributes

std::string dirBase_
Base directory that all invoices are kept.
long maxFileEntry_
Maximum number of files in one directory.
std::string currentFile_
Name of the current written file.
std::string tmpExtension_
Temporary extension string.
std::vector< std::string > filesNotCommitted_
Keeping the name of all unconfirmed files.
std::ofstream os_
ofstream that is for the user application to write to.

Static Private Attributes

static int threadCounter_
First thread will init the mutex.
static pthread_mutex_t mutex_
Protect the shared directory map.
static DirPathNumEntryRecord dirInfoRecord_
Keeping the information of all invoice directories.

Constructor & Destructor Documentation

OSB_LIB::InvoiceDir::~InvoiceDir ( )

Destructor of the InvoiceDir class.

This destructor will destroy the mutex variable.

OSB_LIB::InvoiceDir::InvoiceDir	(	const std::string &	basePath,
		long	maxEntry
	)

Constructor of the InvoiceDir class.

This constructor will initialize the 'dirBase_' and 'MAX_ENTRY' with the input provided. Besides that, it also initialize the mutex of this class.

Parameters:

	basePath	Base directory (absolute path) of the invoice storage tree.
	maxEntry	Maximum entry allowed in one directory.

Member Function Documentation

void OSB_LIB::InvoiceDir::close	(	const OSB_DB::Session &	session,
		const InvoiceInfo &	invInfo
	)

Close the ostream and insert the invoice info in the DB.

This function will close the ostream that has been created by the this.create() function mentioned above. Also the info of the current invoice is written to the DB.

Parameters:

	session	Active session of the user application.
	invInfo	Contains details to be inserted in the DB.

void OSB_LIB::InvoiceDir::confirm ( )

Accept all the newly written invoices.

This function will rename all the newly written files from 'xxxx-tmp' to 'xxxx'.

std::ostream& OSB_LIB::InvoiceDir::create	(	const std::string &	dirPath,
		const std::string &	fileName
	)

Create, return an ostream for application to write to.

This function will create and return an ostream to the specially designed directory tree. The user application will write to this ostream.

Parameters:

	dirPath	Relative path where invoices will be stored.
	fileName	File system name for the invoice.

Returns:: The ostream created with this function is returned.

const std::string& OSB_LIB::InvoiceDir::currentFile ( ) [inline]

Accessor to the private member currentFile_.

Returns:: const string ref to the private member currentFile_.

Definition at line 257 of file invoicedir.h.

References currentFile_.

void OSB_LIB::InvoiceDir::deleteCurrentFile ( )

Delete current file.

This function will close the ostream that has been created by the this.create() function mentioned above. Also the current temporary file will be deleted.

void OSB_LIB::InvoiceDir::deleteUnconfirm ( )

Delete all the invoices that are not yet confirmed.

This function will remove all the newly written file with extension 'xxxx-tmp' from the file system.

std::string OSB_LIB::InvoiceDir::i2a ( long i ) [private]

Transform a long integer to a string.

This function will transform a long integer as specified in its arg1 to a string and return it.

Parameters:

Long integer wanted to be transformed.

Returns:: String object of the input long integer value.

void OSB_LIB::InvoiceDir::mkTree	(	const std::string &	dirTree,
		mode_t	mode
	)			`[private]`

Build a directory tree.

This function will create a directory tree as specified in its arg1. All directories and subdirectories created will have the same access permission as specified in arg2. Access privilege should be enforced in the directory mask.

Parameters:

	dirTree	The directory tree wanted to be built.
	mode	The access permission for the directory tree.

void OSB_LIB::InvoiceDir::padding	(	std::string &	str,
		char	pad,
		int	size
	)			`[private]`

Padding a string variable value to have a constant length.

This function will add in a user defined character into a string variable to make sure that the string has the length that user needs. The padding characters are added in front of the original value.

Parameters: