Package com.levigo.jadice.server.pdf

Class PDFCompositeNode

java.lang.Object

com.levigo.jadice.server.internal.NodeInternal

com.levigo.jadice.server.Node

com.levigo.jadice.server.pdf.PDFCompositeNode

public class PDFCompositeNode
extends Node

This Node composites a set of input PDF documents into a single output PDF document by layering the documents' contents atop of each other.

Remark: The result will have only as much pages as the first incoming Stream has. If subsequent Streams have more pages, they will be dropped.

Its worker respects PageCountLimits.

Since:

jadice server version 4.2.1.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFCompositeNode.HorizontalAlignment	Specifies on which horizontal side the overlaid PDFs are aligned.
static class	PDFCompositeNode.Order	Specifies in which order incoming Streams will be layered.
static class	PDFCompositeNode.VerticalAlignment	Specifies on which vertical side the overlaid PDFs are aligned.

Nested classes/interfaces inherited from class com.levigo.jadice.server.Node

Node.Cardinality

Field Summary

Fields inherited from class com.levigo.jadice.server.internal.NodeInternal

limits, subsidiaryNodes

Constructor Summary

Constructors

Constructor	Description
PDFCompositeNode()

Method Summary

Modifier and Type	Method	Description
PDFCompositeNode.HorizontalAlignment	getHorizontalAlignment()	Set the horizontal alignment.
PDFCompositeNode.Order	getOrder()
PDFCompositeNode.VerticalAlignment	getVerticalAlignment()	Get the vertical alignment.
boolean	isRepeat()
void	setHorizontalAlignment(PDFCompositeNode.HorizontalAlignment hAlignment)	Set the horizontal alignment.
void	setOrder(PDFCompositeNode.Order order)	Set the PDFCompositeNode.Order in which the incoming Streams will be layered.
void	setRepeat(boolean repeat)	If set to true, subsequent Streams will be repeated from their start page until all pages from the 1st document were processed. (default: false)
void	setVerticalAlignment(PDFCompositeNode.VerticalAlignment vAlignment)	Set the vertical alignment.

Methods inherited from class com.levigo.jadice.server.Node

addTransportReceiver, appendSuccessor, apply, equals, getInputCardinality, getJob, getOutputCardinality, getPredecessors, getSubsidiaryNodes, getSuccessors, getTransportSender, getUUID, getWorkerClassName, hashCode, initialize, prependPredecessor, remove, validateConfiguration

Methods inherited from class com.levigo.jadice.server.internal.NodeInternal

addSubsidiaryNodes, getJobInternal, getLimit, getLimits, getNodeLimits, setJob, setNodeLimits

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFCompositeNode

public PDFCompositeNode()

Method Detail

getOrder

public PDFCompositeNode.Order getOrder()

Returns:

the PDFCompositeNode.Order in which the incoming Streams will be layered. (default PDFCompositeNode.Order.BACK_TO_FRONT)

setOrder

public void setOrder(PDFCompositeNode.Order order)

Set the PDFCompositeNode.Order in which the incoming Streams will be layered.

Parameters:

order - the PDFCompositeNode.Order to layer incoming documents.

getVerticalAlignment

public PDFCompositeNode.VerticalAlignment getVerticalAlignment()

Get the vertical alignment. (Default: PDFCompositeNode.VerticalAlignment.TOP)

Returns:

vertical alignment

setVerticalAlignment

public void setVerticalAlignment(PDFCompositeNode.VerticalAlignment vAlignment)

Set the vertical alignment.

Parameters:

vAlignment - vertical alignment

getHorizontalAlignment

public PDFCompositeNode.HorizontalAlignment getHorizontalAlignment()

Set the horizontal alignment. (Default: PDFCompositeNode.HorizontalAlignment.LEFT)

Returns:

horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(PDFCompositeNode.HorizontalAlignment hAlignment)

Set the horizontal alignment.

Parameters:

hAlignment - horizontal alignment

setRepeat

public void setRepeat(boolean repeat)

If set to true, subsequent Streams will be repeated from their start page until all pages from the 1^st document were processed.
(default: false)

Example:
Given document 1 with 4 pages, document 2 with 3 pages, document 3 with 2 pages and document 4 with 5 pages. The result is as follow:

Example Results

resulting document	page 1	page 2	page 3	page 4
document 1	page 1	page 2	page 3	page 4
document 2	page 1	page 2	page 3	page 1
document 3	page 1	page 2	page 1	page 2
document 4	page 1	page 2	page 3	page 4

As you can see the result has as many pages as document 1, so page 5 from document 4 is dropped.

Parameters:

repeat - If repeating subsequent streams' pages is requested.

isRepeat

public boolean isRepeat()

Returns:

If repeating subsequent streams' pages is requested.

See Also:

setRepeat(boolean)