jet.datasource

Interface JRUserStreamFactory

public interface JRUserStreamFactory

The JRUserStreamFactory is a factory of input steams. It can create more than one input stream which have same data structure. The content can be XML, JSON, Plain text, Excel File etc. Purpose: To create more than one input stream, all the streams have same data structure, but different objects.

Since:

Logi Report V14.

Method Summary

Modifier and Type	Method and Description
boolean	createInputStream(InformationBus infoBus, java.lang.String param) Creates a set of input stream by the parameters.
java.io.InputStream	getInputStream() Retrieves the current result as a InputStream object.
boolean	nextInputStream() Moves to the next InputStream.
void	releaseInputStream() Release the inputStream and related resources.

Method Detail

createInputStream

boolean createInputStream(InformationBus infoBus,
                          java.lang.String param)
                   throws JRUserDataSourceException

Creates a set of input stream by the parameters.

Parameters:

infoBus - A object which implemented InformationBus. User can set informaiton to this bus, or get information from this bus.

param - The parameter that the user used to get resultset. It is defined in a user data source.

Throws:

JRUserDataSourceException: - JRUserDataSourceException occurs when original data is invalid. eg. error uri, specified file not exist.

JRUserDataSourceException

nextInputStream

boolean nextInputStream()
                 throws JRUserDataSourceException

Moves to the next InputStream.

Returns:

true if there is another InputStream, and point to it. You must then use the methods getInputStream to get. false if there are no more InputStream.

Throws:

JRUserDataSourceException

getInputStream

java.io.InputStream getInputStream()
                            throws JRUserDataSourceException

Retrieves the current result as a InputStream object. This method should be called only once per result.

Returns:

a InputStream. InputStream @see java.io#InputStream

Throws:

JRUserDataSourceException

releaseInputStream

void releaseInputStream()
                 throws JRUserDataSourceException

Release the inputStream and related resources.

Throws:

JRUserDataSourceException - if a data access error occurs