com.crystaldecisions.sdk.occa.report.data
Interface IXMLDataSet

All Known Implementing Classes:
XMLDataSet

public interface IXMLDataSet

The XMLDataSet object is a runtime data source that determines the set of data that is displayed by a report. You must access the XML data and convert it to a java.io.InputStream and then read from the stream object into the byte array. Once the data set has been created, you can set the data source with the DatabaseController object’s setDataSource method. The DatabaseController object's replaceConnection method can then be used to replace one data set with another.

The data structure and the data in this object will persist with the report if the setEnableSaveDataWithReport is set to true. The report cannot reconnect to the original data source, since the XMLDataSet object and other objects that are used to construct it only exist at run-time. To reconnect to the original data source, you must create these objects and call the DatabaseController object’s setDataSource method again.

Supported schemas are those that are supported by the current XML data driver, which allows access to the XML data as a local file, a URL, or a web service.


Method Summary
 IByteArray getXMLData()
           Gets the XML data that is used as the source of the data set.
 IByteArray getXMLSchema()
           Gets the XML Schema for the XML data that is used as the source of the data set.
 void setXMLData(IByteArray xmlData)
           Sets the XML data that is used as the source of the data set.
 void setXMLSchema(IByteArray xmlSchema)
           Sets the XML Schema for the XML data that is used as the source of the data set.
 

Method Detail

setXMLData

void setXMLData(IByteArray xmlData)

Sets the XML data that is used as the source of the data set.

Parameters:
xmlData - the IByteArray object that specifies the XML data that is used as the source of the data set

getXMLData

IByteArray getXMLData()

Gets the XML data that is used as the source of the data set.

Returns:
A IByteArray object that specifies the XML data that is used as the source of the data set.

setXMLSchema

void setXMLSchema(IByteArray xmlSchema)

Sets the XML Schema for the XML data that is used as the source of the data set.

Parameters:
xmlSchema - the IByteArray object that specifies the XML schema that is used as the source of the data set

getXMLSchema

IByteArray getXMLSchema()

Gets the XML Schema for the XML data that is used as the source of the data set.

Returns:
A IByteArray object that specifies the XML Schema for the XML data that is used as the source of the data set.