IDataServices Class Reference

#include <IDataServices.h>

Inheritance diagram for IDataServices:

Public Types
enum	{ kDefaultIID = IID_IDATASERVICES }

Public Member Functions
virtual IPMStream *	TransformContent (IPMStream *stream, IPMUnknown *transformData=nil) const =0
virtual IPMStream *	TransformContent (IPMStream *stream, IDataTransform::Parameters &params, bool16 defaultParams=kTrue)=0
virtual IPMStream *	GetSchema (IPMStream *stream, IDataTransform::Parameters &params, bool16 defaultParams=kTrue)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IDataServices is the primary interface for working with the XML data service. A data service is primarily a transformation that can be applied to an XML document.

Member Function Documentation

virtual IPMStream* IDataServices::GetSchema ( IPMStream *  stream, IDataTransform::Parameters &  params, bool16  defaultParams = kTrue  )

pure virtual

Get the schema of the data source. The schema describes the data fields and may contain additional information about the ui names of the data fields and the primary key. Here is an example:

<key type="text" uiname="Key"> <image type="image" uiname="Image"> <date type="text" uiname="Date"> <filename type="text" uiname="File Name"> </schema>

Parameters

dataStream	specifies the stream containing the data.
defaultParams	if true use default parameters else retrieve parameteres via UI

Returns

IPMStream or nil if schema s not provided. Check for ErrorUtils::PMGetGlobalErrorCode().

virtual IPMStream* IDataServices::TransformContent ( IPMStream *  stream, IPMUnknown *  transformData = nil  ) const

pure virtual

Transform a stream, typically XML from one format to another. Everything is stream based. Returns a new stream, which has been transformed. Caller is responsible for releasing the new stream.

Parameters

stream	specifies the stream containing the data.
transformData	specifies data that describes how the transformation.

Returns

IPMStream

virtual IPMStream* IDataServices::TransformContent ( IPMStream *  stream, IDataTransform::Parameters &  params, bool16  defaultParams = kTrue  )

pure virtual

Transform a stream, typically XML from one format to another. Everything is stream based. Returns a new stream, which has been transformed. Caller is responsible for releasing the new stream.

Parameters

stream	specifies the stream containing the data.
params	specifies parameters that should be used for the transformation.
transformData	specifies data that describes how the transformation.

Returns

IPMStream