com.tsgrp.opencontent.universal.annotation

Class AbstractXFDFAnnotationImpl

java.lang.Object

com.tsgrp.opencontent.universal.annotation.AbstractXFDFAnnotationImpl

All Implemented Interfaces:

IAnnotation

Direct Known Subclasses:

XFDFAnnotationImpl

public abstract class AbstractXFDFAnnotationImpl
extends java.lang.Object
implements IAnnotation

Annotation services that comply with the XFDF specification.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractXFDFAnnotationImpl.supportedAnnotationNameParams

Field Summary

Fields

Modifier and Type	Field and Description
int	ASPOSE_ROTATION_0
int	ASPOSE_ROTATION_180
int	ASPOSE_ROTATION_270
int	ASPOSE_ROTATION_90
java.lang.String	ENCODING_PREFIX
int	SIGNATURE_HEIGHT_OFFSET
java.lang.String	TEXT_LINK_KEY
static java.util.List<java.lang.String>	TILED_COMPATIBLE_EXTENSIONS A static list of extensions that are compatible with the tiled mode of the slide viewer.
java.lang.String	WORD_MAP_KEY

Fields inherited from interface com.tsgrp.opencontent.universal.annotation.IAnnotation

PDF_MIMETYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXFDFAnnotationImpl()

Method Summary

Modifier and Type	Method and Description
protected abstract void	buildWordMapAndTextLinks(org.apache.pdfbox.pdmodel.PDDocument document, int startPage, int numPages, java.util.List<java.util.Map<java.lang.String,java.util.List<TSGIndexEntry>>> wordMaps, java.util.List<java.util.List<TSGInternalLink>> textLinks, java.util.List<org.apache.pdfbox.pdmodel.PDPage> allPages) Method to generate word maps and text links for the numPages pages in the given pdf starting at startPage.
java.util.Map<java.lang.String,java.lang.Object>	checkinAnnotations(java.lang.String ticket, java.lang.String userDisplayName, java.lang.String objectId, byte[] content, long lastModified) Checks in and saves the non-readonly annotations from an offline PDF under the given logged in user
VideoScreenshot	createVideoScreenshot(java.lang.String ticket, java.lang.String videoObjectId, int screenshotTimeMillis) Creates a screenshot from a video given a time Note that taking screenshots past 25 days is not supported
void	deleteAnnotations(java.lang.String ticket, java.lang.String objectId, java.lang.String creatorDisplayName, java.lang.String differentUser) Deletes the annotation object related to the provided objectId for the provided user.
void	getAnnotatedPDF(java.lang.String ticket, java.lang.String objectId, java.util.List<java.lang.String> annotators, java.lang.String username, boolean forOfflineAnnotation, boolean forPrint, long lastModified, boolean isCollection, java.io.OutputStream annotatedPdfOutputStream) Streams a PDF object with all annotations embedded inside to the given output stream.
java.util.List<Annotation>	getAnnotations(java.lang.String ticket, java.lang.String objectId, java.util.List<java.lang.String> annotators, long lastModified, boolean excludeEmbeddedAnnotations) Pulls all of the annotations for the given id, does not modify the annotation contents in any way.
java.util.Map<java.lang.String,java.lang.Object>	getAnnotations(java.lang.String ticket, java.lang.String objectId, long lastModified, boolean excludeEmbeddedAnnotations) Pulls all of the annotations for the given id, does not modify the annotation contents in any way.
abstract byte[]	getAttachedDocContent(java.lang.String ticket, java.lang.String objectId, long lastModified, java.lang.String attachedDocName) Returns content of an attached document for an object.
protected abstract java.util.List<PDFAttachedDoc>	getAttachedDocs(org.apache.pdfbox.pdmodel.PDDocument document)
java.util.List<PDFAttachedDoc>	getAttachedDocs(java.lang.String ticket, java.lang.String objectId, long lastModified) Retrieves a list of all attached documents contained in an object having a pdf rendition.
java.util.List<PDFBookmark>	getBookmarks(java.lang.String ticket, java.lang.String objectId, long lastModified) Parses the bookmarks contained in an object having a pdf rendition.
DocumentInfo	getDocumentInfo(java.lang.String ticket, java.lang.String objectId, long lastModified, java.lang.String forceViewer, java.lang.Integer numOfPageDimensionsToFetch, java.lang.Integer docSizeLoadLimitBytes) Populates the document information for the passed in document objectId.
java.util.Map<java.lang.String,java.lang.Object>	getEmbeddedAnnotations(java.lang.String ticket, java.lang.String objectId, long lastModified, boolean parseFileData) Gets only the embedded annotations off of the document.
java.io.ByteArrayOutputStream	getExcelAnnotationSummary(java.lang.String ticket, java.lang.String objectId, java.lang.String dateFormat, Annotation[] annotations) Returns a summary of the annotation on a given object in a printable (.xls) format.
java.lang.String	getExternalAnnotationUrl(java.lang.String ticket, java.lang.String legacyId) A method for use with OA as a Service that will attempt to return an annotation URL based on a legacy ID.
byte[]	getFileAttachmentAnnotationContent(java.lang.String ticket, java.lang.String objectId, long lastModified, boolean isEmbedded, java.lang.String annotationName) Returns content of a file attachment annotation document for an object.
java.util.List<java.util.List<TSGInternalLink>>	getInternalLinks(java.lang.String ticket, java.lang.String objectId, int startPage, int numPages, long lastModified) Returns the internal links that are on a PDF document.
Page[]	getPageDimensions(java.lang.String ticket, Page[] pages, boolean isCollection) Determines the height and width of an array of Pages
Page	getPageDimensions(java.lang.String ticket, java.lang.String objectId, Page page, java.lang.String fileExtension, long lastModified) Determines the height and width of Page
protected abstract java.util.List<org.apache.pdfbox.pdmodel.PDPage>	getPagesFromDocument(org.apache.pdfbox.pdmodel.PDDocument document) Get a List of PDPages from the PDDocument object.
java.io.ByteArrayOutputStream	getPDFAnnotationSummary(java.lang.String ticket, java.lang.String objectId, java.lang.String dateFormat, java.util.List<Annotation> annotations) Returns a summary of the annotation on a given object in a printable (.pdf) format.
java.util.Map<java.lang.String,java.lang.Object>	getPdfMetadata(java.lang.String ticket, java.lang.String objectId, int startPage, int numPages, long lastModified) Returns the internal links that are on a PDF document.
PostSectionedPage[]	getProcessedPages(java.lang.String ticket, java.lang.String objectId, int startPage, int numPages, long lastModified) Parses an object's PDF rendition and returns a page object that contains data representations of rectangles surrounding sections, rows and words.
java.util.List<RedactionSuggestion>	getRedactionSuggestions(java.lang.String ticket, java.lang.String objectId, long lastModified, int numPages) A method which calls a helper method to generate suggested redactions
Annotation	getSingleAnnotation(java.lang.String ticket, java.lang.String objectId, long lastModified, boolean isEmbedded, java.lang.String annotationName) Pulls the specific annotation from the annotations on the document based on the annotationName.
java.util.Map<java.lang.Integer,VideoScreenshot>	getVideoScreenshots(java.lang.String ticket, java.lang.String videoObjId) Gets all video screenshots for a video
java.util.Map<java.lang.String,java.lang.Object>	getWordMapsAndTextLinks(java.lang.String ticket, java.lang.String objectId, int startPage, int numPages, long lastModified) Parses an object's PDF rendition and returns an array of indexes (word maps) that can be used to search on the given range of pages.
java.util.List<Annotation>	getXFDFAndFDFAnnotations(java.lang.String ticket, java.lang.String objectId, long lastModified, boolean parseFileData) Gets only the annotations from the xfdf and/or fdf
java.lang.String	ingestDocForExternalReview(java.lang.String ticket, java.lang.String legacyId, java.lang.String type, java.lang.String parentId, java.util.Map<java.lang.String,java.lang.Object> properties, org.springframework.web.multipart.MultipartFile mpFile) A method for use with OA as a Service that will query the legacyId of a document to see if it already exists in the repository, and return the docId for the match.
boolean	isAnnotated(java.lang.String ticket, java.lang.String objectId) Returns true if the document contains annotations, false otherwise.
void	saveAnnotations(java.lang.String ticket, java.lang.String objectId, java.util.List<Annotation> annotations, java.lang.String differentUser, long lastModified) Saves the provided annotations, processing them differenly dependent on whether or not the process must be runAsAdmin
void	saveSignatures(java.lang.String ticket, java.lang.String objectId, Signature[] signatures) Saves the provided signatures, permanently modifying the provided document.

Methods inherited from class java.lang.Object

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

Field Detail

TILED_COMPATIBLE_EXTENSIONS

public static final java.util.List<java.lang.String> TILED_COMPATIBLE_EXTENSIONS

A static list of extensions that are compatible with the tiled mode of the slide viewer.

ENCODING_PREFIX

public final java.lang.String ENCODING_PREFIX

See Also:

Constant Field Values

SIGNATURE_HEIGHT_OFFSET

public final int SIGNATURE_HEIGHT_OFFSET

See Also:

Constant Field Values

WORD_MAP_KEY

public final java.lang.String WORD_MAP_KEY

See Also:

Constant Field Values

TEXT_LINK_KEY

public final java.lang.String TEXT_LINK_KEY

See Also:

Constant Field Values

ASPOSE_ROTATION_0

public final int ASPOSE_ROTATION_0

See Also:

Constant Field Values

ASPOSE_ROTATION_90

public final int ASPOSE_ROTATION_90

See Also:

Constant Field Values

ASPOSE_ROTATION_180

public final int ASPOSE_ROTATION_180

See Also:

Constant Field Values

ASPOSE_ROTATION_270

public final int ASPOSE_ROTATION_270

See Also:

Constant Field Values

Constructor Detail

AbstractXFDFAnnotationImpl

protected AbstractXFDFAnnotationImpl()

Method Detail

deleteAnnotations

public void deleteAnnotations(java.lang.String ticket,
                              java.lang.String objectId,
                              java.lang.String creatorDisplayName,
                              java.lang.String differentUser)

Description copied from interface: IAnnotation

Deletes the annotation object related to the provided objectId for the provided user.

Specified by:

deleteAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to delete the user's annotation object.

creatorDisplayName - the display name of the user to delete the annotation object.

differentUser - "true" if this action is being performed by a user other than the one specified by ownerName

saveSignatures

public void saveSignatures(java.lang.String ticket,
                           java.lang.String objectId,
                           Signature[] signatures)

Description copied from interface: IAnnotation

Saves the provided signatures, permanently modifying the provided document.

Specified by:

saveSignatures in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the document to save signatures for.

signatures - An array of signatures to save on the document.

saveAnnotations

public void saveAnnotations(java.lang.String ticket,
                            java.lang.String objectId,
                            java.util.List<Annotation> annotations,
                            java.lang.String differentUser,
                            long lastModified)

Description copied from interface: IAnnotation

Saves the provided annotations, processing them differenly dependent on whether or not the process must be runAsAdmin

Specified by:

saveAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to save annotations for.

annotations - a list of annotations to save on the document.

differentUser - "true" if this action is being performed by a user other than the one who's associated with the annotation array.

lastModified - The timestamp this object was last modified (used for caching purposes).

createVideoScreenshot

public VideoScreenshot createVideoScreenshot(java.lang.String ticket,
                                             java.lang.String videoObjectId,
                                             int screenshotTimeMillis)

Description copied from interface: IAnnotation

Creates a screenshot from a video given a time Note that taking screenshots past 25 days is not supported

Specified by:

createVideoScreenshot in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

videoObjectId - the objectId of the video.

screenshotTimeMillis - the start time of the video in milliseconds

Returns:

a VideoScreenshot object containing info about the created video screenshot

getVideoScreenshots

public java.util.Map<java.lang.Integer,VideoScreenshot> getVideoScreenshots(java.lang.String ticket,
                                                                            java.lang.String videoObjId)

Description copied from interface: IAnnotation

Gets all video screenshots for a video

Specified by:

getVideoScreenshots in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

videoObjId - of the video.

Returns:

a Map of VideoScreenshot objects, where the key is the screenshot time

isAnnotated

public boolean isAnnotated(java.lang.String ticket,
                           java.lang.String objectId)

Description copied from interface: IAnnotation

Returns true if the document contains annotations, false otherwise.

Specified by:

isAnnotated in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to check if it has annotations or not.

Returns:

true if document contains annotations, false otherwise.

getAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getAnnotations(java.lang.String ticket,
                                                                       java.lang.String objectId,
                                                                       long lastModified,
                                                                       boolean excludeEmbeddedAnnotations)

Description copied from interface: IAnnotation

Pulls all of the annotations for the given id, does not modify the annotation contents in any way.

Specified by:

getAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get annotations for.

lastModified - the last modified timestamp of the document.

excludeEmbeddedAnnotations - a boolean to determine whether or not PDF content needs to be retrieved.

Returns:

a map including annotations that are on the provided document as well as a boolean indicating whether or not the document contains a widget.

getAnnotations

public java.util.List<Annotation> getAnnotations(java.lang.String ticket,
                                                 java.lang.String objectId,
                                                 java.util.List<java.lang.String> annotators,
                                                 long lastModified,
                                                 boolean excludeEmbeddedAnnotations)

Description copied from interface: IAnnotation

Pulls all of the annotations for the given id, does not modify the annotation contents in any way.

Specified by:

getAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get annotations for.

annotators - a list of the annotators that you want to get the annotations of

lastModified - the last modified timestamp of the document.

excludeEmbeddedAnnotations - a boolean to determine whether or not PDF content needs to be retrieved.

Returns:

a map of annotations that are on the provided document.

getSingleAnnotation

public Annotation getSingleAnnotation(java.lang.String ticket,
                                      java.lang.String objectId,
                                      long lastModified,
                                      boolean isEmbedded,
                                      java.lang.String annotationName)

Description copied from interface: IAnnotation

Pulls the specific annotation from the annotations on the document based on the annotationName.

Specified by:

getSingleAnnotation in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get annotations for.

lastModified - the last modified timestamp of the document.

isEmbedded - the attribute on the annotation that says if it embedded or not

Returns:

the specific annotation that is on the document.

getEmbeddedAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getEmbeddedAnnotations(java.lang.String ticket,
                                                                               java.lang.String objectId,
                                                                               long lastModified,
                                                                               boolean parseFileData)

Description copied from interface: IAnnotation

Gets only the embedded annotations off of the document.

Specified by:

getEmbeddedAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get annotations for.

lastModified - the last modified timestamp of the document.

parseFileData - a boolean determining if file data should be parsed.

Returns:

a list of embedded annotations on the document.

getXFDFAndFDFAnnotations

public java.util.List<Annotation> getXFDFAndFDFAnnotations(java.lang.String ticket,
                                                           java.lang.String objectId,
                                                           long lastModified,
                                                           boolean parseFileData)

Description copied from interface: IAnnotation

Gets only the annotations from the xfdf and/or fdf

Specified by:

getXFDFAndFDFAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get annotations for.

lastModified - the last modified timestamp of the document.

parseFileData - a boolean determining if file data should be parsed.

Returns:

a list of annotations that are on the provided document.

getDocumentInfo

public DocumentInfo getDocumentInfo(java.lang.String ticket,
                                    java.lang.String objectId,
                                    long lastModified,
                                    java.lang.String forceViewer,
                                    java.lang.Integer numOfPageDimensionsToFetch,
                                    java.lang.Integer docSizeLoadLimitBytes)

Description copied from interface: IAnnotation

Populates the document information for the passed in document objectId. NOTE: This does not populate the documentProperties member of the returned DocumentInfo object.

Specified by:

getDocumentInfo in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to fetch the info for.

lastModified - the last modified timestamp of the document.

forceViewer - which viewer the requested document must use, or blank if viewer is to be fetched normally.

numOfPageDimensionsToFetch - how many pages to get height and width values for in a collection. If not passed in then will get all page dimensions

docSizeLoadLimitBytes - if document size is larger than this number don't return document info. Saves excessive load times/calls.

Returns:

the info of the document.

getAnnotatedPDF

public void getAnnotatedPDF(java.lang.String ticket,
                            java.lang.String objectId,
                            java.util.List<java.lang.String> annotators,
                            java.lang.String username,
                            boolean forOfflineAnnotation,
                            boolean forPrint,
                            long lastModified,
                            boolean isCollection,
                            java.io.OutputStream annotatedPdfOutputStream)

Description copied from interface: IAnnotation

Streams a PDF object with all annotations embedded inside to the given output stream. Returns error if the PDF can not be located, or if annotations fail to parse.

Specified by:

getAnnotatedPDF in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get the annotated PDF for.

annotators - a list of the annotators that you want to get the annotations of

username - the username of the user that is downloading the annotated PDF. This is used to color the annotations appropriately if enhancedColorMode is not turned on.

forOfflineAnnotation - True will result in the annotations being read-only in the downloaded PDF, annotations will be burned-in normally otherwise.

forPrint - True if the document is meant to immediately print when displayed in a browser. False otherwise.

lastModified - the last modified timestamp of the document.

isCollection - whether or not we're fetching a concatenated pdf for a collection NOTE - Annotations are not supported for collections

annotatedPdfOutputStream - the OutputStream to stream the PDF contents to

checkinAnnotations

public java.util.Map<java.lang.String,java.lang.Object> checkinAnnotations(java.lang.String ticket,
                                                                           java.lang.String userDisplayName,
                                                                           java.lang.String objectId,
                                                                           byte[] content,
                                                                           long lastModified)

Description copied from interface: IAnnotation

Checks in and saves the non-readonly annotations from an offline PDF under the given logged in user

Specified by:

checkinAnnotations in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

userDisplayName - the current user's display name

objectId - the objectId of the document to get the annotated PDF for.

content - the byte[] containing the uploaded file's content

lastModified - The timestamp this object was last modified (used for caching purposes). NOTE: Remove userDisplayName param when the functionality is put in place that allows for the userDisplayName to be retrieved from the passed in ticket

getProcessedPages

@Cacheable(value="oc-page-section-word-data",
           key="{#objectId, #startPage, #numPages, #lastModified}")
public PostSectionedPage[] getProcessedPages(java.lang.String ticket,
                                                                                                                                                                 java.lang.String objectId,
                                                                                                                                                                 int startPage,
                                                                                                                                                                 int numPages,
                                                                                                                                                                 long lastModified)

Description copied from interface: IAnnotation

Parses an object's PDF rendition and returns a page object that contains data representations of rectangles surrounding sections, rows and words. If the object does not have a PDF rendition, this method returns null.

Specified by:

getProcessedPages in interface IAnnotation

Parameters:

ticket - a valid OC ticket

objectId - the id of the PDF object to create section, row and word boxes for.

startPage - the first page number to generate the section, row and word boxes for.

numPages - the number of pages to fetch in a batch

lastModified - the timestamp this object was last modified (used for caching key generator).

Returns:

a page object containing a data representation of rectangles surrounding sections, rows and words, or null if the object does not have a PDF rendition.

getWordMapsAndTextLinks

@Cacheable(value="oa-search-word-maps",
           key="{#objectId, #startPage, #numPages, #lastModified}")
public java.util.Map<java.lang.String,java.lang.Object> getWordMapsAndTextLinks(java.lang.String ticket,
                                                                                                                                                                                              java.lang.String objectId,
                                                                                                                                                                                              int startPage,
                                                                                                                                                                                              int numPages,
                                                                                                                                                                                              long lastModified)

Description copied from interface: IAnnotation

Parses an object's PDF rendition and returns an array of indexes (word maps) that can be used to search on the given range of pages.

Specified by:

getWordMapsAndTextLinks in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object to create word maps for.

startPage - The first page to create word maps for.

numPages - The number of pages to generate maps for.

lastModified - The timestamp this object was last modified (used for caching key generator).

Returns:

A map containing two entries: first, a list of maps (one per page requested) of strings to index entries, and second, a list of hyperlinks detected on the document.

getPagesFromDocument

protected abstract java.util.List<org.apache.pdfbox.pdmodel.PDPage> getPagesFromDocument(org.apache.pdfbox.pdmodel.PDDocument document)

Get a List of PDPages from the PDDocument object. Note that this differs between PDFBox 1.8 and 2.0.

Parameters:

document - a PDDocument representing the pdf document

Returns:

List of PDPages

buildWordMapAndTextLinks

protected abstract void buildWordMapAndTextLinks(org.apache.pdfbox.pdmodel.PDDocument document,
                                                 int startPage,
                                                 int numPages,
                                                 java.util.List<java.util.Map<java.lang.String,java.util.List<TSGIndexEntry>>> wordMaps,
                                                 java.util.List<java.util.List<TSGInternalLink>> textLinks,
                                                 java.util.List<org.apache.pdfbox.pdmodel.PDPage> allPages)
                                          throws java.io.IOException

Method to generate word maps and text links for the numPages pages in the given pdf starting at startPage.

Parameters:

document - a PDDocument representing the pdf document

startPage - number of the first page to be generated

numPages - total number of pages to be generated

wordMaps - List of word maps for the pdf page range

textLinks - List of text links for the pdf page range

allPages - all the PDPage objects for the pdf page range

Throws:

java.io.IOException

getExcelAnnotationSummary

public java.io.ByteArrayOutputStream getExcelAnnotationSummary(java.lang.String ticket,
                                                               java.lang.String objectId,
                                                               java.lang.String dateFormat,
                                                               Annotation[] annotations)

Description copied from interface: IAnnotation

Returns a summary of the annotation on a given object in a printable (.xls) format.

Specified by:

getExcelAnnotationSummary in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object that we're getting a summary for.

dateFormat - A string representing how the dates in the summary should be formatted.

annotations - A list of annotation objects describing the annotations on our pdf.

Returns:

A ByteArrayOutputStream containing the data of an Excel Spreadsheet containing our summary.

getPDFAnnotationSummary

public java.io.ByteArrayOutputStream getPDFAnnotationSummary(java.lang.String ticket,
                                                             java.lang.String objectId,
                                                             java.lang.String dateFormat,
                                                             java.util.List<Annotation> annotations)

Description copied from interface: IAnnotation

Returns a summary of the annotation on a given object in a printable (.pdf) format.

Specified by:

getPDFAnnotationSummary in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object that we're getting a summary for.

dateFormat - A string representing how the dates in the summary should be formatted.

annotations - A list of annotation objects describing the annotations on our pdf.

Returns:

A ByteArrayOutputStream containing the data of a PDF containing our summary.

getBookmarks

public java.util.List<PDFBookmark> getBookmarks(java.lang.String ticket,
                                                java.lang.String objectId,
                                                long lastModified)

Description copied from interface: IAnnotation

Parses the bookmarks contained in an object having a pdf rendition.

Specified by:

getBookmarks in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object to get bookmarks for.

lastModified - The timestamp this object was last modified (used for caching purposes).

Returns:

A list of bookmark objects.

getAttachedDocs

public java.util.List<PDFAttachedDoc> getAttachedDocs(java.lang.String ticket,
                                                      java.lang.String objectId,
                                                      long lastModified)

Description copied from interface: IAnnotation

Retrieves a list of all attached documents contained in an object having a pdf rendition.

Specified by:

getAttachedDocs in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object to get attached documents for.

lastModified - The timestamp this object was last modified (used for caching purposes).

Returns:

A list of attached document objects.

getAttachedDocs

protected abstract java.util.List<PDFAttachedDoc> getAttachedDocs(org.apache.pdfbox.pdmodel.PDDocument document)
                                                           throws java.io.IOException

Throws:

java.io.IOException

getAttachedDocContent

public abstract byte[] getAttachedDocContent(java.lang.String ticket,
                                             java.lang.String objectId,
                                             long lastModified,
                                             java.lang.String attachedDocName)

Description copied from interface: IAnnotation

Returns content of an attached document for an object.

Specified by:

getAttachedDocContent in interface IAnnotation

objectId - The objectId of the PDF object to get attached document info for.

lastModified - The timestamp this object was last modified (used for caching purposes).

attachedDocName - The name of the attached document.

Returns:

attachedDocContent The Byte Array Output Stream of the attached document content.

getFileAttachmentAnnotationContent

public byte[] getFileAttachmentAnnotationContent(java.lang.String ticket,
                                                 java.lang.String objectId,
                                                 long lastModified,
                                                 boolean isEmbedded,
                                                 java.lang.String annotationName)

Description copied from interface: IAnnotation

Returns content of a file attachment annotation document for an object.

Specified by:

getFileAttachmentAnnotationContent in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object to get attached document info for.

lastModified - The timestamp this object was last modified (used for caching purposes).

isEmbedded - The attribute on the annotation that says if it embedded or not

annotationName - The name of the annotation that acts as a unique identifier.

Returns:

fileContent The Byte Array Output Stream of the fiel attachment document content.

getInternalLinks

public java.util.List<java.util.List<TSGInternalLink>> getInternalLinks(java.lang.String ticket,
                                                                        java.lang.String objectId,
                                                                        int startPage,
                                                                        int numPages,
                                                                        long lastModified)

Description copied from interface: IAnnotation

Returns the internal links that are on a PDF document.

Specified by:

getInternalLinks in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object to retrieve the internal links for.

startPage - The first page to retrieve internal links for.

numPages - The number of pages to retrieve internal linsk for for.

lastModified - The timestamp this object was last modified (used for caching key generator).

Returns:

A list of internal links for the given PDF document.

getPdfMetadata

public java.util.Map<java.lang.String,java.lang.Object> getPdfMetadata(java.lang.String ticket,
                                                                       java.lang.String objectId,
                                                                       int startPage,
                                                                       int numPages,
                                                                       long lastModified)

Description copied from interface: IAnnotation

Returns the internal links that are on a PDF document.

Specified by:

getPdfMetadata in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

objectId - The id of the PDF object to retrieve the internal links for.

startPage - The first page to retrieve internal links for.

numPages - The number of pages to retrieve internal linsk for for.

lastModified - The timestamp this object was last modified (used for caching key generator).

Returns:

A list of internal links for the given PDF document.

getPageDimensions

public Page getPageDimensions(java.lang.String ticket,
                              java.lang.String objectId,
                              Page page,
                              java.lang.String fileExtension,
                              long lastModified)
                       throws java.lang.Exception

Determines the height and width of Page

Specified by:

getPageDimensions in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the document to get the information for.

page - The page object that should be completed. Other info might already be present.

fileExtension - The pages file extension

lastModified - the last modified timestamp of the document we're getting the information for.

Returns:

A Page object with the height and width set.

Throws:

java.lang.Exception

getPageDimensions

public Page[] getPageDimensions(java.lang.String ticket,
                                Page[] pages,
                                boolean isCollection)
                         throws java.io.IOException

Determines the height and width of an array of Pages

Specified by:

getPageDimensions in interface IAnnotation

Parameters:

ticket - a valid OC ticket.

pages - The array of pages to find dimensions for

isCollection - Indicates if the Page array is from a collection or a pdf

Returns:

Throws:

java.io.IOException

getRedactionSuggestions

public java.util.List<RedactionSuggestion> getRedactionSuggestions(java.lang.String ticket,
                                                                   java.lang.String objectId,
                                                                   long lastModified,
                                                                   int numPages)

A method which calls a helper method to generate suggested redactions

Specified by:

getRedactionSuggestions in interface IAnnotation

Parameters:

ticket - - ticket of the Open Annotate session

objectId - - ID of the document

lastModified - - time of the last modification of the object

Returns:

A list of RedactionSuggestion objects containing the location, page number, and reason for the redaction

ingestDocForExternalReview

public java.lang.String ingestDocForExternalReview(java.lang.String ticket,
                                                   java.lang.String legacyId,
                                                   java.lang.String type,
                                                   java.lang.String parentId,
                                                   java.util.Map<java.lang.String,java.lang.Object> properties,
                                                   org.springframework.web.multipart.MultipartFile mpFile)
                                            throws java.io.IOException

Description copied from interface: IAnnotation

A method for use with OA as a Service that will query the legacyId of a document to see if it already exists in the repository, and return the docId for the match. If no match is found, the document is uploaded to the repository and the docId of the newly uploaded document is returned.

Specified by:

ingestDocForExternalReview in interface IAnnotation

Parameters:

ticket - - A valid OC ticket.

legacyId - - The legacy id of the object we want to upload to or access from the repository.

type - - The Document type to use for the newly created external review document.

parentId - - The objectId for the parent folder or object that the external review document will be placed in.

properties - - A map of additional properties to be placed on the newly uploaded external review document.

mpFile - - The a file object with content and file properties of the newly uploaded document.

Returns:

An annotation url for the document in the repository, or null if no such document exists.

Throws:

java.io.IOException

getExternalAnnotationUrl

public java.lang.String getExternalAnnotationUrl(java.lang.String ticket,
                                                 java.lang.String legacyId)
                                          throws OCRuntimeException

Description copied from interface: IAnnotation

A method for use with OA as a Service that will attempt to return an annotation URL based on a legacy ID.

Specified by:

getExternalAnnotationUrl in interface IAnnotation

Parameters:

ticket - A valid OC ticket.

legacyId - - The legacy id of the object we want to access from the repository.

Returns:

An annotation url for the document in the repository, or null if no such document exists.

Throws:

OCRuntimeException