com.tsgrp.opencontent.transformation

Interface IOpenAnnotate

All Known Implementing Classes:

OpenAnnotateImpl

public interface IOpenAnnotate

An interface for transforming content.

Method Summary

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

Method Detail

transform

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. 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.

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

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

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.

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.

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.

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

Throws:

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