com.tsgrp.opencontent.universal.action.executer

Class AdvancedCombineToPDFActionExecuter

java.lang.Object

com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

com.tsgrp.opencontent.universal.action.executer.AdvancedCombineToPDFActionExecuter

All Implemented Interfaces:

ActionExecuter, ItemExecuter

Direct Known Subclasses:

ControlledPrintActionExecuter

public class AdvancedCombineToPDFActionExecuter
extends AbstractActionExecuter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowMultilineEntries
protected static int	INDEX_PAGE_FONT_LEADING_POINT_SIZE
protected int	indexPageCharsPerLine
protected java.lang.String	indexPageFont
protected int	linesPerIndexPage
protected static java.lang.String	PARAM_ANNOTATION_INFO
protected static java.lang.String	PARAM_FOLDER_PATH
protected static java.lang.String	PARAM_PDF_FOLDER_TYPE
protected static java.lang.String	PARAM_PROPERTIES

Fields inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

group, groupedConditionEvaluatorList, indexImage, nonRequiredConditionEvaluatorList, requiredConditionEvaluatorList

Constructor Summary

Constructors

Constructor and Description
AdvancedCombineToPDFActionExecuter()

Method Summary

Modifier and Type	Method and Description
protected void	addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties) A hook method for actions to add mandatory parameters to the provided list.
protected java.util.Map<java.lang.Integer,java.lang.String>	addTableOfContentsMapItem(java.util.Map<java.lang.Integer,java.lang.String> tableOfContents, int totalPages, java.util.List<java.lang.String> objectNames, int pdfNumber) Hot spot method that constructs the table of contents map that is used to build up the title page
protected java.io.OutputStream	concatPDFs(java.util.List<java.lang.String> objectIds, java.util.List<java.lang.String> objectNames, java.lang.String indexTitle, java.lang.String indexSecondaryTitle, java.lang.String indexImage, java.util.Map<java.lang.String,java.lang.String> selectedPagesMap, java.util.List<java.lang.String> bookmarkValues, java.lang.String ticket, java.io.File concatenatedPdfFile, java.io.File tableOfContentsFile, java.io.File pdfsAndTOCfile, java.io.File overlayFile, java.io.FileOutputStream concatenatedPdfFOS, java.io.FileOutputStream tableOfContentsFOS, java.io.FileOutputStream pdfsAndTOCFOS, java.io.OutputStream overlayFos, java.util.List<java.lang.String> extraAttachmentIds, java.util.Map<java.lang.String,java.util.List<java.lang.String>> annotationInfoList, java.lang.String uniqueID, CoreActionService cas, boolean excludeIndexPage, boolean isAsync, java.util.List<java.lang.Integer> numCopies, java.util.Map<java.lang.String,java.lang.Object> overlayPropsMap)
void	executeImpl(java.lang.String ticket, Action action) The implementation of the action.
protected int	getNumberOfIndexPages(java.util.List<java.lang.String> entries)
protected java.util.Map<java.lang.String,java.lang.Object>	getOverlayParameters() Hot spot method to construct a map of parameters to send to OpenOverlay
protected java.io.FileOutputStream	prependTitlePage(com.itextpdf.text.pdf.PdfCopy copy, java.util.Map<java.lang.Integer,java.lang.String> tableOfContents, java.lang.String indexTitle, java.lang.String indexSecondaryTitle, java.lang.String indexImage, java.io.FileOutputStream concatenatedPdfFOS, java.io.FileOutputStream tableOfContentsFOS, java.io.FileOutputStream pdfsAndTOCFOS, int indexPageCount, java.io.File concatenatedPdfFile, java.io.File tableOfContentsFile, java.io.File pdfsAndTOCfile, com.itextpdf.text.Document newDocument)
void	setAllowMultilineEntries(boolean allowMultilineEntries)
void	setIndexPageCharsPerLine(int indexPageCharsPerLine)
void	setIndexPageFont(java.lang.String indexPageFont)
void	setLinesPerIndexPage(int linesPerIndexPage)

Methods inherited from class com.tsgrp.opencontent.core.action.executer.AbstractActionExecuter

evaluateAndExecute, execute, getActionDefinition, getDescription, getGroupedConditionEvaluatorList, getIndexImage, getNonRequiredConditionEvaluatorList, getRequiredConditionEvaluatorList, getShouldPoolAction, isGroup, setActionExecutionThreadManager, setDescription, setGroup, setGroupedConditionEvaluatorList, setIndexImage, setNonRequiredConditionEvaluatorList, setRequiredConditionEvaluatorList, setShouldPoolAction

Methods inherited from class com.tsgrp.opencontent.core.action.ItemExecuterAbstractBase

checkParameters

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PROPERTIES

protected static final java.lang.String PARAM_PROPERTIES

See Also:

Constant Field Values

PARAM_PDF_FOLDER_TYPE

protected static final java.lang.String PARAM_PDF_FOLDER_TYPE

See Also:

Constant Field Values

PARAM_FOLDER_PATH

protected static final java.lang.String PARAM_FOLDER_PATH

See Also:

