com.tsgrp.opencontent.openannotate

Class OpenAnnotateImpl

java.lang.Object

com.tsgrp.opencontent.openannotate.OpenAnnotateImpl

All Implemented Interfaces:

IOpenAnnotate

public class OpenAnnotateImpl
extends java.lang.Object
implements IOpenAnnotate

Transformation implementation which takes care of resolving the compatible transformers given the source/target mimetype and performing the transformation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenAnnotateImpl()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Integer>	getChildrenPages(PDFBookmark bookmark)
int	getPageCount(java.lang.String pdfId, java.lang.String ticket)
protected java.util.List<java.lang.Integer>	parseTargetPages(java.lang.String ticket, java.lang.String objectId, java.lang.String targetPages, long lastModified, int pageCount, java.lang.String baseURL) Get all pages with bookmarks on them to be precached.
void	precacheDocumentPages(java.lang.String ticket, java.lang.String objectId, java.lang.String targetPages, long lastModified, java.lang.String sourceMimetype, java.lang.String targetMimetype, java.lang.Integer resolution, java.lang.String baseURL) Performs a transformation of each of the commonly visited pages of a PDF, so that they will be pre-cached when the user views the document.
byte[]	transform(java.lang.String ticket, java.lang.String objectId, long lastModified, java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Grabs the content of the object represented by the passed in objectId from the repository that matches the "sourceMimeType" and performs a transformation into the "targetMimeType" given the optional map of arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAnnotateImpl

protected OpenAnnotateImpl()

Method Detail

transform

@Cacheable(value="oc-pages",
           key="{#objectId, #lastModified, #soureMimetype, #targetMimetype, #options?.pageNumber, #options?.pageRange, #options?.resolution, #options?.useOverlays, #options?.imageWidth}")
public byte[] transform(java.lang.String ticket,
                                                                                                                                                                                                                                                   java.lang.String objectId,
                                                                                                                                                                                                                                                   long lastModified,
                                                                                                                                                                                                                                                   java.lang.String sourceMimetype,
                                                                                                                                                                                                                                                   java.lang.String targetMimetype,
                                                                                                                                                                                                                                                   TransformationOptions options)

Description copied from interface: IOpenAnnotate

Grabs the content of the object represented by the passed in objectId from the repository that matches the "sourceMimeType" and performs a transformation into the "targetMimeType" given the optional map of arguments. This method takes in a 'lastModified' parameter that enables transformations to be cached. Transformations are cached based on a hash of their: objectId, lastModified, sourceMimeType, targetMimeType, pageNumber, resolution. Unfortunately, this must return a byte[] to be able to take advantage of ehCache, so this is fairly memory inefficient.

Specified by:

transform in interface IOpenAnnotate

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the object whose content should be transformed.

lastModified - The last modified timestamp of the object being transformed.

sourceMimetype - The mimetype of the content that is being transformed.

targetMimetype - The mimetype that the transformed content should be.

options - The TransformationOptions to use for transforming the content.

Returns:

A byte[] of the transformed content.

precacheDocumentPages

public void precacheDocumentPages(java.lang.String ticket,
                                  java.lang.String objectId,
                                  java.lang.String targetPages,
                                  long lastModified,
                                  java.lang.String sourceMimetype,
                                  java.lang.String targetMimetype,
                                  java.lang.Integer resolution,
                                  java.lang.String baseURL)
                           throws OCRuntimeException

Description copied from interface: IOpenAnnotate

Performs a transformation of each of the commonly visited pages of a PDF, so that they will be pre-cached when the user views the document.

Specified by:

precacheDocumentPages in interface IOpenAnnotate

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the object whose content should be transformed.

targetPages - A comma separated list of pages to transform. Each item can be a page number or one of the following special constants: - "bookmarks" - Transforms the destination page of every document level bookmark. - "last" - The last page of the document.

lastModified - The last modified timestamp of the object being transformed.

sourceMimetype - The mimetype of the content that is being transformed.

targetMimetype - The mimetype that the transformed content should be.

Throws:

OCRuntimeException - If an error occurs resizing the content to the requested width.

parseTargetPages

protected java.util.List<java.lang.Integer> parseTargetPages(java.lang.String ticket,
                                                             java.lang.String objectId,
                                                             java.lang.String targetPages,
                                                             long lastModified,
                                                             int pageCount,
                                                             java.lang.String baseURL)

Get all pages with bookmarks on them to be precached.

Parameters:

targetPages -

Returns:

getChildrenPages

public java.util.List<java.lang.Integer> getChildrenPages(PDFBookmark bookmark)

getPageCount

public int getPageCount(java.lang.String pdfId,
                        java.lang.String ticket)
                 throws java.io.IOException

Throws:

java.io.IOException