Package org.faceless.publisher.output

Interface ReportOutput

All Superinterfaces:

org.faceless.publisher.output.ReportCanvasContext

All Known Implementing Classes:

PDFReportOutput, SVGReportOutput

public interface ReportOutput
extends org.faceless.publisher.output.ReportCanvasContext

A ReportOutput is used to render a Report to some sort of Output.

See Also:

• ReportFactory.createReportOutput(org.faceless.publisher.type.MediaType)

Method Summary

Modifier and Type	Method	Description
void	addDataList(String id, List<String> options)
MediaType	getMediaType()	Return the type of object that would be written by write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.
boolean	isPageBlank()	Return true if the current page is blank
void	markPage()	Record that this page is not blank
void	write(OutputStream out)	Write the object generated by this ReportOutput to the specified OutpuStream.

Method Details

isPageBlank

boolean isPageBlank()

Return true if the current page is blank

markPage

void markPage()

Record that this page is not blank

Specified by:

markPage in interface org.faceless.publisher.output.ReportCanvasContext

addDataList

void addDataList(String id,
 List<String> options)

write

void write(OutputStream out)
    throws IOException

Write the object generated by this ReportOutput to the specified OutpuStream. The exact object written is instance dependent, and if no single file is appropriate this method may throw an UnsupportedOperationException.

Throws:

IOException - if generated when writing.

UnsupportedOperatonException - if this type of Output does not write to a single file.

IllegalStateExeption - if called before the render has sucessfully completed

getMediaType

MediaType getMediaType()

Return the type of object that would be written by write(java.io.OutputStream), or if that method doesn't apply, the type of Media generated by this ReportOutput.