com.levigo.jadice.server.msoffice

Class MSWordNode

java.lang.Object

com.levigo.jadice.server.internal.NodeInternal

com.levigo.jadice.server.Node

com.levigo.jadice.server.msoffice.MSWordNode

public class MSWordNode
extends Node

This Node uses Microsoft Office Word to convert an MS Word document with a virtual printer or by native file export (only MS Office 2007 and above).

For further configuration details, have a look at the file server-config/ms-office/export-configuration.xml

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MSWordNode.WdOpenFormat Specifies which file converter MS Word will use to open the document. The enum constant names and their javadoc descriptions are as defined in the MS Word COM interface and the MSDN library.

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 and Description
MSWordNode()

Method Summary

Methods

Modifier and Type	Method and Description
PageRange	getExportRange()
String	getFilename()
MSWordNode.WdOpenFormat	getOpenFormat()
String	getPassword()
String	getTargetMimeType()
String	getWorkerClassName() Return the node's associated NodeWorker full qualified class's name.
boolean	isExportWithMarkup()
void	setExportRange(PageRange exportRange) Set the range of pages to export/convert.
void	setExportWithMarkup(boolean exportMarkup) Switch if MS Word shall export the document with or without markup.
void	setFilename(String filename) Set the fallback filename.
void	setOpenFormat(MSWordNode.WdOpenFormat openFormat) Set the format which converter will be used to open the document. (Default: MSWordNode.WdOpenFormat.WD_OPEN_FORMAT_AUTO)
void	setPassword(String password) Set document password. (Default value: node)
void	setTargetMimeType(String mimeType) Set the requested MIME type of the conversion result. (Default: application/pdf)

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

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

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

addSubsidiaryNodes, getJobInternal, getLimit, getLimits, getNodeLimits, setNodeLimits

Methods inherited from class java.lang.Object

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

Constructor Detail

MSWordNode

public MSWordNode()

Method Detail

getWorkerClassName

public String getWorkerClassName()

Description copied from class: Node

Return the node's associated NodeWorker full qualified class's name. By default, the worker class name is

• The same as the node name with the trailing "Node" replaced by "Worker" if the node name ends in "Node"
• The node class name with an appended "Worker" otherwise.

The package name of the worker class is the name of the Node's package with an appended ".worker".

This behavior can be overridden in concrete subclasses.

Overrides:

getWorkerClassName in class Node

Returns:

the full qualified class name of the worker of this node.

getPassword

public String getPassword()

Returns:

current document password.

setPassword

public void setPassword(String password)

Set document password.
(Default value: node)

Parameters:

password -

getTargetMimeType

public String getTargetMimeType()

setTargetMimeType

public void setTargetMimeType(String mimeType)

Set the requested MIME type of the conversion result.
(Default: application/pdf)

Parameters:

mimeType -

setOpenFormat

public void setOpenFormat(MSWordNode.WdOpenFormat openFormat)

Set the format which converter will be used to open the document.
(Default: MSWordNode.WdOpenFormat.WD_OPEN_FORMAT_AUTO)

Parameters:

openFormat - the openFormat to set

getOpenFormat

public MSWordNode.WdOpenFormat getOpenFormat()

Returns:

the openFormat

setFilename

public void setFilename(String filename)

Set the fallback filename. This value will be used to generate a temporary file when no filename is provided in the StreamDescriptor.

Default value: word.doc

Parameters:

filename -

getFilename

public String getFilename()

setExportRange

public void setExportRange(PageRange exportRange)

Set the range of pages to export/convert. It must be ensured on client side that this range of pages is valid, else an error might occur and the job might fail.

Parameters:

exportRange - range of pages (default: PageRange.ALL_PAGES)

Since:

jadice server 4.3.1.1

getExportRange

public PageRange getExportRange()

setExportWithMarkup

public void setExportWithMarkup(boolean exportMarkup)

Switch if MS Word shall export the document with or without markup. (default: false)

Parameters:

exportMarkup - markup with be exported iff set to true.

Since:

jadice server 5.1.7.0

isExportWithMarkup

public boolean isExportWithMarkup()

Returns:

export the document with or without markup.