Vertica::ValueRangeWriter Class Reference

This class represents the output value range of a UDSF. More...

Inheritance diagram for Vertica::ValueRangeWriter:

Collaboration diagram for Vertica::ValueRangeWriter:

Public Member Functions
	ValueRangeWriter (char *outLoBound, char *outUpBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
bool	canHaveNulls (size_t idx) const
	Indicates if there can be NULL values in the range. More...
bool	canHaveNulls () const
template<class T , BoundType b>
const T *	getColPtr (size_t idx)
template<class T , BoundType b>
T *	getColPtrForWrite (size_t idx)
VNumeric &	getNumericRefLo ()
	Gets a VNumeric object reference to set the range lower bound. More...
VNumeric &	getNumericRefUp ()
	Gets a VNumeric object reference to set the range upper bound. More...
size_t	getNumRanges () const
	Retrieve the number of range arguments. More...
const VerticaType &	getRangeType (size_t idx) const
	Returns the data type of the values in a range. More...
EE::ValueSort	getSortedness (size_t idx) const
	Gets the sortedness of values in a range. More...
EE::ValueSort	getSortedness () const
VString &	getStringRefLo ()
	Gets a VString object reference to set the range lower bound. More...
VString &	getStringRefUp ()
	Gets a VString object reference to set the range upper bound. More...
VUuid &	getUuidRefLo ()
	Gets a VUuid object reference to set the range lower bound. More...
VUuid &	getUuidRefUp ()
	Gets a VUuid object reference to set the range upper bound. More...
bool	hasBounds () const
void	setBoolLo (vbool r)
	Sets a range bound as a BOOLEAN value. More...
void	setBoolUp (vbool r)
void	setCanHaveNulls (bool u)
void	setDateLo (DateADT r)
	Sets a range bound as a DATE value. More...
void	setDateUp (DateADT r)
void	setFloatLo (vfloat r)
	Sets a range bound as a FLOAT value to the output row. More...
void	setFloatUp (vfloat r)
void	setHasBounds ()
	Lets Vertica know that this output range has user-defined bounds.
void	setIntervalLo (Interval r)
	Sets a range bound as an INTERVAL value. More...
void	setIntervalUp (Interval r)
void	setIntervalYMLo (IntervalYM r)
	Sets a range bound as an INTERVAL YEAR TO MONTH value. More...
void	setIntervalYMUp (IntervalYM r)
void	setIntLo (vint r)
	Sets a range bound as an INTEGER value. More...
void	setIntUp (vint r)
void	setNull ()
	Sets to NULL all values in this range. More...
void	setSortedness (EE::ValueSort s)
void	setTimeLo (TimeADT r)
	Sets a range bound as a TIMESTAMP value. More...
void	setTimestampLo (Timestamp r)
	Sets a range bound as a TIMESTAMP value. More...
void	setTimestampTzLo (TimestampTz r)
	Sets a range bound as a TIMESTAMP WITH TIMEZONE value. More...
void	setTimestampTzUp (TimestampTz r)
void	setTimestampUp (Timestamp r)
void	setTimeTzLo (TimeTzADT r)
	Sets a range bound as a TIMESTAMP WITH TIMEZONE value. More...
void	setTimeTzUp (TimeTzADT r)
void	setTimeUp (TimeADT r)

Protected Types
enum	BoundType { LO_BOUND, UP_BOUND }

Protected Member Functions
void	addArg (char *loBound, char *upBound, const VerticaType &dt, EE::ValueSort sortedness, bool canHaveNulls)
void	setCanHaveNulls (size_t idx, bool u)
	Set a flag to indicate that some values in this range can be NULL. More...
void	setSortedness (size_t idx, EE::ValueSort s)
	Set the sortedness of values in the range. More...

Protected Attributes
size_t	narg
std::vector< ValueRange >	ranges
std::vector< VString >	svWrappersLo
std::vector< VString >	svWrappersUp
std::vector< VUuid >	uuWrappersLo
std::vector< VUuid >	uuWrappersUp
std::vector< VNumeric >	vnWrappersLo
std::vector< VNumeric >	vnWrappersUp

Friends
class	EE::VEval

Detailed Description

This class represents the output value range of a UDSF.

Instances of this class are used to allow UDSF developers specify the output range of UDSFs via the optional ScalarFunction::getOutputRange() function.

Member Function Documentation

void Vertica::VerticaValueRange::addArg ( char *  loBound, char *  upBound, const VerticaType &  dt, EE::ValueSort  sortedness, bool  canHaveNulls  )

inlineprotectedinherited

Add a value range of a particular function argument

Parameters

loBound	Base location to find the lower bound data
upBound	Base location to find the upper bound data
sortedness	Sortedness of values in the range
dt	The data type of range bounds

bool Vertica::VerticaValueRange::canHaveNulls ( size_t  idx ) const

inlineinherited

Indicates if there can be NULL values in the range.

Parameters

idx	the range argument number.

Returns

TRUE if some range values can be NULL, else FALSE.

Referenced by setNull().

VNumeric& Vertica::ValueRangeWriter::getNumericRefLo ( )

inline

Gets a VNumeric object reference to set the range lower bound.

Returns

A VNumeric object reference.

VNumeric& Vertica::ValueRangeWriter::getNumericRefUp ( )

inline

Gets a VNumeric object reference to set the range upper bound.

Returns

A VNumeric object reference.

size_t Vertica::VerticaValueRange::getNumRanges ( ) const

inlineinherited

Retrieve the number of range arguments.

Returns

the number of range arguments held by this object.

const VerticaType& Vertica::VerticaValueRange::getRangeType ( size_t  idx ) const

inlineinherited

Returns the data type of the values in a range.

Parameters

idx	The index of the range

Returns

a VerticaType object describing the data type of the range values.

EE::ValueSort Vertica::VerticaValueRange::getSortedness ( size_t  idx ) const

inlineinherited

Gets the sortedness of values in a range.

Parameters

idx	the range argument number.

Returns

the range sortedness. Possible values are: EE::SORT_UNORDERED - Unsorted EE::SORT_MONOTONIC_INCREASING - Ascending EE::SORT_MONOTONIC_DECREASING - Descending EE::SORT_CONSTANT - Single value

Referenced by setNull().

VString& Vertica::ValueRangeWriter::getStringRefLo ( )

inline

Gets a VString object reference to set the range lower bound.

Returns

A VString object reference.

VString& Vertica::ValueRangeWriter::getStringRefUp ( )

inline

Gets a VString object reference to set the range upper bound.

Returns

A VString object reference.

VUuid& Vertica::ValueRangeWriter::getUuidRefLo ( )

inline

Gets a VUuid object reference to set the range lower bound.

Returns

A VUuid object reference.

VUuid& Vertica::ValueRangeWriter::getUuidRefUp ( )

inline

Gets a VUuid object reference to set the range upper bound.

Returns

A VUuid object reference.

void Vertica::ValueRangeWriter::setBoolLo ( vbool  r )

inline

Sets a range bound as a BOOLEAN value.

Parameters

r	The BOOLEAN value to set the range bound.

void Vertica::VerticaValueRange::setCanHaveNulls ( size_t  idx, bool  u  )

inlineprotectedinherited

Set a flag to indicate that some values in this range can be NULL.

Parameters

idx	The argument range number.
u	true if there can be NULL values in the range, else false.

Referenced by setNull().

void Vertica::ValueRangeWriter::setDateLo ( DateADT  r )

inline

Sets a range bound as a DATE value.

Parameters

r	The DATE value to set the range bound.

void Vertica::ValueRangeWriter::setFloatLo ( vfloat  r )

inline

Sets a range bound as a FLOAT value to the output row.

Parameters

r	The FLOAT value to set the range bound.

void Vertica::ValueRangeWriter::setIntervalLo ( Interval  r )

inline

Sets a range bound as an INTERVAL value.

Parameters

r	The INTERVAL value to set the range bound.

void Vertica::ValueRangeWriter::setIntervalYMLo ( IntervalYM  r )

inline

Sets a range bound as an INTERVAL YEAR TO MONTH value.

Parameters

r	The INTERVAL YEAR TO MONTH value to set the range bound.

void Vertica::ValueRangeWriter::setIntLo ( vint  r )

inline

Sets a range bound as an INTEGER value.

Parameters

r	The INTEGER value to set the range bound.

void Vertica::ValueRangeWriter::setNull ( )

inline

Sets to NULL all values in this range.

Note

As side effect of this method, this range will be marked as having NULL values and its sortedness set to EE::SORT_CONSTANT.

void Vertica::VerticaValueRange::setSortedness ( size_t  idx, EE::ValueSort  s  )

inlineprotectedinherited

Set the sortedness of values in the range.

Parameters

idx	The range argument number.
s	The sortedness value to set. Possible values are: EE::SORT_UNORDERED - Unsorted EE::SORT_MONOTONIC_INCREASING - Ascending EE::SORT_MONOTONIC_DECREASING - Descending EE::SORT_CONSTANT - Single value

Example:

range.setSortedness(0, EE:SORT_CONSTANT); // defines a single-valued range

Referenced by setNull().

void Vertica::ValueRangeWriter::setTimeLo ( TimeADT  r )

inline

Sets a range bound as a TIMESTAMP value.

Parameters

r	The TIMESTAMP value to set the range bound.

void Vertica::ValueRangeWriter::setTimestampLo ( Timestamp  r )

inline

Sets a range bound as a TIMESTAMP value.

Parameters

r	The TIMESTAMP value to set the range bound.

void Vertica::ValueRangeWriter::setTimestampTzLo ( TimestampTz  r )

inline

Sets a range bound as a TIMESTAMP WITH TIMEZONE value.

Parameters

r	The TIMESTAMP WITH TIMEZONE value to set the range bound.

void Vertica::ValueRangeWriter::setTimeTzLo ( TimeTzADT  r )

inline

Sets a range bound as a TIMESTAMP WITH TIMEZONE value.

Parameters

r	The TIMESTAMP WITH TIMEZONE value to set the range bound.