CdsResource Class Reference

#include <cds_resource.h>

Inheritance diagram for CdsResource:

Public Member Functions
	CdsResource (int handlerType)
	creates a new resource object.
	CdsResource (int handlerType, zmm::Ref< Dictionary > attributes, zmm::Ref< Dictionary > parameters, zmm::Ref< Dictionary > options)
void	addAttribute (zmm::String name, zmm::String value)
	Adds a resource attribute.
void	removeAttribute (zmm::String name)
	Removes a resource attribute.
void	mergeAttributes (zmm::Ref< Dictionary > additional)
	Merge existing attributes with new ones.
void	addParameter (zmm::String name, zmm::String value)
	Adds a parameter (will be appended to the URL).
void	addOption (zmm::String name, zmm::String value)
	Add an option to the resource.
int	getHandlerType ()
zmm::Ref< Dictionary >	getAttributes ()
zmm::Ref< Dictionary >	getParameters ()
zmm::Ref< Dictionary >	getOptions ()
zmm::String	getAttribute (zmm::String name)
zmm::String	getParameter (zmm::String name)
zmm::String	getOption (zmm::String name)
bool	equals (zmm::Ref< CdsResource > other)
zmm::Ref< CdsResource >	clone ()
zmm::String	encode ()
void	optimize ()
	Frees unnecessary memory.
void	retain ()
void	release ()
int	getRefCount ()
Static Public Member Functions
static zmm::Ref< CdsResource >	decode (zmm::String serial)
static void *	operator new (size_t size)
static void	operator delete (void *ptr)
Protected Attributes
int	handlerType
zmm::Ref< Dictionary >	attributes
zmm::Ref< Dictionary >	parameters
zmm::Ref< Dictionary >	options
mt_atomic_t	_ref_count
pthread_mutex_t	mutex

Detailed Description

Definition at line 48 of file cds_resource.h.

Constructor & Destructor Documentation

CdsResource::CdsResource ( int handlerType )

creates a new resource object.

The CdsResource object represents a <res> tag in the DIDL-Lite XML.

Parameters:

handler_type

id of the associated handler

Definition at line 43 of file cds_resource.cc.

References attributes, options, and parameters.

Referenced by clone(), and decode().

CdsResource::CdsResource	(	int	handlerType,
		zmm::Ref< Dictionary >	attributes,
		zmm::Ref< Dictionary >	parameters,
		zmm::Ref< Dictionary >	options
	)

Definition at line 50 of file cds_resource.cc.

Member Function Documentation

void CdsResource::addAttribute	(	zmm::String	name,
		zmm::String	value
	)

Adds a resource attribute.

This maps to an attribute of the <res> tag in the DIDL-Lite XML.

Parameters:

	name	attribute name
	value	attribute value

Definition at line 61 of file cds_resource.cc.

References attributes.

void CdsResource::addOption	(	zmm::String	name,
		zmm::String	value
	)

Add an option to the resource.

The options are internal, they do not appear in the URL or in the XML but can be used for any purpose.

Definition at line 82 of file cds_resource.cc.

References options.

void CdsResource::addParameter	(	zmm::String	name,
		zmm::String	value
	)

Adds a parameter (will be appended to the URL).

The parameters will be appended to the object URL in the DIDL-Lite XML. This is useful for cases, where you need to identify specific options, i.e. something that is only relevant to a particular metadata handler and so on. The parameters will be automatically URL encoded.

Parameters: