com.tsgrp.opencontent.universal.annotation

Class XFDFUtil

java.lang.Object

com.tsgrp.opencontent.universal.annotation.XFDFUtil

public class XFDFUtil
extends java.lang.Object

Util methods for annotation services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XFDFUtil.unsupportedAnnotationTypes

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_NEXT_NUMBER
static java.lang.String	ATTR_OBJECT_ID
static java.lang.String	ATTR_OBJECT_TYPE_NAME
static java.lang.String	ATTR_PREFIX
static java.lang.String	ATTR_SUFFIX
static java.lang.String	BR_CLOSING_TAG A close tag
static java.lang.String	BR_TAG A tag
static java.lang.String	BREAK_TAG_ELEMENT_STRING The string for br tag elements
static double	CARET_GROWTH_RATE The rate at which the caret annotation grows when downloaded from OA due to an IText bug.
static java.lang.String	CLOSE_SPAN A tag closing a span
static java.lang.String	CLOSING_P_TAG A tag closing a
static java.lang.String	CONTROLLED_PRINT_AUDIT
static java.lang.String	CONTROLLED_PRINT_AUTONUMBER
static java.lang.String	CONTROLLED_PRINT_OBJECT_TYPE
static java.lang.String	currentDateKey
static java.lang.String	DATE_FORMAT_STRING Date Format for parsing XFDF dates
static java.lang.String	DUMMY_DEFAULT_APPEARANCE Dummy string variable for the defaultappearance attribute of freetext annotations
static java.lang.String	DUMMY_DEFAULT_STYLE Dummy string variable for the defaultstyle attribute of freetext annotations
static java.lang.String	DUMMY_SPAN_STYLE Dummy string variable for the style attribute of each span that gets created for a text box annotation.
static java.lang.String	EMPTY_XFDF An empty XFDF string.
static java.lang.String	ENCODING_PREFIX The encoding prefix used when decoding dynamic stamps.
static java.lang.String	END_STATUS_XFDF_CONTENTS_RICHTEXT XFDF end tags for a status' content.
static java.lang.String	END_XFDF_CONTENTS_RICHTEXT XFDF end tags for content.
static java.lang.String	EXTENSION_XFDF The file extension for an XFDF file.
static java.lang.String	FAILED_USERNAMES
static java.lang.String	IT_FREETEXT_CALLOUT The IT value for a callout annotation.
static org.jdom.Namespace	NAMESPACE_XFDF The XFDF namespace.
static org.jdom.Namespace	NAMESPACE_XHTML The XHTML namespace.
static java.lang.String	NUM_CHECKED_IN_ANNOTS
static com.itextpdf.text.pdf.PdfName	PDFNAME_CL CL stands for Callout.
static com.itextpdf.text.pdf.PdfName	PDFNAME_COMMENT Comment is a type of PdfName.NAME, which is the symbol for the annotation.
static com.itextpdf.text.pdf.PdfName	PDFNAME_DS DS stands for default style
static com.itextpdf.text.pdf.PdfName	PDFNAME_GROUP Group is a type of reply.
static com.itextpdf.text.pdf.PdfName	PDFNAME_ICON Icon corresponds to the Name key
static com.itextpdf.text.pdf.PdfName	PDFNAME_IT IT stands for intention.
static com.itextpdf.text.pdf.PdfName	PDFNAME_LE LE stands for the line end of the head.
static com.itextpdf.text.pdf.PdfName	PDFNAME_REPLACE Replace is a type of Intention.
static com.itextpdf.text.pdf.PdfName	PDFNAME_STATEMODEL StateModel values are Marked and Review.
static com.itextpdf.text.pdf.PdfName	PDFNAME_STRIKE_OUT_TEXT_EDIT StrikeOutTextEdit is a type of Intention.
static com.itextpdf.text.pdf.PdfName	PDFNAME_SUBJ Subject is the short description of the subject being addressed by the annotation.
static java.lang.String	REPLY_FLAGS_STRING The flags attribute needs to saved on statuses for PAS compatibility.
static java.lang.String	START_STATUS_XFDF_CONTENTS_RICHTEXT XFDF body tag start for saving a status' content.
static java.lang.String	START_TAG_XFDF_CONTENTS_RICHTEXT XFDF body tag start for parsing content.
static java.lang.String	START_XFDF_CONTENTS_RICHTEXT XFDF body tag start for saving content.
static java.lang.String	TYPE_ACCEPT_STAMP The type for an Accept stamp
static java.lang.String	TYPE_APPROVED_STAMP The type for a stamp
static java.lang.String	TYPE_CALLOUT The type for a callout annotation.
static java.lang.String	TYPE_CARET The type for a caret annotation (also know as an "Insert Text at Placeholder" annotation).
static java.lang.String	TYPE_ELLIPSE The type for an oval annotation.
static java.lang.String	TYPE_FILE_ATTACHMENT The type for a fileattachment annotation.
static java.lang.String	TYPE_FREEDRAW The type for a freedraw annotation.
static java.lang.String	TYPE_FREETEXT The type for a freetext annotation.
static java.lang.String	TYPE_HIGHLIGHT The type for a highlight annotation.
static java.lang.String	TYPE_LINE The type for a line or arrow annotation.
static java.lang.String	TYPE_PAGESIZEDCHECKMARK_STAMP The type for a Page Sized Checkmark stamp
static java.lang.String	TYPE_RECTANGLE The type for a rectangle annotation.
static java.lang.String	TYPE_REJECT_STAMP The type for a Reject stamp
static java.lang.String	TYPE_REPLACEMENT_TEXT The type for a special caret annotation (also know as an "Replacement Text at Placeholder" annotation).
static java.lang.String	TYPE_REPLY The type for a reply annotation.
static java.lang.String	TYPE_REVIEWED_STAMP The type for a Reviewed stamp
static java.lang.String	TYPE_STATUS The type for a status annotation.
static java.lang.String	TYPE_STICKY_NOTE The type for a sticky note annotation.
static java.lang.String	TYPE_STRIKEOUT The type for a strikeout annotation.
static java.lang.String	TYPE_UNDERLINE The type for an underline annotation.
static java.lang.String[]	VALID_ANNOTATIONS The list of all valid annotation types.
static java.lang.String	XML_VERSION The version of XML being used to write our XFDF.

