code::XMLDataFormatter Class Reference

Inheritance diagram for code::XMLDataFormatter:

List of all members.

---

Detailed Description

Will take an input Buffer in XML encoding and create a DataTable out of it.

This is just a Formatter-XMLDecoder adapter.

See also:

XMLDecoder

Author:

Lakshman

Version:

Id

code_XMLDataFormatter.h,v 1.3 2009/06/02 20:17:39 lakshman Exp

Public Member Functions
virtual SmartPtr< DataType >	createDataObject (const Buffer &buf) const
virtual Buffer	createBuffer (const DataType &) const
	Not implemented.
virtual	~XMLDataFormatter ()
virtual SmartPtr< DataType >	createDataObject (const Buffer &buf, const Index *) const
	Create a DataType given both a Buffer and an Index to use to extract other Records.
virtual SmartPtr< DataType >	createDataObject (const std::vector< Buffer > &bufs) const
	In some cases, it is necessary to pass in a multitude of variable-length buffers.
virtual SmartPtr< DataType >	createDataObject (const std::vector< Buffer > &bufs, const Index *index) const
	The more general purpose way of creating an object.
virtual SmartPtr< DataType >	createDataObject (const std::vector< std::string > &bufs, const Index *index) const
	The most general purpose way of creating an object.
virtual void	getBuffersToBuild (std::vector< std::string > &buffers) const
	The Formatter can tell the Builder what buffers (files) it needs.
Static Public Member Functions
static void	introduceSelf ()
	Introduces this formatter to the entire system.
static SmartPtr< Formatter >	getFormatter (const std::string &sourceType, const std::string &dataType)
	Given the source and data type, returns the appropriate formatter.
Static Protected Member Functions
static void	introduce (const std::string &sourceType, const std::string &dataType, SmartPtr< Formatter > new_subclass)
	Use this to introduce new formatters into the system.

---

Constructor & Destructor Documentation

virtual code::XMLDataFormatter::~XMLDataFormatter

(

)

[inline, virtual]

---

Member Function Documentation

virtual Buffer code::XMLDataFormatter::createBuffer

(

const DataType &

)

const [virtual]

Not implemented.

Implements code::Formatter.

virtual SmartPtr<DataType> code::Formatter::createDataObject	(	const std::vector< std::string > &	bufs,
		const Index *	index
	)			const [virtual, inherited]

The most general purpose way of creating an object.

Reimplemented in code::GeneralSRVFormatter.

virtual SmartPtr<DataType> code::Formatter::createDataObject	(	const std::vector< Buffer > &	bufs,
		const Index *	index
	)			const [virtual, inherited]

The more general purpose way of creating an object.

virtual SmartPtr<DataType> code::Formatter::createDataObject

(

const std::vector< Buffer > &

bufs

)

const [virtual, inherited]

In some cases, it is necessary to pass in a multitude of variable-length buffers.

This function is not pure virtual since it is needed only for special cases. This is the version that Hires must use.

virtual SmartPtr<DataType> code::Formatter::createDataObject	(	const Buffer &	buf,
		const Index *
	)			const [virtual, inherited]

Create a DataType given both a Buffer and an Index to use to extract other Records.

virtual SmartPtr<DataType> code::XMLDataFormatter::createDataObject

(

const Buffer &

buf

)

const [virtual]

Returns:

the type of object encoded in the buffer or 0 on error.

See also:

XMLDecoder

Reimplemented from code::Formatter.

virtual void code::Formatter::getBuffersToBuild

(

std::vector< std::string > &

buffers

)

const [virtual, inherited]

The Formatter can tell the Builder what buffers (files) it needs.

Hires Formatters must do this.

static SmartPtr< Formatter > code::Formatter::getFormatter	(	const std::string &	sourceType,
		const std::string &	dataType
	)			[static, inherited]

Given the source and data type, returns the appropriate formatter.

For example, getFormatter("hires", "VIL") will return the VIL formatter for hires.

Returns:

invalid smart pointer on error.

static void code::Formatter::introduce	(	const std::string &	sourceType,
		const std::string &	dataType,
		SmartPtr< Formatter >	new_subclass
	)			[static, protected, inherited]

Use this to introduce new formatters into the system.

static void code::XMLDataFormatter::introduceSelf

(

)

[static]

Introduces this formatter to the entire system.

---