Package com.saperion.connector.renditions

Class FileSystemRendition

java.lang.Object

com.saperion.connector.renditions.BaseRendition

com.saperion.connector.renditions.FileSystemRendition

All Implemented Interfaces:

Rendition, java.lang.AutoCloseable

public class FileSystemRendition
extends BaseRendition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileSystemRendition()	Default constructor for instantiating the FileSystemRendition instance.

Method Summary

Modifier and Type	Method	Description
void	close()
java.io.File	getFile()
java.lang.String	getFilename()
int	getPage()	Returns the number of the page represented by this rendition.
InputStreamDescriptor	getStream()	Returns the content as InputStreamDescriptor generated by the render engine.
boolean	isComplete()
void	setFile(WrappedFile file)
void	setFilename(java.lang.String filename)

Methods inherited from class com.saperion.connector.renditions.BaseRendition

getTarget, setTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemRendition

protected FileSystemRendition()

Default constructor for instantiating the FileSystemRendition instance.

Method Detail

getStream

public InputStreamDescriptor getStream()
                                throws java.lang.Exception

Returns the content as InputStreamDescriptor generated by the render engine.

Returns:

InputStreamDescriptor generated by the render engine.

Throws:

java.lang.Exception

See Also:

Rendition.getStream()

getFilename

public java.lang.String getFilename()

Returns:

the filename

setFilename

public void setFilename(java.lang.String filename)

Parameters:

filename - the filename to set

getFile

public java.io.File getFile()

Returns:

the file

setFile

public void setFile(WrappedFile file)

Parameters:

file - the file to set

getPage

public 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

See Also:

Rendition.getPage()

isComplete

public boolean isComplete()

Returns:

true if this rendition represents a complete document.

See Also:

Rendition.isComplete()

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception