com.saperion.ngc.viewer.virtualviewer.annotation

Class VirtualViewerAnnotationConverter

java.lang.Object

com.saperion.ngc.viewer.virtualviewer.annotation.VirtualViewerAnnotationConverter

All Implemented Interfaces:

AnnotationConverter

public class VirtualViewerAnnotationConverter
extends Object
implements AnnotationConverter

Converts the annotations to a format readable by Snowbound VirtualViewer.

Constructor Summary

Constructors

Constructor and Description
VirtualViewerAnnotationConverter()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	convert(String original, String ixosAnnotationsIni, int ixosPage) Converts the annotations to the desired format.
void	setDimension(int width, int height) Set document dimension.
void	setDocumentInfos(OpenDocumentBean openDocumentBean) Used to pass information about the document to the converter.
void	setEmpty(boolean empty) Used to notify the converter that the document has no annotations.
void	setSession(javax.servlet.http.HttpSession session) Passes the current session to the converter, if it is available.
void	setViewerId(String viewerId) Used to pass the ID of the viewer that requested the annotations to the converter.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualViewerAnnotationConverter

public VirtualViewerAnnotationConverter()

Method Detail

setSession

public void setSession(javax.servlet.http.HttpSession session)

Passes the current session to the converter, if it is available.

Specified by:

setSession in interface AnnotationConverter

Parameters:

session - the session

See Also:

AnnotationConverter.setSession(javax.servlet.http.HttpSession)

setEmpty

public void setEmpty(boolean empty)

Used to notify the converter that the document has no annotations.

Specified by:

setEmpty in interface AnnotationConverter

Parameters:

empty - true if the document has no annotations

See Also:

AnnotationConverter.setEmpty(boolean)

setViewerId

public void setViewerId(String viewerId)

Used to pass the ID of the viewer that requested the annotations to the converter.

Specified by:

setViewerId in interface AnnotationConverter

Parameters:

viewerId - ID of the viewer

See Also:

AnnotationConverter.setViewerId(java.lang.String)

setDocumentInfos

public void setDocumentInfos(OpenDocumentBean openDocumentBean)

Used to pass information about the document to the converter.

Specified by:

setDocumentInfos in interface AnnotationConverter

Parameters:

openDocumentBean - the bean containing information about the opened document

See Also:

AnnotationConverter.setDocumentInfos(com.saperion.ngc.viewer.OpenDocumentBean)

convert

public byte[] convert(String original,
             String ixosAnnotationsIni,
             int ixosPage)
               throws ConvertAnnotationException

Converts the annotations to the desired format.

Specified by:

convert in interface AnnotationConverter

Parameters:

original - original annotations represented as String

ixosAnnotationsIni - IXOS annotations

ixosPage - IXOS page number

Returns:

converted annotations represented as byte array

Throws:

ConvertAnnotationException - when converting the annotations failed

See Also:

com.saperion.ngc.servlet.AnnotationConverter#convert(java.lang.String)

setDimension

public void setDimension(int width,
                int height)

Description copied from interface: AnnotationConverter

Set document dimension.

Specified by:

setDimension in interface AnnotationConverter

Parameters:

width - Width

height - Height