com.saperion.connector.renditions

Interface Rendition

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BaseRendition, FileSystemRendition

public interface Rendition
extends AutoCloseable

A Rendition interface, generated by the render engine that represents incoming content stream and outgoing format of the rendered file.

Method Summary

Modifier and Type	Method and Description
int	getPage() Returns the number of the page represented by this rendition.
com.saperion.common.io.InputStreamDescriptor	getStream() Returns the content as InputStreamDescriptor generated by the render engine.
TargetFormat	getTarget() Returns the TargetFormat of the rendered file.
boolean	isComplete()

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getStream

com.saperion.common.io.InputStreamDescriptor getStream()
                                                throws Exception

Returns the content as InputStreamDescriptor generated by the render engine.

Returns:

InputStreamDescriptor generated by the render engine.

Throws:

Exception

getTarget

TargetFormat getTarget()

Returns the TargetFormat of the rendered file. It depends on the render engine, if it renders to the passed format or not. Means, it can be, that you specify to render to PDF, but it returns a multipage tiff.

Returns:

TargetFormat of the rendered file.

getPage

int getPage()

Returns the number of the page represented by this rendition.

Returns:

page number or -1 if the renditions contains multiple (or all) pages

isComplete

boolean isComplete()

Returns:

true if this rendition represents a complete document.