Package com.saperion.ngc.servlet

Interface AnnotationConverter

All Known Implementing Classes:
JadiceAnnotationConverter
public interface AnnotationConverter
Interface for annotation-converters.

  • Method Summary

    Modifier and Type
    Method
    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(jakarta.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.

  • Method Details

    • setSession

      void setSession(jakarta.servlet.http.HttpSession session)
      Passes the current session to the converter, if it is available.
      Parameters:
      session - the session

    • setEmpty

      void setEmpty(boolean empty)
      Used to notify the converter that the document has no annotations.
      Parameters:
      empty - true if the document has no annotations

    • setDocumentInfos

      void setDocumentInfos(OpenDocumentBean openDocumentBean)
      Used to pass information about the document to the converter.
      Parameters:
      openDocumentBean - the bean containing information about the opened document

    • convert

      byte[] convert(String original, String ixosAnnotationsIni, int ixosPage) throws ConvertAnnotationException
      Converts the annotations to the desired format.
      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

    • setViewerId

      void setViewerId(String viewerId)
      Used to pass the ID of the viewer that requested the annotations to the converter.
      Parameters:
      viewerId - ID of the viewer

    • setDimension

      void setDimension(int width, int height)
      Set document dimension.
      Parameters:
      width - Width
      height - Height