CLAM::XMLComponentAdapter Class Reference
[Using XML Adapters to implement StoreOn and LoadFrom]

This class adapts to the XMLable interface any object that is a CLAM::Component. More...

#include <XMLComponentAdapter.hxx>

Public Types
typedef BasicXMLable	super
Public Member Functions
template<class T >
	XMLComponentAdapter (const T &adaptee, const char *name=NULL, bool isXMLElement=false)
	Constructs a XMLComponentAdapter.
virtual	~XMLComponentAdapter ()
virtual std::string	XMLContent () const
virtual bool	XMLContent (std::istream &str)
const char *	GetClassName () const
	Return the class name.
virtual void	StoreOn (Storage &store) const
	Stores subitems on the given Storage.
virtual void	LoadFrom (Storage &store)
	Loads component's subitems from the given Storage.
bool	FulfilsInvariant ()

Detailed Description

This class adapts to the XMLable interface any object that is a CLAM::Component.

The XMLComponent adapter implements both the XMLable and the Component interface. So, implements the retrieval of XML properties (naming, being Element, Atribute or Simple content...) and implements the StoreOn function that is called by the XMLStorage to allow the component store its subitems. The StoreOn is implemented in XMLComponentAdapter simply by forwarding the call to de Adaptee.

You should use XMLComponentAdapter when:

You have a Component that you don't want always to overload with the XML stuff, but in some cases you need to store it as XML content.

Note: Simple content, (XMLable::XMLContent() implementation) returns an empty string.

Pay attention to the management of the name memory (see CLAM::BasicXMLable).

See also:: XMLable; Component

Definition at line 62 of file XMLComponentAdapter.hxx.

Member Typedef Documentation

typedef BasicXMLable CLAM::XMLComponentAdapter::super

Definition at line 65 of file XMLComponentAdapter.hxx.

Constructor & Destructor Documentation

template<class T >

CLAM::XMLComponentAdapter::XMLComponentAdapter	(	const T &	adaptee,
		const char *	name = `NULL`,
		bool	isXMLElement = `false`
	)			`[inline]`

Constructs a XMLComponentAdapter.

Note: You cannot use this adapter as attribute because the content adapter does not know how to extract the XML content. Alternatives: Implement << and >> and adapt it with a simple XMLAdapter.

Parameters:

	adaptee	The Component to be adapted (where subitem will be located)
	name	A pointer to a 0 terminated string containing the xml name (for elements and attributes) or 0 (the default) if the element is neither an element nor an attribute (

See also:: BasicXMLable for important details about memory managing). Because no internal copy of the string is done, the 0 terminated string pointed by name must exist during the BasicXMLable life as is directly used.

Parameters:

isXMLElement

Tells whether the object is an element or an attribute when the name is defined. If a name is given, this must be true because a component adapter cannot adapt as attribute.

Definition at line 92 of file XMLComponentAdapter.hxx.

References CLAM_ASSERT.

virtual CLAM::XMLComponentAdapter::~XMLComponentAdapter ( ) [inline, virtual]

Definition at line 97 of file XMLComponentAdapter.hxx.