An array of primitive values of a single type. More...

#include <MetadataArray.h>

Inheritance diagram for BUSBOY::MetadataArray:

Public Member Functions
	MetadataArray ()

	MetadataArray (const MetadataArray &array)

bool *	getBooleanValue () const

char *	getByteValue () const

int *	getIntegerValue () const

float *	getFloatValue () const

double *	getDoubleValue () const

long double *	getLongDoubleValue () const

std::string *	getStringValue () const

size_t *	getSize_tValue () const

Primitive::Type	getPrimitiveType () const

MetadataElement::Type	getMetadataElementType () const

virtual CloneableMetadataElement *	clone () const

size_t	getSize () const

MetadataArray &	operator= (const MetadataArray &array)

bool	operator== (const MetadataArray &array) const

bool	operator== (const MetadataElement &element) const

bool	operator!= (const MetadataArray &array) const

bool	operator!= (const MetadataElement &element) const

std::string	str ()
	Returns a formatted representation of the array. More...

	~MetadataArray ()

std::string *	toString () const
	NOTE: The array of returned strings is allocated on the heap with new[] - it should be disposed of with delete[]. More...

void	toString (std::string *strs) const
	NOTE: The caller must allocate an array of at least getSize() string pointers. More...

Static Public Member Functions
static MetadataArray	createBoolean (const bool *val, size_t size)

static MetadataArray	createInteger (const int *val, size_t size)

static MetadataArray	createByte (const char *val, size_t size)

static MetadataArray	createFloat (const float *val, size_t size)

static MetadataArray	createDouble (const double *val, size_t size)

static MetadataArray	createLongDouble (const long double *val, size_t size)

static MetadataArray	createString (const char **val, size_t size)

static MetadataArray	createString (const std::string *val, size_t size)

static MetadataArray	createSize_t (const size_t *val, size_t size)

static MetadataArray	parseArray (const std::string *str, Primitive::Type type, size_t size)

static const MetadataArray *	castToArray (const MetadataElement *element)

static MetadataArray *	castToArray (MetadataElement *element)

static const MetadataArray &	castToArray (const MetadataElement &element)

static MetadataArray &	castToArray (MetadataElement &element)

Additional Inherited Members
Public Types inherited from BUSBOY::MetadataElement
enum	Type { FIELD, ARRAY, LIST, MAP, KEY }

Static Protected Member Functions inherited from BUSBOY::MetadataElement
template<typename T >
static const T *	castElement (const MetadataElement *element, Type type)

template<typename T >
static T *	castElement (MetadataElement *element, Type type)

template<typename T >
static const T &	castElement (const MetadataElement &element, Type type)

template<typename T >
static T &	castElement (MetadataElement &element, Type type)

Detailed Description

An array of primitive values of a single type.

This class is immutable. Use is as follows:

call createXXX(val[]) to create a new array
call getXXXValue() to recover the the array of primitive values
call toString() to get an array of string representations of the primitive value
call parseArray(str[],type) to recover the array from the string representations

Notes on usage:

The arrays passed in the createXXX and parseArray methods are copied, and may be disposed of after the method returns.
The arrays returned by getXXXValue are copies allocated on the heap with new[]. They should be disposed of with delete[] when no longer needed.
Very large arrays should probably be files, and not metadata.

Constructor & Destructor Documentation

BUSBOY::MetadataArray::MetadataArray ( )

BUSBOY::MetadataArray::MetadataArray ( const MetadataArray & array )

BUSBOY::MetadataArray::~MetadataArray ( )

Member Function Documentation

const MetadataArray * BUSBOY::MetadataArray::castToArray ( const MetadataElement * element )

static

MetadataArray * BUSBOY::MetadataArray::castToArray ( MetadataElement * element )

static

const MetadataArray & BUSBOY::MetadataArray::castToArray ( const MetadataElement & element )

static

MetadataArray & BUSBOY::MetadataArray::castToArray ( MetadataElement & element )

static

CloneableMetadataElement * BUSBOY::MetadataArray::clone ( ) const

virtual

Implements BUSBOY::CloneableMetadataElement.

MetadataArray BUSBOY::MetadataArray::createBoolean	(	const bool *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createByte	(	const char *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createDouble	(	const double *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createFloat	(	const float *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createInteger	(	const int *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createLongDouble	(	const long double *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createSize_t	(	const size_t *	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createString	(	const char **	val,
		size_t	size
	)

static

MetadataArray BUSBOY::MetadataArray::createString	(	const std::string *	val,
		size_t	size
	)

static

bool * BUSBOY::MetadataArray::getBooleanValue ( ) const

char * BUSBOY::MetadataArray::getByteValue ( ) const

double * BUSBOY::MetadataArray::getDoubleValue ( ) const

float * BUSBOY::MetadataArray::getFloatValue ( ) const

int * BUSBOY::MetadataArray::getIntegerValue ( ) const

long double * BUSBOY::MetadataArray::getLongDoubleValue ( ) const

MetadataElement::Type BUSBOY::MetadataArray::getMetadataElementType ( ) const

virtual

Implements BUSBOY::MetadataElement.

Primitive::Type BUSBOY::MetadataArray::getPrimitiveType ( ) const

size_t BUSBOY::MetadataArray::getSize ( ) const

size_t * BUSBOY::MetadataArray::getSize_tValue ( ) const

std::string * BUSBOY::MetadataArray::getStringValue ( ) const

bool BUSBOY::MetadataArray::operator!= ( const MetadataArray & array ) const

bool BUSBOY::MetadataArray::operator!= ( const MetadataElement & element ) const

virtual

Implements BUSBOY::MetadataElement.

MetadataArray & BUSBOY::MetadataArray::operator= ( const MetadataArray & array )

bool BUSBOY::MetadataArray::operator== ( const MetadataArray & array ) const

bool BUSBOY::MetadataArray::operator== ( const MetadataElement & element ) const

virtual

Implements BUSBOY::MetadataElement.

MetadataArray BUSBOY::MetadataArray::parseArray	(	const std::string *	str,
		Primitive::Type	type,
		size_t	size
	)

static

std::string BUSBOY::MetadataArray::str ( )

Returns a formatted representation of the array.

The type is followed by a comma separated list of the values.

std::string * BUSBOY::MetadataArray::toString ( ) const

NOTE: The array of returned strings is allocated on the heap with new[] - it should be disposed of with delete[].

void BUSBOY::MetadataArray::toString ( std::string * strs ) const

NOTE: The caller must allocate an array of at least getSize() string pointers.

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

src/cpp/api/metadata/MetadataArray.h
src/cpp/impl/metadata/MetadataArray.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation