com.tsgrp.opencontent.universal.annotation

Class XFDFAnnotationImpl

java.lang.Object

com.tsgrp.opencontent.universal.annotation.AbstractXFDFAnnotationImpl

com.tsgrp.opencontent.universal.annotation.XFDFAnnotationImpl

All Implemented Interfaces:

IAnnotation

public class XFDFAnnotationImpl
extends AbstractXFDFAnnotationImpl

Nested Class Summary

Nested classes/interfaces inherited from class com.tsgrp.opencontent.universal.annotation.AbstractXFDFAnnotationImpl

AbstractXFDFAnnotationImpl.supportedAnnotationNameParams

Field Summary

Fields inherited from class com.tsgrp.opencontent.universal.annotation.AbstractXFDFAnnotationImpl

ASPOSE_ROTATION_0, ASPOSE_ROTATION_180, ASPOSE_ROTATION_270, ASPOSE_ROTATION_90, ENCODING_PREFIX, SIGNATURE_HEIGHT_OFFSET, TEXT_LINK_KEY, TILED_COMPATIBLE_EXTENSIONS, WORD_MAP_KEY

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

PDF_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
XFDFAnnotationImpl()

Method Summary

Modifier and Type	Method and Description
protected 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.
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 java.util.List<PDFAttachedDoc>	getAttachedDocs(org.apache.pdfbox.pdmodel.PDDocument document)
protected java.util.List<org.apache.pdfbox.pdmodel.PDPage>	getPagesFromDocument(org.apache.pdfbox.pdmodel.PDDocument document) Get a List of PDPages from the PDDocument object.

Methods inherited from class com.tsgrp.opencontent.universal.annotation.AbstractXFDFAnnotationImpl

checkinAnnotations, createVideoScreenshot, deleteAnnotations, getAnnotatedPDF, getAnnotations, getAnnotations, getAttachedDocs, getBookmarks, getDocumentInfo, getEmbeddedAnnotations, getExcelAnnotationSummary, getExternalAnnotationUrl, getFileAttachmentAnnotationContent, getInternalLinks, getPageDimensions, getPageDimensions, getPDFAnnotationSummary, getPdfMetadata, getProcessedPages, getRedactionSuggestions, getSingleAnnotation, getVideoScreenshots, getWordMapsAndTextLinks, getXFDFAndFDFAnnotations, ingestDocForExternalReview, isAnnotated, saveAnnotations, saveSignatures

Methods inherited from class java.lang.Object

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

Constructor Detail

XFDFAnnotationImpl

public XFDFAnnotationImpl()

Method Detail

getPagesFromDocument

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

Description copied from class: AbstractXFDFAnnotationImpl

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

Specified by:

getPagesFromDocument in class AbstractXFDFAnnotationImpl

Parameters:

document - a PDDocument representing the pdf document

Returns:

List of PDPages

buildWordMapAndTextLinks

protected 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

Description copied from class: AbstractXFDFAnnotationImpl

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

Specified by:

buildWordMapAndTextLinks in class AbstractXFDFAnnotationImpl

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

getAttachedDocs

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

Specified by:

getAttachedDocs in class AbstractXFDFAnnotationImpl

Throws:

java.io.IOException

getAttachedDocContent

public 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

Specified by:

getAttachedDocContent in class AbstractXFDFAnnotationImpl

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.