ErrorSource Class Reference

ErrorSource is a common base for all classes that post row exceptions to an ErrorTarget. More...

#include <ErrorSource.h>

Inheritance diagram for ErrorSource:

List of all members.

Public Member Functions
virtual	~ErrorSource ()
virtual void	initErrorSource (SharedErrorTarget pErrorTarget, const std::string &name)
	For use when initialization has to be deferred until after construction.
void	postError (ErrorLevel level, const std::string &message, void *address, long capacity, int index)
	Posts an exception, such as a row exception.
void	postError (ErrorLevel level, const std::string &message, const TupleDescriptor &errorDesc, const TupleData &errorTuple, int index)
	Posts an exception, such as a row exception.
bool	hasTarget () const
	Returns: true iff an error target has been set
ErrorTarget &	getErrorTarget () const
	Returns: the ErrorTarget for this source
SharedErrorTarget	getSharedErrorTarget () const
	Returns: the SharedErrorTarget for this source
std::string	getErrorSourceName () const
	Gets the name of this source.
void	setErrorSourceName (std::string const &n)
	Sets the name of this source.
void	disableTarget ()
Protected Member Functions
	ErrorSource ()
	Constructs a new uninitialized ErrorSource.
	ErrorSource (SharedErrorTarget pErrorTarget, const std::string &name)
	Constructs a new ErrorSource.
Private Attributes
SharedErrorTarget	pErrorTarget
std::string	name
TupleAccessor	errorAccessor
	Tuple accessor for error records handed by this error source.
boost::shared_ptr< FixedBuffer >	pErrorBuf
	A buffer for error records.

---

Detailed Description

ErrorSource is a common base for all classes that post row exceptions to an ErrorTarget.

An ErrorSource generally corresponds to an ExecStream. Fennel data is typiclly interpreted as external data via separate metadata, so it is usually required for an ErrorSource to be preregistered with the external system. (For example, a Fennel long might map to a decimal or datetime type.)

Definition at line 42 of file ErrorSource.h.

---

Constructor & Destructor Documentation

ErrorSource::ErrorSource

(

)

[explicit, protected]

Constructs a new uninitialized ErrorSource.

Definition at line 29 of file ErrorSource.cpp.

References pErrorTarget.

{
    pErrorTarget.reset();
}

ErrorSource::ErrorSource	(	SharedErrorTarget	pErrorTarget,
		const std::string &	name
	)			[explicit, protected]

Constructs a new ErrorSource.

Parameters:

	pErrorTarget	the ErrorTarget to which errors will be posted, or NULL to ignore errors.
	name	the unique name of this source, such as the name of a Fennel ExecStream

Definition at line 34 of file ErrorSource.cpp.

References initErrorSource(), and pErrorTarget.

{
    pErrorTarget.reset();
    initErrorSource(pErrorTargetInit, nameInit);
}

ErrorSource::~ErrorSource

(

)

[virtual]

Definition at line 42 of file ErrorSource.cpp.

References pErrorTarget.

{
    pErrorTarget.reset();
}

---

Member Function Documentation

void ErrorSource::initErrorSource	(	SharedErrorTarget	pErrorTarget,
		const std::string &	name
	)			[virtual]

For use when initialization has to be deferred until after construction.

Parameters:

	pErrorTarget	the ErrorTarget to which errors will be posted
	name	the name of this source

Definition at line 47 of file ErrorSource.cpp.

References name, and pErrorTarget.

Referenced by ErrorSource().

{
    pErrorTarget = pErrorTargetInit;
    name = nameInit;
}

void ErrorSource::postError	(	ErrorLevel	level,
		const std::string &	message,
		void *	address,
		long	capacity,
		int	index
	)

Posts an exception, such as a row exception.

See also:

ErrorTarget for a description of the parameters

Definition at line 55 of file ErrorSource.cpp.

References getErrorTarget(), hasTarget(), name, and ErrorTarget::notifyError().

Referenced by FlatFileExecStreamImpl::logError(), postError(), and LbmSplicerExecStream::postViolation().

{
    if (hasTarget()) {
        getErrorTarget().notifyError(
            name, level, message, address, capacity, index);
    }
}

void ErrorSource::postError	(	ErrorLevel	level,
		const std::string &	message,
		const TupleDescriptor &	errorDesc,
		const TupleData &	errorTuple,
		int	index
	)

Posts an exception, such as a row exception.

See also:

ErrorTarget for a description of the parameters

Definition at line 65 of file ErrorSource.cpp.

References TupleAccessor::compute(), errorAccessor, FixedBuffer, TupleAccessor::getByteCount(), TupleAccessor::getMaxByteCount(), hasTarget(), TupleAccessor::marshal(), pErrorBuf, and postError().

{
    if (!hasTarget()) {
        return;
    }

    if (!pErrorBuf) {
        errorAccessor.compute(errorDesc);
        uint cbMax = errorAccessor.getMaxByteCount();
        pErrorBuf.reset(new FixedBuffer[cbMax]);
    }

    uint cbTuple = errorAccessor.getByteCount(errorTuple);
    errorAccessor.marshal(errorTuple, pErrorBuf.get());
    postError(level, message, pErrorBuf.get(), cbTuple, index);
}

bool ErrorSource::hasTarget

(

)

const [inline]

Returns:

true iff an error target has been set

Definition at line 112 of file ErrorSource.h.

Referenced by postError().

    {
        return pErrorTarget.get() ? true : false;
    }

ErrorTarget& ErrorSource::getErrorTarget

(

)

const [inline]

Returns:

the ErrorTarget for this source

Definition at line 120 of file ErrorSource.h.

Referenced by postError().

    {
        assert(hasTarget());
        return *(pErrorTarget.get());
    }

SharedErrorTarget ErrorSource::getSharedErrorTarget

(

)

const [inline]

Returns:

the SharedErrorTarget for this source

Definition at line 129 of file ErrorSource.h.

    {
        return pErrorTarget;
    }

std::string ErrorSource::getErrorSourceName

(

)

const [inline]

Gets the name of this source.

Useful to construct nested names for subcomponents that are also ErrorSources.

Returns:

the name

Definition at line 139 of file ErrorSource.h.

    {
        return name;
    }

void ErrorSource::setErrorSourceName

(

std::string const &

n

)

[inline]

Sets the name of this source.

Useful to construct dynamic names for fine-grained filtering.

Definition at line 148 of file ErrorSource.h.

    {
        name = n;
    }

void ErrorSource::disableTarget

(

)

Definition at line 84 of file ErrorSource.cpp.

References pErrorTarget.

{
    pErrorTarget.reset();
}

---

Member Data Documentation

SharedErrorTarget ErrorSource::pErrorTarget [private]

Definition at line 44 of file ErrorSource.h.

Referenced by disableTarget(), ErrorSource(), initErrorSource(), and ~ErrorSource().

std::string ErrorSource::name [private]

Reimplemented in ExecStream.

Definition at line 45 of file ErrorSource.h.

Referenced by initErrorSource(), and postError().

TupleAccessor ErrorSource::errorAccessor [private]

Tuple accessor for error records handed by this error source.

Definition at line 50 of file ErrorSource.h.

Referenced by postError().

boost::shared_ptr<FixedBuffer> ErrorSource::pErrorBuf [private]

A buffer for error records.

Definition at line 55 of file ErrorSource.h.

Referenced by postError().

---

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

• /home/pub/open/dev/fennel/exec/ErrorSource.h
• /home/pub/open/dev/fennel/exec/ErrorSource.cpp

---