class XxxImageADT : public XxxLargeFixedADT

XxxImageADT

Inheritance:

Public Classes

class

ImageStruct : public XxxADTValue Structure used to represent an image within a record CAUTION!!: Be careful that the size does not cross XXX_MIHNDL_MAX TODO: why does this matter?? class ImageBox box of an image

Public Methods

virtual XxxErrCode	CreateStatsInfo (const XxxADTMetaInfo *MetaInfo, TypeStats*& StatsInfo) create statistics information
virtual const char*	GetContentType (void *ResultHandle) This function will only be called on ADTs which support callbacks
virtual XxxErrCode	GetResultSize (const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, int &ResultSize) This function will only be called on ADTs which support callbacks
virtual XxxErrCode	ReadText (istream& InStream, XxxADTValue* ObjectRef, const XxxADTMetaInfo* MetaInfo)
virtual XxxErrCode	ServiceCallback (const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, ostream &OStr) This function will only be called on ADTs which support callbacks
	XxxImageADT (XxxBasicType Id)
virtual	~XxxImageADT ()

Protected Classes

class	ImageMetaInfo : public XxxADTMetaInfo meta-info for images virtual XxxErrCode SerializeCopySize (int &Size) Returns the number of bytes necessary to hold the serialized version of this meta-info object virtual XxxErrCode SerializeCopy (char *Data) Creates a binary version of this meta-info object
class	ImageStatsInfo : public XxxADTClass::TypeStats stats-info for images virtual XxxErrCode Copy (const XxxADTMetaInfo* MetaInfo, TypeStats* NewSI) / copy a replica into preallocated space
class	PlanInfo : public XxxFuncPlanInfo plan structure for functions over images XxxErrCode iavgInit (XxxAggrOpHandle& Hndl) / Image Avg

Protected Methods

void	registerMethods () / helper method used by constructor
void	registerRules () / helper method used by constructor

Inherited from XxxLargeFixedADT:

Inherited from XxxLargeADT:

Public Classes

class XxxLargeADTEnv: public XxxADTEnv

enum XxxLargeADTDisplayTypeEnum

Determines the display type

typedef enum XxxLargeADTDisplayTypeEnum XxxLargeADTDisplayType

A typedef for easy reference

static const char* const DISPLAY_TYPE

The command referencing the next variable

XxxLargeADTDisplayType DisplayType

The desired display type

XxxShoreVolumeId StorageVolume

The volume on which the large ADTs store information

XxxShoreObjectId StorageFile

A file on the default volume which is persistent

XxxShoreObjectId TemporaryFile

A file on the default volume which is cleared after all Xacts end

Public Methods

virtual XxxErrCode CreateEnv( XxxADTEnv* &Env )

virtual XxxErrCode DeleteEnv( XxxADTEnv* Env )

virtual XxxBool IsSmall(const XxxADTMetaInfo*)

virtual XxxBool SupportsCallback()

class ImageStruct: public XxxADTValue

Structure used to represent an image within a record CAUTION!!: Be careful that the size does not cross XXX_MIHNDL_MAX TODO: why does this matter??

class ImageBox

box of an image

class PlanInfo: public XxxFuncPlanInfo

plan structure for functions over images

XxxErrCode iavgInit(XxxAggrOpHandle& Hndl)

/ Image Avg

class ImageMetaInfo: public XxxADTMetaInfo

meta-info for images

virtual XxxErrCode SerializeCopySize(int &Size)

Returns the number of bytes necessary to hold the serialized version of this meta-info object

Returns:

XXX_NOT_OK if the object cannot be serialized, XXX_OK otherwise

Parameters:

Size - (out) The required number of bytes

virtual XxxErrCode SerializeCopy(char *Data)

Creates a binary version of this meta-info object

Returns:

XXX_NOT_OK if the object cannot be serialized, XXX_OK otherwise

Parameters:

Data - An array of bytes of at least the size specified by the SerializeCopySize() function.

class ImageStatsInfo: public XxxADTClass::TypeStats

stats-info for images

virtual XxxErrCode Copy(const XxxADTMetaInfo* MetaInfo, TypeStats* NewSI)

/ copy a replica into preallocated space

void registerMethods()

/ helper method used by constructor

void registerRules()

/ helper method used by constructor

XxxImageADT(XxxBasicType Id)

virtual ~XxxImageADT()

virtual XxxErrCode ReadText(istream& InStream, XxxADTValue* ObjectRef, const XxxADTMetaInfo* MetaInfo)

virtual const char* GetContentType(void *ResultHandle)

This function will only be called on ADTs which support callbacks. Any data type which would like to take advantage of browser capability to handle some data specially, for instance, displaying images, must return a valid Content Type string as described in RFC 1590.

virtual XxxErrCode CreateStatsInfo(const XxxADTMetaInfo *MetaInfo, TypeStats*& StatsInfo)

create statistics information

virtual XxxErrCode GetResultSize(const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, int &ResultSize)

This function will only be called on ADTs which support callbacks. Given a handle on the result, this function must determine the size (in bytes) of the response it will send in a call to the ServiceCallback() function.

Parameters:

ObjectRef - The object for which a callback is being made
MetaInfo - The meta info for that object
Message - A binary message that was sent with the callback (or NULL if none was sent)
MessageSize - The size of the Message array
ResultSize - (out) The size of the object to be sent

virtual XxxErrCode ServiceCallback(const XxxADTValue *ObjectRef, const XxxADTMetaInfo *MetaInfo, const char *Message, const int MessageSize, ostream &OStr)

This function will only be called on ADTs which support callbacks. This is the sister-function to the Callback function in the Java Client Library. It communicates with the JCL and transfers the "full value" of a data object over the stream provided.

Parameters:

RequestBuffer - The request message sent from the JCL
BufferSize - The buffer's size
OStr - The output stream to the JCL data type

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de