com.rapidminer.report
Interface ReportStream

public interface ReportStream

This is the basic interface for all streams for reportable items. Subclasses might implement streams for different file formats.

Author:

Sebastian Land, Ingo Mierswa, Helge Homburg

Method Summary

void	addPageBreak() This method will cause the stream to add a page break to the stream.
void	append(java.lang.String name, Reportable reportable, int width, int height) This method will cause the stream to append a readable to the stream.
void	close() This method is called to free all resourcess and finish writing if needed.
java.lang.String	getName() Returns the string name of this stream.
void	startSection(java.lang.String sectionName, int sectionLevel) This method will cause the stream to start a new Section at the specified level.

Method Detail

getName

java.lang.String getName()

Returns the string name of this stream.

addPageBreak

void addPageBreak()

This method will cause the stream to add a page break to the stream.

startSection

void startSection(java.lang.String sectionName,
                  int sectionLevel)
                  throws ReportException

This method will cause the stream to start a new Section at the specified level.

Parameters:

sectionName -

sectionLevel -

Throws:

ReportException

append

void append(java.lang.String name,
            Reportable reportable,
            int width,
            int height)
            throws ReportException

This method will cause the stream to append a readable to the stream.

Throws:

ReportException

close

void close()
           throws ReportException

This method is called to free all resourcess and finish writing if needed.

Throws:

ReportException