Constructor Summary

Constructors

Constructor and Description
XFDFUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildRichTextSpan(java.lang.Boolean isItalic, java.lang.Boolean isBold, java.lang.Boolean isUnderline, java.lang.String color) Builds our rich text styling from the html styling from OA
static void	burnInAnnotations(com.itextpdf.text.pdf.PdfReader pdfReader, com.itextpdf.text.pdf.PdfStamper stamper, java.lang.String objectId, java.util.List<Annotation> annotations, java.lang.String userDisplayName, boolean forOfflineAnnotation, java.lang.String ticket, long lastModified) Burns the provided annotations into the supplied PDF document.
static java.lang.String	computeAnnotationConfigPlaceholder(java.lang.String ticket, java.lang.String param, java.lang.String objectId, java.lang.String displayName) Takes an individual parameter and returns the value associated with it using supportedAnnotationNameParms enum
static void	controlledPrintOverlay(java.lang.String ticket, java.lang.String objectId) Deprecated.
static java.lang.String	escapeXFDF(java.lang.String original) Utility method to escape an XFDF string by converting tags to their escaped values.
static java.lang.String	executeRegexMatching(java.lang.String contentString, java.lang.String regexPattern) Saves a provided annotation at the end of a supplied XFDF document (in the "annots" element).
static java.util.List<Annotation>	filterAnnotationsByFlag(int flagBit, java.util.List<Annotation> annotations) Filters out annotations that have a designated bit set to true
static java.util.List<Annotation>	filterAnnotationsByUser(java.lang.String userDisplayName, java.util.List<Annotation> annotations) Filters out annotations not associated with current user
static com.aspose.pdf.Document	flattenPDFPortfolio(com.aspose.pdf.Document pdfPortfolio, DocumentInfo documentInfo) Loops through each of the embedded files in a PDF Portfolio and puts all the content into a single PDF document Currently only handles embedded pdfs.
static java.util.List<Annotation>	flattenReplies(java.util.List<Annotation> annotations) Flattens any reply chains that exist amongst reply-type annotations to a maximum of: .
static java.util.List<java.lang.String>	getAnnotatableTypesByViewer(AnnotationConfig config, java.lang.String viewer) Gets a filtered list of content extensions that use the a certain viewer.
static int	getAnnotationCount(org.jdom.Document xfdfDoc) Return how many annotations are in the parameterized xfdfDoc.
protected static java.lang.String	getAutonumberObjectId(java.lang.String ticket, java.lang.String objectTypeName) Gets the object ID of the Autonumber object for the given page set name
static java.lang.String	getNextAutoNumber(java.lang.String ticket, java.lang.String objectTypeName)
static DocumentInfo	getPdfDocumentInfo(java.lang.String ticket, java.lang.String objectId, java.lang.String mimetype, java.lang.Integer docSizeLoadLimitBytes, java.lang.String[] fileExtensions, long lastModified) Gets and populates the documentInfo object for a given PDF object.
static Page[]	getPDFPageDimensions(java.lang.String ticket, java.lang.String objectId, com.aspose.pdf.Document pdfDocument, java.lang.String mimetype) Determines the height and width of pages in a PDF
static java.util.HashMap<java.lang.String,Annotation>	getRepoAnnotationsAsHashmap(java.util.List<Annotation> annotations) Takes the repo annotations array and converts it to a hashmap
static java.util.HashMap<java.lang.String,Annotation>	getRepoReplyTypeAnnots(java.util.HashMap<java.lang.String,Annotation> repoAnnots) Finds all the reply type annotations in the repo annotation map
static DocumentInfo	getVideoDocumentInfo(java.lang.String ticket, java.lang.String objectId, long size) Gets and populates the documentInfo object for a given PDF object.
static Annotation	handleFreetextProperties(java.lang.String defaultAppearanceString, java.lang.String defaultStyleString, Annotation parsedAnnotation)
static Annotation	handleUnsupportedFreetextTypes(org.jdom.Element annotationElement, Annotation parsedAnnotation) Set default values for unsupported freetext type annotations
static Annotation	handleUnsupportedTypes(org.jdom.Element annotationElement, java.lang.String annotationElementType, Annotation parsedAnnotation) Ascertains how to handle the current annotation element type and calls it's equivalent handling function
static java.util.List<Annotation>	parseAnnotations(java.lang.String ticket, org.jdom.Document xfdfDoc, java.lang.String creatorDisplayName, boolean parseFileData) Parses through a supplied XFDF document and returns a list of OA annotation objects.
static java.util.List<Annotation>	parseAnnotations(java.lang.String ticket, java.util.List<java.lang.String> fdfObjects, java.lang.String creatorDisplayName, boolean parseFileData) Parses through a supplied FDF document and returns a list of OA annotation objects.
static java.util.Map<java.lang.String,java.lang.Object>	parseAnnotations(java.lang.String ticket, com.itextpdf.text.pdf.PdfReader PdfReader, boolean forOfflineAnnotation, boolean parseFileData) Parses through a supplied PDF document and returns a list of OA annotation objects.
static java.util.List<Annotation>	parseOfflineAnnotations(java.lang.String userDisplayName, java.util.List<Annotation> parsedAnnotations, boolean muliUsersOffline, java.util.List<java.lang.String> failedUsers, java.util.List<java.lang.String> allUsers, java.lang.String ticket) Specifically parse through annotations that were created offline and if applicable set their title and content appropriately
static java.util.List<Annotation>	removeBRTags(java.util.List<Annotation> annots) Converts the content on annotations from rich text format to their HTML equivalent
static java.lang.String	replaceConfigPlaceholders(java.lang.String ticket, java.lang.String configuredString, java.lang.String objectId, java.lang.String displayName) Parses out the placed from the passed config string and returns a string where the placeholders are replaced by the proper values.
static void	saveAnnotation(org.jdom.Document xfdfDoc, Annotation annotation, java.lang.String ticket, java.lang.String objectId, long lastModified) Saves a provided annotation at the end of a supplied XFDF document (in the "annots" element).
static java.util.List<Annotation>	setAnnotationTitlesAsCurrentUserDisplayName(java.lang.String userDisplayName, java.util.List<Annotation> annotations) Sets the annotation titles to the currently logged in user's display name.
protected static void	setAnnotationXFDFContentAndAttributes(org.jdom.Element annotationElement, Annotation annotation, java.lang.String ticket, java.lang.String objectId, long lastModified) Sets the content and the attributes of the supplied XFDF annotation element.
static java.lang.String	unescapeXFDF(java.lang.String original) Removes any escaped parts of the provided string.
static java.util.List<Annotation>	wrapXFDFContent(java.util.List<Annotation> annotations) Takes annotations and converts their wrapping to match our rich text format

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_XFDF

