BUSBOY::ExternalEntry Class Reference

#include <ExternalEntry.h>

Public Member Functions
	ExternalEntry ()
void	dumpDataset (ExternalDataset *dataset)
ExternalDataset *	cloneDataset (ExternalDataset *dataset)
ExternalAlgorithmData *	cloneAlgorithmData (ExternalAlgorithmData *data)
ExternalAlgorithm *	getAlgorithm (const char *algoName)
bool	executeAlgorithm (const char *algoName, ExternalAlgorithmData *extData, ExternalContext *context)
void	pushEnvironmentProperties (const char *setName, const char *serializedProps)
void	testLogging (ExternalContext *extContext, const char *level, const char *msg)
	Does logging so caller can test callback works. More...
void	testProgressReporting (ExternalContext *extContext, float percentDone, const char *msg)
	Does progress reporting so caller can test callback works. More...
void	testFailureReporting (ExternalContext *extContext, const char *msg)
	Does failure reporting so caller can test callback works. More...
void	testSendMessage (ExternalContext *extContext, const Message &msg)
	Does send message so caller can test callback works. More...
void	testAddDataFile (ExternalDataset *extDataset, ExternalDataFile *extFile, bool stream)
	Does add file so caller can test callback works. More...
const char *	testGetDataFileName (ExternalDataset *extDataset, const char *serializedKey)
	Does file name fetching so caller can test callback works. More...
ExternalDataFile *	testFindDataFile (ExternalDataset *extDataset, const char *serializedKey)
	Does file finding so caller can test callback works. More...
bool	testIsQueryOnly (ExternalDataset *extDataset)
	Does check for query only so caller can test callback works. More...
ExternalDataFile *	testReadFileAsRandomAccess (ExternalDataset *extDataset, const char *serializedKey)
	Does random access read so caller can test callback works. More...
void	testWriteFileAsRandomAccess (ExternalDataset *extDataset, ExternalDataFile *extFile)
	Does random access write so caller can test callback works. More...
void	deleteLocalTempFiles ()
	Cleans up local temp files that might have been created by algorithm code. More...
const char **	getLogFilePaths ()
	Returns a NULL terminated array of C-strings containing paths for all log files generated by log4cxx. More...
	~ExternalEntry ()

Constructor & Destructor Documentation

BUSBOY::ExternalEntry::ExternalEntry

(

)

BUSBOY::ExternalEntry::~ExternalEntry

(

)

Member Function Documentation

ExternalAlgorithmData * BUSBOY::ExternalEntry::cloneAlgorithmData

(

ExternalAlgorithmData *

data

)

ExternalDataset * BUSBOY::ExternalEntry::cloneDataset

(

ExternalDataset *

dataset

)

void BUSBOY::ExternalEntry::deleteLocalTempFiles

(

)

Cleans up local temp files that might have been created by algorithm code.

void BUSBOY::ExternalEntry::dumpDataset

(

ExternalDataset *

dataset

)

bool BUSBOY::ExternalEntry::executeAlgorithm	(	const char *	algoName,
		ExternalAlgorithmData *	extData,
		ExternalContext *	context
	)

ExternalAlgorithm * BUSBOY::ExternalEntry::getAlgorithm

(

const char *

algoName

)

const char ** BUSBOY::ExternalEntry::getLogFilePaths

(

)

Returns a NULL terminated array of C-strings containing paths for all log files generated by log4cxx.

void BUSBOY::ExternalEntry::pushEnvironmentProperties	(	const char *	setName,
		const char *	serializedProps
	)

void BUSBOY::ExternalEntry::testAddDataFile	(	ExternalDataset *	extDataset,
		ExternalDataFile *	extFile,
		bool	stream
	)

Does add file so caller can test callback works.

void BUSBOY::ExternalEntry::testFailureReporting	(	ExternalContext *	extContext,
		const char *	msg
	)

Does failure reporting so caller can test callback works.

ExternalDataFile * BUSBOY::ExternalEntry::testFindDataFile	(	ExternalDataset *	extDataset,
		const char *	serializedKey
	)

Does file finding so caller can test callback works.

const char * BUSBOY::ExternalEntry::testGetDataFileName	(	ExternalDataset *	extDataset,
		const char *	serializedKey
	)

Does file name fetching so caller can test callback works.

bool BUSBOY::ExternalEntry::testIsQueryOnly

(

ExternalDataset *

extDataset

)

Does check for query only so caller can test callback works.

void BUSBOY::ExternalEntry::testLogging	(	ExternalContext *	extContext,
		const char *	level,
		const char *	msg
	)

Does logging so caller can test callback works.

void BUSBOY::ExternalEntry::testProgressReporting	(	ExternalContext *	extContext,
		float	percentDone,
		const char *	msg
	)

Does progress reporting so caller can test callback works.

ExternalDataFile * BUSBOY::ExternalEntry::testReadFileAsRandomAccess	(	ExternalDataset *	extDataset,
		const char *	serializedKey
	)

Does random access read so caller can test callback works.

Returns

the file that was read.

void BUSBOY::ExternalEntry::testSendMessage	(	ExternalContext *	extContext,
		const Message &	msg
	)

Does send message so caller can test callback works.

void BUSBOY::ExternalEntry::testWriteFileAsRandomAccess	(	ExternalDataset *	extDataset,
		ExternalDataFile *	extFile
	)

Does random access write so caller can test callback works.

---

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

• src/cpp/api/external/ExternalEntry.h
• src/cpp/impl/external/ExternalEntry.cpp