Constant Field Values

PARAM_ANNOTATION_INFO

protected static final java.lang.String PARAM_ANNOTATION_INFO

See Also:

Constant Field Values

INDEX_PAGE_FONT_LEADING_POINT_SIZE

protected static final int INDEX_PAGE_FONT_LEADING_POINT_SIZE

See Also:

Constant Field Values

linesPerIndexPage

protected int linesPerIndexPage

indexPageFont

protected java.lang.String indexPageFont

indexPageCharsPerLine

protected int indexPageCharsPerLine

allowMultilineEntries

protected boolean allowMultilineEntries

Constructor Detail

AdvancedCombineToPDFActionExecuter

public AdvancedCombineToPDFActionExecuter()

Method Detail

setLinesPerIndexPage

public void setLinesPerIndexPage(int linesPerIndexPage)

setIndexPageFont

public void setIndexPageFont(java.lang.String indexPageFont)

setIndexPageCharsPerLine

public void setIndexPageCharsPerLine(int indexPageCharsPerLine)

setAllowMultilineEntries

public void setAllowMultilineEntries(boolean allowMultilineEntries)

addMandatoryParameters

protected void addMandatoryParameters(java.util.List<java.lang.String> mandatoryProperties)

Description copied from class: AbstractActionExecuter

A hook method for actions to add mandatory parameters to the provided list. If a specified parameter is not present when the action executer is invoked, an error will be thrown.

Specified by:

addMandatoryParameters in class AbstractActionExecuter

Parameters:

mandatoryProperties - a list of mandatory parameters that must be provided to the action executer when executed.

executeImpl

public void executeImpl(java.lang.String ticket,
                        Action action)

Description copied from interface: ActionExecuter

The implementation of the action.

Specified by:

executeImpl in interface ActionExecuter

Specified by:

executeImpl in class AbstractActionExecuter

Parameters:

ticket - a valid OC ticket.

action - the action object containing the parameters sent to the action for execution.

See Also:

ActionExecuter.executeImpl(String, Action)

getNumberOfIndexPages

protected int getNumberOfIndexPages(java.util.List<java.lang.String> entries)

concatPDFs

protected java.io.OutputStream concatPDFs(java.util.List<java.lang.String> objectIds,
                                          java.util.List<java.lang.String> objectNames,
                                          java.lang.String indexTitle,
                                          java.lang.String indexSecondaryTitle,
                                          java.lang.String indexImage,
                                          java.util.Map<java.lang.String,java.lang.String> selectedPagesMap,
                                          java.util.List<java.lang.String> bookmarkValues,
                                          java.lang.String ticket,
                                          java.io.File concatenatedPdfFile,
                                          java.io.File tableOfContentsFile,
                                          java.io.File pdfsAndTOCfile,
                                          java.io.File overlayFile,
                                          java.io.FileOutputStream concatenatedPdfFOS,
                                          java.io.FileOutputStream tableOfContentsFOS,
                                          java.io.FileOutputStream pdfsAndTOCFOS,
                                          java.io.OutputStream overlayFos,
                                          java.util.List<java.lang.String> extraAttachmentIds,
                                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> annotationInfoList,
                                          java.lang.String uniqueID,
                                          CoreActionService cas,
                                          boolean excludeIndexPage,
                                          boolean isAsync,
                                          java.util.List<java.lang.Integer> numCopies,
                                          java.util.Map<java.lang.String,java.lang.Object> overlayPropsMap)

prependTitlePage

protected java.io.FileOutputStream prependTitlePage(com.itextpdf.text.pdf.PdfCopy copy,
                                                    java.util.Map<java.lang.Integer,java.lang.String> tableOfContents,
                                                    java.lang.String indexTitle,
                                                    java.lang.String indexSecondaryTitle,
                                                    java.lang.String indexImage,
                                                    java.io.FileOutputStream concatenatedPdfFOS,
                                                    java.io.FileOutputStream tableOfContentsFOS,
                                                    java.io.FileOutputStream pdfsAndTOCFOS,
                                                    int indexPageCount,
                                                    java.io.File concatenatedPdfFile,
                                                    java.io.File tableOfContentsFile,
                                                    java.io.File pdfsAndTOCfile,
                                                    com.itextpdf.text.Document newDocument)

getOverlayParameters

protected java.util.Map<java.lang.String,java.lang.Object> getOverlayParameters()

Hot spot method to construct a map of parameters to send to OpenOverlay

Returns:

the map of overlay parameters

addTableOfContentsMapItem

protected java.util.Map<java.lang.Integer,java.lang.String> addTableOfContentsMapItem(java.util.Map<java.lang.Integer,java.lang.String> tableOfContents,
                                                                                      int totalPages,
                                                                                      java.util.List<java.lang.String> objectNames,
                                                                                      int pdfNumber)

Hot spot method that constructs the table of contents map that is used to build up the title page

Parameters:

tableOfContents - contains the attributes necessary to build up the title page

totalPages - represents the starting page number of the object

objectNames -

pdfNumber - represents the index of the object in the objectNames array

Returns:

the tableOfContents map that contains the new data item