public static final org.jdom.Namespace NAMESPACE_XFDF

The XFDF namespace.

NAMESPACE_XHTML

public static final org.jdom.Namespace NAMESPACE_XHTML

The XHTML namespace.

START_XFDF_CONTENTS_RICHTEXT

public static final java.lang.String START_XFDF_CONTENTS_RICHTEXT

XFDF body tag start for saving content.

See Also:

Constant Field Values

END_XFDF_CONTENTS_RICHTEXT

public static final java.lang.String END_XFDF_CONTENTS_RICHTEXT

XFDF end tags for content.

See Also:

Constant Field Values

START_TAG_XFDF_CONTENTS_RICHTEXT

public static final java.lang.String START_TAG_XFDF_CONTENTS_RICHTEXT

XFDF body tag start for parsing content.

See Also:

Constant Field Values

START_STATUS_XFDF_CONTENTS_RICHTEXT

public static final java.lang.String START_STATUS_XFDF_CONTENTS_RICHTEXT

XFDF body tag start for saving a status' content.

See Also:

Constant Field Values

END_STATUS_XFDF_CONTENTS_RICHTEXT

public static final java.lang.String END_STATUS_XFDF_CONTENTS_RICHTEXT

XFDF end tags for a status' content.

See Also:

Constant Field Values

XML_VERSION

public static final java.lang.String XML_VERSION

The version of XML being used to write our XFDF.

See Also:

Constant Field Values

TYPE_STICKY_NOTE

public static final java.lang.String TYPE_STICKY_NOTE

The type for a sticky note annotation.

See Also:

Constant Field Values

TYPE_LINE

public static final java.lang.String TYPE_LINE

The type for a line or arrow annotation.

See Also:

Constant Field Values

TYPE_ELLIPSE

public static final java.lang.String TYPE_ELLIPSE

The type for an oval annotation.

See Also:

Constant Field Values

TYPE_RECTANGLE

public static final java.lang.String TYPE_RECTANGLE

The type for a rectangle annotation.

See Also:

Constant Field Values

TYPE_HIGHLIGHT

public static final java.lang.String TYPE_HIGHLIGHT

The type for a highlight annotation.

See Also:

Constant Field Values

TYPE_STRIKEOUT

public static final java.lang.String TYPE_STRIKEOUT

The type for a strikeout annotation.

See Also:

Constant Field Values

TYPE_UNDERLINE

public static final java.lang.String TYPE_UNDERLINE

The type for an underline annotation.

See Also:

Constant Field Values

TYPE_CARET

public static final java.lang.String TYPE_CARET

The type for a caret annotation (also know as an "Insert Text at Placeholder" annotation).

See Also:

Constant Field Values

TYPE_REPLACEMENT_TEXT

public static final java.lang.String TYPE_REPLACEMENT_TEXT

The type for a special caret annotation (also know as an "Replacement Text at Placeholder" annotation).

See Also:

Constant Field Values

TYPE_REPLY

public static final java.lang.String TYPE_REPLY

The type for a reply annotation.

See Also:

Constant Field Values

TYPE_APPROVED_STAMP

public static final java.lang.String TYPE_APPROVED_STAMP

The type for a stamp

See Also:

Constant Field Values

TYPE_ACCEPT_STAMP

public static final java.lang.String TYPE_ACCEPT_STAMP

The type for an Accept stamp

See Also:

Constant Field Values

TYPE_REJECT_STAMP

public static final java.lang.String TYPE_REJECT_STAMP

The type for a Reject stamp

See Also:

Constant Field Values

TYPE_REVIEWED_STAMP

public static final java.lang.String TYPE_REVIEWED_STAMP

The type for a Reviewed stamp

See Also:

Constant Field Values

TYPE_PAGESIZEDCHECKMARK_STAMP

public static final java.lang.String TYPE_PAGESIZEDCHECKMARK_STAMP

The type for a Page Sized Checkmark stamp

See Also:

Constant Field Values

TYPE_STATUS

public static final java.lang.String TYPE_STATUS

The type for a status annotation.

See Also:

Constant Field Values

TYPE_FREETEXT

public static final java.lang.String TYPE_FREETEXT

The type for a freetext annotation.

See Also:

Constant Field Values

TYPE_CALLOUT

public static final java.lang.String TYPE_CALLOUT

The type for a callout annotation.

See Also:

Constant Field Values

IT_FREETEXT_CALLOUT

public static final java.lang.String IT_FREETEXT_CALLOUT

The IT value for a callout annotation.

See Also:

Constant Field Values

DATE_FORMAT_STRING

public static final java.lang.String DATE_FORMAT_STRING

Date Format for parsing XFDF dates

See Also:

Constant Field Values

TYPE_FILE_ATTACHMENT

public static final java.lang.String TYPE_FILE_ATTACHMENT

The type for a fileattachment annotation.

See Also:

Constant Field Values

TYPE_FREEDRAW

public static final java.lang.String TYPE_FREEDRAW

The type for a freedraw annotation.

See Also:

Constant Field Values

DUMMY_DEFAULT_APPEARANCE

public static final java.lang.String DUMMY_DEFAULT_APPEARANCE

Dummy string variable for the defaultappearance attribute of freetext annotations

See Also:

Constant Field Values

DUMMY_DEFAULT_STYLE

public static final java.lang.String DUMMY_DEFAULT_STYLE

Dummy string variable for the defaultstyle attribute of freetext annotations

See Also:

Constant Field Values

DUMMY_SPAN_STYLE

public static final java.lang.String DUMMY_SPAN_STYLE

Dummy string variable for the style attribute of each span that gets created for a text box annotation.

See Also:

Constant Field Values

CLOSING_P_TAG

public static final java.lang.String CLOSING_P_TAG

A tag closing a

tag

See Also:

Constant Field Values

BR_TAG

public static final java.lang.String BR_TAG

A
tag

See Also:

Constant Field Values

BR_CLOSING_TAG

public static final java.lang.String BR_CLOSING_TAG

A close
tag

See Also:

Constant Field Values

CLOSE_SPAN

public static final java.lang.String CLOSE_SPAN

A tag closing a span

See Also:

Constant Field Values

BREAK_TAG_ELEMENT_STRING

public static final java.lang.String BREAK_TAG_ELEMENT_STRING

The string for br tag elements

See Also:

Constant Field Values

REPLY_FLAGS_STRING

public static final java.lang.String REPLY_FLAGS_STRING

The flags attribute needs to saved on statuses for PAS compatibility.

See Also:

Constant Field Values

currentDateKey

public static final java.lang.String currentDateKey

See Also:

Constant Field Values

