de.infinityloop.upcast

Class UpcastPipeline

java.lang.Object

de.infinityloop.upcast.UpcastPipeline

public class UpcastPipeline
extends java.lang.Object

This class implements a simplified Pipeline proxy to use for upCast integrators and users.

Since:

7.5.3

Author:

Christian Roth

Constructor Summary

Constructors

Constructor and Description
UpcastPipeline(de.infinityloop.upcast.util.PipelineRunner r) As a user, do not call this method directly.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getEnvironmentValue(java.lang.String key) Returns info about the pipeline and the environment this pipeline runs in
java.lang.Object	runPipeline() Run the pipeline after you have set all required parameters
void	setLicenseOverride(java.lang.String pathToLicense) Override the license setting within the pipeline with a different license
void	setPipelineParameter(java.lang.String key, java.lang.Object value) Set a pipeline parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpcastPipeline

public UpcastPipeline(de.infinityloop.upcast.util.PipelineRunner r)

As a user, do not call this method directly. It is called by methods in e.g. UpcastEngine for you.

Parameters:

r - the pipeline runner delegate

Method Detail

runPipeline

public java.lang.Object runPipeline()
                             throws UpcastException

Run the pipeline after you have set all required parameters

Returns:

the result object as stored in pipeline:ModuleResult. The return value and above all, its type, is therefore determined by the actual pipeline implementation. You either need to know it or check for it.

Throws:

UpcastException

setPipelineParameter

public void setPipelineParameter(java.lang.String key,
                        java.lang.Object value)

Set a pipeline parameter value.

Parameters:

key - the parameter name

value - the parameter value

setLicenseOverride

public void setLicenseOverride(java.lang.String pathToLicense)
                        throws java.lang.Exception

Override the license setting within the pipeline with a different license

Parameters:

pathToLicense - (possibly relative to the working directory; Java property: user.dir) path to a license file that should unconditionally override the normal license selection algorithm

Throws:

java.lang.Exception

getEnvironmentValue

public java.lang.Object getEnvironmentValue(java.lang.String key)

Returns info about the pipeline and the environment this pipeline runs in

Parameters:

key - the selector:

de.infinityloop.upcast.version

the version in format "M.m.r" of the current application

de.infinityloop.upcast.build

the build number

de.infinityloop.upcast.buildtimestamp

the timestamp when this version of the application binary was built

de.infinityloop.upcast.name

the user-readable name of the application, i.e. "upCast" or "downCast"

de.infinityloop.upcast.license.features

names of all features in that license, separated by a space. Features that have expired are enclosed in parantheses, e.g. " gui (batch) java-api"

de.infinityloop.upcast.license.features.valid

names of all currently valid features in that license, separated by a space

de.infinityloop.upcast.license.features.expdays= feature

the number of days until the specified feature expires

de.infinityloop.upcast.dir.installation

the installation directory of the application

de.infinityloop.upcast.xmlcatalogs

a list of paths to the catalog files currently registered with this application, separated by the platform-dependent path separator character

de.infinityloop.upcast.xml.xerces.version

the version of the Xerces parser used

de.infinityloop.upcast.xslt.xalan.version

the version of the Xalan XSLT processor used

de.infinityloop.upcast.xslt.saxon.version

the version of the Saxon XSLT processor used

de.infinityloop.upcast.wordlink.version

the version of the WordLink gateway; returns null when WordLink is not available

de.infinityloop.upcast.wordlink.wordversion

the version of Word WordLink links to; returns null when WordLink is not available or no installed Word application can be found

de.infinityloop.upcast.wordlink.binarypath

the path to the WordLink gateway application il-gw.exe

de.infinityloop.upcast.api.native.dllversion

the version of the iloop.dll servicing the C/C++/VB/VBA APIs

de.infinityloop.upcast.mathlink.version

the version of the MathLink implementation; returns null when MathLink is not available

de.infinityloop.upcast.mathlink.dllversion

the version of the MathType mt.dll used; returns null when MathLink is not available or the mt.dll is not found

de.infinityloop.upcast.dir.support

the application's support file directory

de.infinityloop.upcast.dir.licenses

the application's licenses file directory

de.infinityloop.upcast.dir.encodings

the application's custom encoding files directory

de.infinityloop.upcast.file.log

the file that the application uses for logging

de.infinityloop.upcast.dir.tmp

the directory this application uses for temporary files

de.infinityloop.upcast.version.latest

the latest publicly released build number, or the empty string "" if this is the most recent build, or null if the latest build information could not be determined

de.infinityloop.upcast.pipeline.toplevel

true when this is the top level executing pipeline in some hierarchy

de.infinityloop.upcast.pipeline.gui

true when this pipeline shows its GUI (as opposed to when running in API mode or being a sub-pipeline)

de.infinityloop.upcast.pipeline.info

returns the contents of the pipeline information window as string

de.infinityloop.upcast.pipeline.version

returns the compatibility version of the pipeline as string (or the empty string when not existing)

de.infinityloop.upcast.pipeline.build

returns the build number of the pipeline as string (or the empty string when not existing)

java.system.property

the value of the arbitrary, named java.system.property

Returns:

the requested information as formatted string