PDFNAME_IT

public static final com.itextpdf.text.pdf.PdfName PDFNAME_IT

IT stands for intention. Intents allow viewer applications to distinguish between different uses and behaviors of a single markup annotation type.

PDFNAME_CL

public static final com.itextpdf.text.pdf.PdfName PDFNAME_CL

CL stands for Callout. Defines the coordinates for the lines of the arrow in a callout anntoation.

PDFNAME_SUBJ

public static final com.itextpdf.text.pdf.PdfName PDFNAME_SUBJ

Subject is the short description of the subject being addressed by the annotation.

PDFNAME_STATEMODEL

public static final com.itextpdf.text.pdf.PdfName PDFNAME_STATEMODEL

StateModel values are Marked and Review. Used for Status annotations.

PDFNAME_LE

public static final com.itextpdf.text.pdf.PdfName PDFNAME_LE

LE stands for the line end of the head. Use for line and arrow annotations.

PDFNAME_GROUP

public static final com.itextpdf.text.pdf.PdfName PDFNAME_GROUP

Group is a type of reply. A grouped reply will make two annotations appear as a single annotation.

PDFNAME_STRIKE_OUT_TEXT_EDIT

public static final com.itextpdf.text.pdf.PdfName PDFNAME_STRIKE_OUT_TEXT_EDIT

StrikeOutTextEdit is a type of Intention. Related to Replacement Text annotations.

PDFNAME_REPLACE

public static final com.itextpdf.text.pdf.PdfName PDFNAME_REPLACE

Replace is a type of Intention. Related to Replacement Text annotations.

PDFNAME_COMMENT

public static final com.itextpdf.text.pdf.PdfName PDFNAME_COMMENT

Comment is a type of PdfName.NAME, which is the symbol for the annotation.

PDFNAME_ICON

public static final com.itextpdf.text.pdf.PdfName PDFNAME_ICON

Icon corresponds to the Name key

PDFNAME_DS

public static final com.itextpdf.text.pdf.PdfName PDFNAME_DS

DS stands for default style

NUM_CHECKED_IN_ANNOTS

public static final java.lang.String NUM_CHECKED_IN_ANNOTS

See Also:

Constant Field Values

FAILED_USERNAMES

public static final java.lang.String FAILED_USERNAMES

See Also:

Constant Field Values

CONTROLLED_PRINT_AUDIT

public static final java.lang.String CONTROLLED_PRINT_AUDIT

See Also:

Constant Field Values

CONTROLLED_PRINT_AUTONUMBER

public static final java.lang.String CONTROLLED_PRINT_AUTONUMBER

See Also:

Constant Field Values

CONTROLLED_PRINT_OBJECT_TYPE

public static final java.lang.String CONTROLLED_PRINT_OBJECT_TYPE

See Also:

Constant Field Values

EXTENSION_XFDF

public static final java.lang.String EXTENSION_XFDF

The file extension for an XFDF file.

See Also:

Constant Field Values

EMPTY_XFDF

public static final java.lang.String EMPTY_XFDF

An empty XFDF string.

See Also:

Constant Field Values

CARET_GROWTH_RATE

public static final double CARET_GROWTH_RATE

The rate at which the caret annotation grows when downloaded from OA due to an IText bug.

See Also:

Constant Field Values

ENCODING_PREFIX

public static final java.lang.String ENCODING_PREFIX

The encoding prefix used when decoding dynamic stamps.

See Also:

Constant Field Values

VALID_ANNOTATIONS

public static final java.lang.String[] VALID_ANNOTATIONS

The list of all valid annotation types.

ATTR_NEXT_NUMBER

public static final java.lang.String ATTR_NEXT_NUMBER

See Also:

Constant Field Values

ATTR_PREFIX

public static final java.lang.String ATTR_PREFIX

See Also:

Constant Field Values

ATTR_SUFFIX

public static final java.lang.String ATTR_SUFFIX

See Also:

Constant Field Values

ATTR_OBJECT_ID

public static final java.lang.String ATTR_OBJECT_ID

See Also:

Constant Field Values

ATTR_OBJECT_TYPE_NAME

public static final java.lang.String ATTR_OBJECT_TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

XFDFUtil

public XFDFUtil()

Method Detail

getAnnotationCount

public static int getAnnotationCount(org.jdom.Document xfdfDoc)
                              throws java.lang.Exception

Return how many annotations are in the parameterized xfdfDoc.

Parameters:

xfdfDoc - The XFDF document to scan through for a count of annotations.

Returns:

The number of annotation objects in xfdfDoc.

Throws:

java.lang.Exception

parseAnnotations

public static java.util.List<Annotation> parseAnnotations(java.lang.String ticket,
                                                          org.jdom.Document xfdfDoc,
                                                          java.lang.String creatorDisplayName,
                                                          boolean parseFileData)
                                                   throws java.lang.Exception

Parses through a supplied XFDF document and returns a list of OA annotation objects.

Parameters:

ticket - A valid OC ticket.

xfdfDoc - The XFDF document to parse through for annotations.

creatorDisplayName - The display name of the creator of the XFDF document we're parsing. This display name will become the title for each annotation we find in the provided XFDF document.

parseFileData - A flag that determines we need to parse the data on file attachment annotations

Returns:

A List of Annotation objects that have been parsed from the supplied XFDF document.

Throws:

java.lang.Exception

parseAnnotations

public static java.util.List<Annotation> parseAnnotations(java.lang.String ticket,
                                                          java.util.List<java.lang.String> fdfObjects,
                                                          java.lang.String creatorDisplayName,
                                                          boolean parseFileData)
                                                   throws java.lang.Exception

Parses through a supplied FDF document and returns a list of OA annotation objects.

Parameters:

ticket - A valid OC ticket.

fdfObjects - A list of FDF objects as Strings.

creatorDisplayName - The display name of the creator of the FDF document we're parsing. This display name will become the title for each annotation we find in the provided FDF document.

parseFileData - A flag that determines we need to parse the data on file attachment annotations

Returns:

A List of Annotation objects that have been parsed from the supplied FDF document.

Throws:

java.lang.Exception

parseAnnotations

public static java.util.Map<java.lang.String,java.lang.Object> parseAnnotations(java.lang.String ticket,
                                                                                com.itextpdf.text.pdf.PdfReader PdfReader,
                                                                                boolean forOfflineAnnotation,
                                                                                boolean parseFileData)

Parses through a supplied PDF document and returns a list of OA annotation objects.

Parameters:

ticket - A valid OC ticket.

PdfReader - A PdfReader to read content from a PDF document.

parseFileData - A flag that determines we need to parse the data on file attachment annotations

Returns:

A map containing Annotation objects that have been parsed from the supplied PDF document and a boolean indicating the presence or absence of widgets.

getRepoAnnotationsAsHashmap

public static java.util.HashMap<java.lang.String,Annotation> getRepoAnnotationsAsHashmap(java.util.List<Annotation> annotations)

Takes the repo annotations array and converts it to a hashmap

Parameters:

annotatons - array of all current repo annotatons

Returns:

hashmap version of the annotations array

getRepoReplyTypeAnnots

public static java.util.HashMap<java.lang.String,Annotation> getRepoReplyTypeAnnots(java.util.HashMap<java.lang.String,Annotation> repoAnnots)

Finds all the reply type annotations in the repo annotation map

Parameters:

repoAnnots - hashmap that contains all the annotations for a particular objectId

Returns:

hashmap of reply type annotations

flattenReplies

public static java.util.List<Annotation> flattenReplies(java.util.List<Annotation> annotations)

Flattens any reply chains that exist amongst reply-type annotations to a maximum of: . PAS and old Adobe allow for replies to reply.

Parameters:

annotations - An List of annotations whose reply structure should be flattened.

Returns:

The flattened List of annotations.

handleUnsupportedTypes

public static Annotation handleUnsupportedTypes(org.jdom.Element annotationElement,
                                                java.lang.String annotationElementType,
                                                Annotation parsedAnnotation)

Ascertains how to handle the current annotation element type and calls it's equivalent handling function

Parameters:

annotationElement - The current annotation element being worked on in List parseAnnotations(String ticket, Document xfdfDoc, String creatorDisplayName)

parsedAnnotation - The parsed equivalent of the current annotation element being worked on currently

handleUnsupportedFreetextTypes

public static Annotation handleUnsupportedFreetextTypes(org.jdom.Element annotationElement,
                                                        Annotation parsedAnnotation)

Set default values for unsupported freetext type annotations

Parameters:

annotationElement - The unsupported annotationElement

parsedAnnotation - The parsed equivalent of annotationElement

handleFreetextProperties

public static Annotation handleFreetextProperties(java.lang.String defaultAppearanceString,
                                                  java.lang.String defaultStyleString,
                                                  Annotation parsedAnnotation)

parseOfflineAnnotations

public static java.util.List<Annotation> parseOfflineAnnotations(java.lang.String userDisplayName,
                                                                 java.util.List<Annotation> parsedAnnotations,
                                                                 boolean muliUsersOffline,
                                                                 java.util.List<java.lang.String> failedUsers,
                                                                 java.util.List<java.lang.String> allUsers,
                                                                 java.lang.String ticket)

Specifically parse through annotations that were created offline and if applicable set their title and content appropriately

Parameters:

userDisplayName - The current user's display name

parsedAnnotations - List containing all parsedAnnotations

Returns:

Returns the updated annotations

setAnnotationTitlesAsCurrentUserDisplayName

public static java.util.List<Annotation> setAnnotationTitlesAsCurrentUserDisplayName(java.lang.String userDisplayName,
                                                                                     java.util.List<Annotation> annotations)

Sets the annotation titles to the currently logged in user's display name. This is used when we only have one user checking in annotations and there are other annotations that have titles for users that do not exist

Parameters:

userDisplayName - the current display name of the user who is logged in

annotations - The list containing all the parsed annotations to be filtered

Returns:

The annotations with updated titles to the user's display name

filterAnnotationsByFlag

public static java.util.List<Annotation> filterAnnotationsByFlag(int flagBit,
                                                                 java.util.List<Annotation> annotations)

Filters out annotations that have a designated bit set to true

Parameters:

flagBit - The int designating which particular flag to check

annotations - The list containing all the parsed annotations to be filtered

Returns:

The annotations that were made offline

filterAnnotationsByUser

public static java.util.List<Annotation> filterAnnotationsByUser(java.lang.String userDisplayName,
                                                                 java.util.List<Annotation> annotations)

Filters out annotations not associated with current user

Parameters:

username - The string containing the current user which will be used to filter the annotations

annotations - The list containing all the parsed annotations

Returns:

The annotations filtered by current user

replaceConfigPlaceholders

public static java.lang.String replaceConfigPlaceholders(java.lang.String ticket,
                                                         java.lang.String configuredString,
                                                         java.lang.String objectId,
                                                         java.lang.String displayName)

Parses out the placed from the passed config string and returns a string where the placeholders are replaced by the proper values.

Parameters:

ticket - A valid OC ticket.

configuredString - The string containing config placeholders, which serves as the base for the final string.

objectId - The id of the repo object that is being saved to.

displayName - The display name of the current user.

Returns:

A string where the placeholders are replaced by the proper values.

computeAnnotationConfigPlaceholder

public static java.lang.String computeAnnotationConfigPlaceholder(java.lang.String ticket,
                                                                  java.lang.String param,
                                                                  java.lang.String objectId,
                                                                  java.lang.String displayName)

Takes an individual parameter and returns the value associated with it using supportedAnnotationNameParms enum

Parameters:

ticket - A valid OC ticket.

param - The individual parameter being interpreted.

objectId - The id of the repo object that is being saved to.

The - display name of the current user.

Returns:

The representative value of the configured individual parameter

executeRegexMatching

public static java.lang.String executeRegexMatching(java.lang.String contentString,
                                                    java.lang.String regexPattern)

Saves a provided annotation at the end of a supplied XFDF document (in the "annots" element).

Parameters:

contentString - The string from which we want to extract the regex match.

regexPattern - The regex pattern used to extract a certain substring from contentString.

saveAnnotation

public static void saveAnnotation(org.jdom.Document xfdfDoc,
                                  Annotation annotation,
                                  java.lang.String ticket,
                                  java.lang.String objectId,
                                  long lastModified)
                           throws java.lang.Exception

Saves a provided annotation at the end of a supplied XFDF document (in the "annots" element).

Parameters:

xfdfDoc - An XFDF document to add the annotation to the end of the "annots" element.

annotation - The Annotation object to save into the supplied XFDF document.

Throws:

java.lang.Exception - If an error occurs saving the annotation into the XFDF document.

setAnnotationXFDFContentAndAttributes

protected static void setAnnotationXFDFContentAndAttributes(org.jdom.Element annotationElement,
                                                            Annotation annotation,
                                                            java.lang.String ticket,
                                                            java.lang.String objectId,
                                                            long lastModified)
                                                     throws java.lang.Exception

Sets the content and the attributes of the supplied XFDF annotation element.

Parameters:

annotationElement - The XFDF element to set the contents and the attributes on.

annotation - The Annotation object to use for setting the content and attributes in the XFDF.

Throws:

java.lang.Exception - If an error occurs setting the contents or attributes of the annotation in the XFDF.

getPdfDocumentInfo

public static DocumentInfo getPdfDocumentInfo(java.lang.String ticket,
                                              java.lang.String objectId,
                                              java.lang.String mimetype,
                                              java.lang.Integer docSizeLoadLimitBytes,
                                              java.lang.String[] fileExtensions,
                                              long lastModified)
                                       throws java.io.IOException

Gets and populates the documentInfo object for a given PDF object.

Parameters:

ticket - A valid OC ticket.

objectId - The id of the repo object we want documentInfo for.

pdfReader - An iText pdfReader with the object's pdf representation loaded.

mimetype - The desired mimetype of the PDF. Used to distinguish between a normal PDF and a comparison PDF.

docSizeLoadLimitBytes - The default doc sizing that defines when a doc is too large to view. HPI Configured.

Returns:

A DocumentInfo pojo.

Throws:

java.io.IOException

flattenPDFPortfolio

public static com.aspose.pdf.Document flattenPDFPortfolio(com.aspose.pdf.Document pdfPortfolio,
                                                          DocumentInfo documentInfo)

Loops through each of the embedded files in a PDF Portfolio and puts all the content into a single PDF document Currently only handles embedded pdfs. All other file types will set portfolioContainsNonPdf to true on the documentInfo object and not be included in the flattened PDF

Parameters:

pdfPortfolio - - an Aspose document with embedded files

documentInfo - - information about the document being flattened

Returns:

com.aspose.pdf.Document - the flattened PDF portfolio

getPDFPageDimensions

public static Page[] getPDFPageDimensions(java.lang.String ticket,
                                          java.lang.String objectId,
                                          com.aspose.pdf.Document pdfDocument,
                                          java.lang.String mimetype)

Determines the height and width of pages in a PDF

Parameters:

ticket - a valid OC ticket.

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

pdfDocument - An Aspose PDF document.

mimetype - The desired mimetype of the PDF. Used to distinguish between a normal PDF and a comparison PDF.

Returns:

an array of Pages with dimensions

getVideoDocumentInfo

public static DocumentInfo getVideoDocumentInfo(java.lang.String ticket,
                                                java.lang.String objectId,
                                                long size)

Gets and populates the documentInfo object for a given PDF object.

Parameters:

ticket - A valid OC ticket.

objectId - The id of the repo object we want documentInfo for.

pdfReader - An iText pdfReader with the object's pdf representation loaded.

mimetype - The desired mimetype of the PDF. Used to distinguish between a normal PDF and a comparison PDF.

Returns:

A DocumentInfo pojo.

burnInAnnotations

public static void burnInAnnotations(com.itextpdf.text.pdf.PdfReader pdfReader,
                                     com.itextpdf.text.pdf.PdfStamper stamper,
                                     java.lang.String objectId,
                                     java.util.List<Annotation> annotations,
                                     java.lang.String userDisplayName,
                                     boolean forOfflineAnnotation,
                                     java.lang.String ticket,
                                     long lastModified)

Burns the provided annotations into the supplied PDF document. This returns a byte stream of the output, which is always of "application/pdf" mimetype.

Parameters:

pdfReader - The PdfReader object representing the PDF to burn the annotations on.

stamper - The stamper object used to create the new PDF.

objectId - The object ID of the document.

annotations - The arrayList of Annotation objects to burn in to the PDF.

userDisplayName - The display name of the user attempting the "burn in" operation. Used to determine if an annotation belongs to this user or not (for coloring purposes).

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

ticket. - The session ticket.

lastModified. - When the document was last modified.

controlledPrintOverlay

@Deprecated
public static void controlledPrintOverlay(java.lang.String ticket,
                                                       java.lang.String objectId)

Deprecated.

WARNINING : Unfinished, DO NOT USE. Keeping the code around the around, but would need to be refactored if it were to be implemented again.

Parameters:

ticket -

objectId -

unescapeXFDF

public static java.lang.String unescapeXFDF(java.lang.String original)

Removes any escaped parts of the provided string.

Parameters:

original - The content to "unescape".

Returns:

An unescaped version of the provided string.

escapeXFDF

public static java.lang.String escapeXFDF(java.lang.String original)

Utility method to escape an XFDF string by converting
tags to their escaped values.

Parameters:

original - the XFDF string to escape.

Returns:

an escaped XFDF string.

removeBRTags

public static java.util.List<Annotation> removeBRTags(java.util.List<Annotation> annots)

Converts the content on annotations from rich text format to their HTML equivalent

Parameters:

annots - a list of all annotation objects that we need to make readable in html

Returns:

a list of annotations with the closing
tag removed

wrapXFDFContent

public static java.util.List<Annotation> wrapXFDFContent(java.util.List<Annotation> annotations)

Takes annotations and converts their wrapping to match our rich text format

Parameters:

annotations - a list of all annotations

Returns:

a list of annotations, converted from html to rich text format

buildRichTextSpan

public static java.lang.String buildRichTextSpan(java.lang.Boolean isItalic,
                                                 java.lang.Boolean isBold,
                                                 java.lang.Boolean isUnderline,
                                                 java.lang.String color)

Builds our rich text styling from the html styling from OA

Parameters:

isItalic. - Whether or not our current text should be italicized.

isBold. - Whether or not our current text should be bold.

isUnder. - Whether or not our current text should be underlined.

Returns:

the string for styling our text

getNextAutoNumber

public static java.lang.String getNextAutoNumber(java.lang.String ticket,
                                                 java.lang.String objectTypeName)
                                          throws OCRuntimeException

Throws:

OCRuntimeException

getAutonumberObjectId

protected static java.lang.String getAutonumberObjectId(java.lang.String ticket,
                                                        java.lang.String objectTypeName)

Gets the object ID of the Autonumber object for the given page set name

Parameters:

ticket - oc ticket

objectTypeName - the object type name

Returns:

the object ID of the autonumber object

getAnnotatableTypesByViewer

public static java.util.List<java.lang.String> getAnnotatableTypesByViewer(AnnotationConfig config,
                                                                           java.lang.String viewer)

Gets a filtered list of content extensions that use the a certain viewer.

Parameters:

config - the AnnotationConfig object.

viewer - The string representation of the viewer to filter on.

Returns:

a filtered list of content extensions that use the a certain viewer.