org.pentaho.di.trans
Class Trans

java.lang.Object
  org.pentaho.di.trans.Trans

All Implemented Interfaces:

HasLogChannelInterface, LoggingObjectInterface, NamedParams, VariableSpace

public class Trans
extends Object
implements VariableSpace, NamedParams, HasLogChannelInterface, LoggingObjectInterface

This class represents the information and operations associated with the concept of a Transformation. It loads, instantiates, initializes, runs, and monitors the execution of the transformation contained in the specified TransInfo object.

Since:

07-04-2003

Author:

Matt

Field Summary

int	class_nr The class number.
static String	CONFIGURATION_IN_EXPORT_FILENAME Constant specifying a filename containing XML to inject into a ZIP file created during resource export.
static String	REPLAY_DATE_FORMAT The replay date format.
static String	STRING_FINISHED Constant indicating a transformation status of Finished.
static String	STRING_HALTING Constant indicating a transformation status of Halting.
static String	STRING_INITIALIZING Constant indicating a transformation status of Initializing.
static String	STRING_PAUSED Constant indicating a transformation status of Paused.
static String	STRING_PREPARING Constant indicating a transformation status of Preparing for execution.
static String	STRING_RUNNING TConstant indicating a transformation status of Running.
static String	STRING_STOPPED Constant indicating a transformation status of Stopped.
static String	STRING_WAITING Constant indicating a transformation status of Waiting.
static int	TYPE_DISP_1_1 Constant indicating a dispatch type of 1-to-1.
static int	TYPE_DISP_1_N Constant indicating a dispatch type of 1-to-N.
static int	TYPE_DISP_N_1 Constant indicating a dispatch type of N-to-1.
static int	TYPE_DISP_N_M Constant indicating a dispatch type of N-to-N.
static int	TYPE_DISP_N_N Constant indicating a dispatch type of N-to-N.

Constructor Summary

Trans()
Instantiates a new transformation.

Trans(TransMeta transMeta)
Initializes a transformation from transformation meta-data defined in memory.

Trans(TransMeta transMeta, LoggingObjectInterface parent)
Initializes a transformation from transformation meta-data defined in memory.

Trans(VariableSpace parentVariableSpace, Repository rep, String name, String dirname, String filename)
Instantiates a new transformation using any of the provided parameters including the variable bindings, a repository, a name, a repository directory name, and a filename.

Method Summary

void	activateParameters() Activates all parameters by setting their values.
void	addParameterDefinition(String key, String defValue, String description) Adds a parameter definition to this transformation.
RowProducer	addRowProducer(String stepname, int copynr) This adds a row producer to the transformation that just got set up.
void	addTransListener(TransListener transListener) Adds a transformation listener.
void	addTransStoppedListener(TransStoppedListener transStoppedListener) Adds a stop-event listener to the transformation.
void	beginProcessing() Begin processing.
void	calculateBatchIdAndDateRange() Calculate the batch id and date range for the transformation.
void	cleanup() This method performs any cleanup operations, typically called after the transformation has finished.
static int	cleanupCluster(LogChannelInterface log, TransSplitter transSplitter) Cleanup the cluster, including the master and all slaves, and return the number of errors that occurred.
static void	cleanupSlaveServer(TransSplitter transSplitter, SlaveServer slaveServer, TransMeta slaveTransMeta) Cleanup the slave server as part of a clustered transformation.
void	clearParameters() Clear the values of all parameters.
void	copyParametersFrom(NamedParams params) Copy parameters from a NamedParams object.
void	copyVariablesFrom(VariableSpace space) Copies variables from a given variable space to this transformation.
String	environmentSubstitute(String aString) Substitutes any variable values into the given string, and returns the resolved string.
String[]	environmentSubstitute(String[] aString) Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s).
void	eraseParameters() Remove all parameters.
void	execute(String[] arguments) Executes the transformation.
static TransSplitter	executeClustered(TransMeta transMeta, TransExecutionConfiguration executionConfiguration) Execute the transformation in a clustered fashion.
static void	executeClustered(TransSplitter transSplitter, TransExecutionConfiguration executionConfiguration) Executes an existing TransSplitter, with the transformation already split.
List<StepInterface>	findBaseSteps(String stepname) Find the base steps for the step with the specified name.
StepDataInterface	findDataInterface(String name) Find the data interface for the step with the specified name.
MappingInput[]	findMappingInput() Gets the mapping inputs for each step in the transformation.
MappingOutput[]	findMappingOutput() Gets the mapping outputs for each step in the transformation.
RowSet	findRowSet(String rowsetname) Finds the RowSet with the specified name.
RowSet	findRowSet(String from, int fromcopy, String to, int tocopy) Finds the RowSet between two steps (or copies of steps).
StepInterface	findRunThread(String stepname) Find the run thread for the step with the specified name.
Map<String,Trans>	getActiveSubtransformations() Gets the active sub-transformations.
long	getBatchId() Gets the batch ID of the transformation.
boolean	getBooleanValueOfVariable(String variableName, boolean defaultValue) Returns a boolean representation of the specified variable after performing any necessary substitution.
static Result	getClusteredTransformationResult(LogChannelInterface log, TransSplitter transSplitter, Job parentJob) Gets the clustered transformation result.
String	getContainerObjectId() Gets the container object ID.
Date	getCurrentDate() Gets the current date/time object.
Date	getDepDate() Gets the dependency date for the transformation.
Date	getEndDate() Gets the end date/time object for the transformation.
int	getEnded() Gets the number of steps in the transformation that are in an end state, such as Finished, Halted, or Stopped.
int	getErrors() Gets the number of errors that have occurred during execution of the transformation.
String	getFilename() Gets the filename of the transformation, or null if no filename exists
Date	getJobEndDate() Gets the job end date.
Date	getJobStartDate() Gets the job start date.
long	getLastProcessed() Gets a representable metric of the "processed" lines of the last step.
LogChannelInterface	getLogChannel() Gets the log channel interface for the transformation.
String	getLogChannelId() Gets the log channel ID.
Date	getLogDate() Gets the date the transformation was logged.
List<LoggingHierarchy>	getLoggingHierarchy() Gets the logging hierarchy.
LogLevel	getLogLevel() Gets the log level.
String	getMappingStepName() Gets the mapping step name.
String	getName() Gets the name of the transformation.
String	getObjectCopy() Gets the object copy.
ObjectId	getObjectId() Gets the object ID.
String	getObjectName() Gets the object name.
ObjectRevision	getObjectRevision() Gets the object revision.
LoggingObjectType	getObjectType() Gets the object type.
String	getParameterDefault(String key) Gets the default value of the specified parameter.
String	getParameterDescription(String key) Gets the description of the specified parameter.
String	getParameterValue(String key) Gets the value of the specified parameter.
LoggingObjectInterface	getParent() Gets the parent logging object interface.
Job	getParentJob() Gets the parent job, or null if there is no parent.
Trans	getParentTrans() Gets the parent transformation, which is null if no parent transformation exists.
VariableSpace	getParentVariableSpace() Gets the parent variable space.
long	getPassedBatchId() Get the batch ID that is passed from the parent job to the transformation.
Date	getRegistrationDate() Gets the registration date.
Date	getReplayDate() Gets the replay date.
Repository	getRepository() Gets the repository object for the transformation.
RepositoryDirectoryInterface	getRepositoryDirectory() Gets the repository directory.
Result	getResult() Gets the result of the transformation.
List<RowSet>	getRowsets() Gets the rowsets for the transformation.
StepInterface	getRunThread(int i) Gets the run thread for the step at the specified index.
StepInterface	getRunThread(String name, int copy) Gets the run thread for the step with the specified name and copy number.
PrintWriter	getServletPrintWriter() Gets the servlet print writer.
SocketRepository	getSocketRepository() Gets the socket repository.
Date	getStartDate() Gets the start date/time object for the transformation.
String	getStatus() Gets the status of the transformation (Halting, Finished, Paused, etc.)
StepDataInterface	getStepDataInterface(String stepname, int stepcopy) Finds the StepDataInterface (currently) associated with the specified step.
StepInterface	getStepInterface(String stepname, int copy) Find the StepInterface (thread) by looking it up using the name.
Map<String,List<StepPerformanceSnapShot>>	getStepPerformanceSnapShots() Gets a named list (map) of step performance snapshots.
List<StepMetaDataCombi>	getSteps() Gets a list of steps in the transformation.
String	getThreadName() Gets the name of the thread that contains the transformation.
List<TransListener>	getTransListeners() Gets a list of the transformation listeners.
TransMeta	getTransMeta() Gets the meta-data for the transformation.
BaseStepData.StepExecutionStatus[]	getTransStepExecutionStatusLookup() Checks the execution status of each step in the transformations.
boolean[]	getTransStepIsRunningLookup() Checks whether the transformation steps are running lookup.
List<TransStoppedListener>	getTransStoppedListeners() Gets the list of stop-event listeners for the transformation.
String	getVariable(String variableName) Gets the value of the specified variable, or returns a default value if no such variable exists.
String	getVariable(String variableName, String defaultValue) Gets the value of the specified variable, or returns a default value if no such variable exists.
boolean	hasHaltedSteps() Checks whether the transformation has any steps that are halted.
boolean	hasStepStarted(String sname, int copy) Checks whether the specified step (or step copy) has started.
void	initializeVariablesFrom(VariableSpace parent) Sets the values of the transformation's variables to the values from the parent variables.
void	injectVariables(Map<String,String> prop) Injects variables using the given Map.
boolean	isFinished() Checks if the transformation is finished\.
boolean	isInitializing() Checks whether the transformation is initializing.
boolean	isMonitored() Checks whether the running transformation is being monitored.
boolean	isPaused() Checks if the transformation is paused.
boolean	isPreparing() Checks whether the transformation is preparing for execution.
boolean	isPreview() Checks whether the transformation is being previewed.
boolean	isReadyToStart() Checks whether the transformation is ready to start (i.e.
boolean	isRunning() Checks whether the transformation is running.
boolean	isSafeModeEnabled() Checks whether safe mode is enabled.
boolean	isStopped() Checks if the transformation is stopped.
void	killAll() Attempts to stops all running steps and subtransformations.
String[]	listParameters() Gets a list of the parameters for the transformation.
String[]	listVariables() Gets a list of variable names for the transformation.
void	logSummary(StepInterface si) Logs a summary message for the specified step.
static long	monitorClusteredTransformation(LogChannelInterface log, TransSplitter transSplitter, Job parentJob) Monitors a clustered transformation every second, after all the transformations in a cluster schema are running. Now we should verify that they are all running as they should. If a transformation has an error, we should kill them all. This should happen in a separate thread to prevent blocking of the UI. When the master and slave transformations have all finished, we should also run a cleanup on those transformations to release sockets, etc.
static long	monitorClusteredTransformation(LogChannelInterface log, TransSplitter transSplitter, Job parentJob, int sleepTimeSeconds) Monitors a clustered transformation every second, after all the transformations in a cluster schema are running. Now we should verify that they are all running as they should. If a transformation has an error, we should kill them all. This should happen in a separate thread to prevent blocking of the UI. When the master and slave transformations have all finished, we should also run a cleanup on those transformations to release sockets, etc.
static void	monitorRemoteTransformation(LogChannelInterface log, String carteObjectId, String transName, SlaveServer remoteSlaveServer) Monitors a remote transformation every 5 seconds.
static void	monitorRemoteTransformation(LogChannelInterface log, String carteObjectId, String transName, SlaveServer remoteSlaveServer, int sleepTimeSeconds) Monitors a remote transformation at the specified interval.
int	nrActiveSteps() Gets the number of active (i.e.
int	nrSteps() Gets the number of steps in this transformation.
void	pauseRunning() Pauses the transformation (pause all steps).
void	prepareExecution(String[] arguments) Prepares the transformation for execution.
void	printStats(int seconds) Logs the execution statistics for the transformation for the specified time interval.
void	resumeRunning() Resumes running the transformation after a pause (resume all steps).
static String	sendToSlaveServer(TransMeta transMeta, TransExecutionConfiguration executionConfiguration, Repository repository) Send the transformation for execution to a Carte slave server.
void	setBatchId(long batchId) Sets the batch ID of the transformation.
void	setContainerObjectId(String containerObjectId) Sets the container object ID.
void	setInitializing(boolean initializing) Sets whether the transformation is initializing.
void	setInternalKettleVariables(VariableSpace var) Sets the internal kettle variables.
void	setJobEndDate(Date jobEndDate) Sets the job end date.
void	setJobStartDate(Date jobStartDate) Sets the job start date.
void	setLog(LogChannelInterface log) Sets the log channel interface for the transformation.
void	setLogLevel(LogLevel logLevel) Sets the log level.
void	setMappingStepName(String mappingStepName) Sets the mapping step name.
void	setMonitored(boolean monitored) Sets whether the running transformation should be monitored.
void	setParameterValue(String key, String value) Sets the value for the specified parameter.
void	setParent(LoggingObjectInterface parent) Sets the parent logging object.
void	setParentJob(Job parentJob) Sets the parent job for the transformation.
void	setParentTrans(Trans parentTrans) Sets the parent transformation.
void	setParentVariableSpace(VariableSpace parent) Sets the parent variable space.
void	setPassedBatchId(long jobBatchId) Sets the passed batch ID of the transformation from the batch ID of the parent job.
void	setPreparing(boolean preparing) Sets whether the transformation is preparing for execution.
void	setPreview(boolean preview) Sets whether the transformation is being previewed.
void	setReplayDate(Date replayDate) Sets the replay date.
void	setRepository(Repository repository) Sets the repository object for the transformation.
void	setRunning(boolean running) Sets whether the transformation is running.
void	setSafeModeEnabled(boolean safeModeEnabled) Turn on safe mode during running: the transformation will run slower but with more checking enabled.
void	setServletPrintWriter(PrintWriter servletPrintWriter) Sets the servlet print writer.
void	setSocketRepository(SocketRepository socketRepository) Sets the socket repository.
void	setStepPerformanceSnapShots(Map<String,List<StepPerformanceSnapShot>> stepPerformanceSnapShots) Sets the named list (map) of step performance snapshots.
void	setThreadName(String threadName) Sets the thread name for the transformation.
void	setTransListeners(List<TransListener> transListeners) Sets the list of transformation listeners.
void	setTransMeta(TransMeta transMeta) Sets the meta-data for the transformation.
void	setTransStoppedListeners(List<TransStoppedListener> transStoppedListeners) Sets the list of stop-event listeners for the transformation.
void	setVariable(String variableName, String variableValue) Sets the value of the specified variable to the specified value.
void	shareVariablesWith(VariableSpace space) Shares a variable space from another variable space.
void	startThreads() Starts the threads prepared by prepareThreads().
void	stopAll() Stops all steps from running, and alerts any registered listeners.
String	toString() Gets a string representation of the transformation.
void	waitUntilFinished() Waits until all RunThreads have finished.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REPLAY_DATE_FORMAT

public static final String REPLAY_DATE_FORMAT

The replay date format.

See Also:

Constant Field Values

class_nr

public int class_nr

The class number.

TYPE_DISP_1_1

public static final int TYPE_DISP_1_1

Constant indicating a dispatch type of 1-to-1.

See Also:

Constant Field Values

TYPE_DISP_1_N

public static final int TYPE_DISP_1_N

Constant indicating a dispatch type of 1-to-N.

See Also:

Constant Field Values

TYPE_DISP_N_1

public static final int TYPE_DISP_N_1

Constant indicating a dispatch type of N-to-1.

See Also:

Constant Field Values

TYPE_DISP_N_N

public static final int TYPE_DISP_N_N

Constant indicating a dispatch type of N-to-N.

See Also:

Constant Field Values

TYPE_DISP_N_M

public static final int TYPE_DISP_N_M

Constant indicating a dispatch type of N-to-N.

See Also:

Constant Field Values

STRING_FINISHED

public static final String STRING_FINISHED

Constant indicating a transformation status of Finished.

See Also:

Constant Field Values

STRING_RUNNING

public static final String STRING_RUNNING

TConstant indicating a transformation status of Running.

See Also:

Constant Field Values

STRING_PAUSED

public static final String STRING_PAUSED

Constant indicating a transformation status of Paused.

See Also:

Constant Field Values

STRING_PREPARING

public static final String STRING_PREPARING

Constant indicating a transformation status of Preparing for execution.

See Also:

Constant Field Values

STRING_INITIALIZING

public static final String STRING_INITIALIZING

Constant indicating a transformation status of Initializing.

See Also:

Constant Field Values

STRING_WAITING

public static final String STRING_WAITING

Constant indicating a transformation status of Waiting.

See Also:

Constant Field Values

STRING_STOPPED

public static final String STRING_STOPPED

Constant indicating a transformation status of Stopped.

See Also:

Constant Field Values

STRING_HALTING

public static final String STRING_HALTING

Constant indicating a transformation status of Halting.

See Also:

Constant Field Values

CONFIGURATION_IN_EXPORT_FILENAME

public static final String CONFIGURATION_IN_EXPORT_FILENAME

Constant specifying a filename containing XML to inject into a ZIP file created during resource export.

See Also:

Constant Field Values

Constructor Detail

Trans

public Trans()

Instantiates a new transformation.

Trans

public Trans(TransMeta transMeta)

Initializes a transformation from transformation meta-data defined in memory.

Parameters:

transMeta - the transformation meta-data to use.

Trans

public Trans(TransMeta transMeta,
             LoggingObjectInterface parent)

Initializes a transformation from transformation meta-data defined in memory. Also take into account the parent log channel interface (job or transformation) for logging lineage purposes.

Parameters:

transMeta - the transformation meta-data to use.

parent - the parent job that is executing this transformation

Trans

public Trans(VariableSpace parentVariableSpace,
             Repository rep,
             String name,
             String dirname,
             String filename)
      throws KettleException

Instantiates a new transformation using any of the provided parameters including the variable bindings, a repository, a name, a repository directory name, and a filename. This is a multi-purpose method that supports loading a transformation from a file (if the filename is provided but not a repository object) or from a repository (if the repository object, repository directory name, and transformation name are specified).

Parameters:

parentVariableSpace - the parent variable space

rep - the repository

name - the name of the transformation

dirname - the dirname the repository directory name

filename - the filename containing the transformation definition

Throws:

KettleException - if any error occurs during loading, parsing, or creation of the transformation

Method Detail

setParent

public void setParent(LoggingObjectInterface parent)

Sets the parent logging object.

Parameters:

parent - the new parent

getLogChannel

public LogChannelInterface getLogChannel()

Gets the log channel interface for the transformation.

Specified by:

getLogChannel in interface HasLogChannelInterface

Returns:

the log channel

See Also:

HasLogChannelInterface.getLogChannel()

setLog

public void setLog(LogChannelInterface log)

Sets the log channel interface for the transformation.

Parameters:

log - the new log channel interface

getName

public String getName()

Gets the name of the transformation.

Returns:

the transformation name

execute

public void execute(String[] arguments)
             throws KettleException

Executes the transformation. This method will prepare the transformation for execution and then start all the threads associated with the transformation and its steps.

Parameters:

arguments - the arguments

Throws:

KettleException - if the transformation could not be prepared (initialized)

prepareExecution

public void prepareExecution(String[] arguments)
                      throws KettleException

Prepares the transformation for execution. This includes setting the arguments and parameters as well as preparing and tracking the steps and hops in the transformation.

Parameters:

arguments - the arguments to use for this transformation

Throws:

KettleException - in case the transformation could not be prepared (initialized)

startThreads

public void startThreads()
                  throws KettleException

Starts the threads prepared by prepareThreads(). Before you start the threads, you can add RowListeners to them.

Throws:

KettleException - if there is a communication error with a remote output socket.

cleanup

public void cleanup()

This method performs any cleanup operations, typically called after the transformation has finished. Specifically, after ALL the slave transformations in a clustered run have finished.

logSummary

public void logSummary(StepInterface si)

Logs a summary message for the specified step.

Parameters:

si - the step interface

waitUntilFinished

public void waitUntilFinished()

Waits until all RunThreads have finished.

getErrors

public int getErrors()

Gets the number of errors that have occurred during execution of the transformation.

Returns:

the number of errors

getEnded

public int getEnded()

Gets the number of steps in the transformation that are in an end state, such as Finished, Halted, or Stopped.

Returns:

the number of ended steps

isFinished

public boolean isFinished()

Checks if the transformation is finished\.

Returns:

true if the transformation is finished, false otherwise

killAll

public void killAll()

Attempts to stops all running steps and subtransformations. If all steps have finished, the transformation is marked as Finished.

printStats

public void printStats(int seconds)

Logs the execution statistics for the transformation for the specified time interval. If the total length of execution is supplied as the interval, then the statistics represent the average throughput (lines read/written/updated/rejected/etc. per second) for the entire execution.

Parameters:

seconds - the time interval (in seconds)

getLastProcessed

public long getLastProcessed()

Gets a representable metric of the "processed" lines of the last step.

Returns:

the number of lines processed by the last step

findRowSet

public RowSet findRowSet(String rowsetname)

Finds the RowSet with the specified name.

Parameters:

rowsetname - the rowsetname

Returns:

the row set, or null if none found

findRowSet

public RowSet findRowSet(String from,
                         int fromcopy,
                         String to,
                         int tocopy)

Finds the RowSet between two steps (or copies of steps).

Parameters:

from - the name of the "from" step

fromcopy - the copy number of the "from" step

to - the name of the "to" step

tocopy - the copy number of the "to" step

Returns:

the row set, or null if none found

hasStepStarted

public boolean hasStepStarted(String sname,
                              int copy)

Checks whether the specified step (or step copy) has started.

Parameters:

sname - the step name

copy - the copy number

Returns:

true the specified step (or step copy) has started, false otherwise

stopAll

public void stopAll()

Stops all steps from running, and alerts any registered listeners.

nrSteps

public int nrSteps()

Gets the number of steps in this transformation.

Returns:

the number of steps

nrActiveSteps

public int nrActiveSteps()

Gets the number of active (i.e. not finished) steps in this transformation

Returns:

the number of active steps

getTransStepIsRunningLookup

public boolean[] getTransStepIsRunningLookup()

Checks whether the transformation steps are running lookup.

Returns:

a boolean array associated with the step list, indicating whether that step is running a lookup.

getTransStepExecutionStatusLookup

public BaseStepData.StepExecutionStatus[] getTransStepExecutionStatusLookup()

Checks the execution status of each step in the transformations.

Returns:

an array associated with the step list, indicating the status of that step.

getRunThread

public StepInterface getRunThread(int i)

Gets the run thread for the step at the specified index.

Parameters:

i - the index of the desired step

Returns:

a StepInterface object corresponding to the run thread for the specified step

getRunThread

public StepInterface getRunThread(String name,
                                  int copy)

Gets the run thread for the step with the specified name and copy number.

Parameters:

name - the step name

copy - the copy number

Returns:

a StepInterface object corresponding to the run thread for the specified step

calculateBatchIdAndDateRange

public void calculateBatchIdAndDateRange()
                                  throws KettleTransException

Calculate the batch id and date range for the transformation.

Throws:

KettleTransException - if there are any errors during calculation

beginProcessing

public void beginProcessing()
                     throws KettleTransException

Begin processing. Also handle logging operations related to the start of the transformation

Throws:

KettleTransException - the kettle trans exception

getResult

public Result getResult()

Gets the result of the transformation. The Result object contains such measures as the number of errors, number of lines read/written/input/output/updated/rejected, etc.

Returns:

the Result object containing resulting measures from execution of the transformation

findRunThread

public StepInterface findRunThread(String stepname)

Find the run thread for the step with the specified name.

Parameters:

stepname - the step name

Returns:

a StepInterface object corresponding to the run thread for the specified step

findBaseSteps

public List<StepInterface> findBaseSteps(String stepname)

Find the base steps for the step with the specified name.

Parameters:

stepname - the step name

Returns:

the list of base steps for the specified step

findDataInterface

public StepDataInterface findDataInterface(String name)

Find the data interface for the step with the specified name.

Parameters:

name - the step name

Returns:

the step data interface

getStartDate

public Date getStartDate()

Gets the start date/time object for the transformation.

Returns:

Returns the startDate.

getEndDate

public Date getEndDate()

Gets the end date/time object for the transformation.

Returns:

Returns the endDate.

isMonitored

public boolean isMonitored()

Checks whether the running transformation is being monitored.

Returns:

true the running transformation is being monitored, false otherwise

setMonitored

public void setMonitored(boolean monitored)

Sets whether the running transformation should be monitored.

Parameters:

monitored - true if the running transformation should be monitored, false otherwise

getTransMeta

public TransMeta getTransMeta()

Gets the meta-data for the transformation.

Returns:

Returns the transformation meta-data

setTransMeta

public void setTransMeta(TransMeta transMeta)

Sets the meta-data for the transformation.

Parameters:

transMeta - The transformation meta-data to set.

getCurrentDate

public Date getCurrentDate()

Gets the current date/time object.

Returns:

the current date

getDepDate

public Date getDepDate()

Gets the dependency date for the transformation. A transformation can have a list of dependency fields. If any of these fields have a maximum date higher than the dependency date of the last run, the date range is set to to (-oo, now). The use-case is the incremental population of Slowly Changing Dimensions (SCD).

Returns:

Returns the dependency date

getLogDate

public Date getLogDate()

Gets the date the transformation was logged.

Returns:

the log date

getRowsets

public List<RowSet> getRowsets()

Gets the rowsets for the transformation.

Returns:

a list of rowsets

getSteps

public List<StepMetaDataCombi> getSteps()

Gets a list of steps in the transformation.

Returns:

a list of the steps in the transformation

toString

public String toString()

Gets a string representation of the transformation.

Overrides:

toString in class Object

Returns:

the string representation of the transformation

See Also:

Object.toString()

findMappingInput

public MappingInput[] findMappingInput()

Gets the mapping inputs for each step in the transformation.

Returns:

an array of MappingInputs

findMappingOutput

public MappingOutput[] findMappingOutput()

Gets the mapping outputs for each step in the transformation.

Returns:

an array of MappingOutputs

getStepInterface

public StepInterface getStepInterface(String stepname,
                                      int copy)

Find the StepInterface (thread) by looking it up using the name.

Parameters:

stepname - The name of the step to look for

copy - the copy number of the step to look for

Returns:

the StepInterface or null if nothing was found.

getReplayDate

public Date getReplayDate()

Gets the replay date. The replay date is used to indicate that the transformation was replayed (re-tried, run again) with that particular replay date. You can use this in Text File/Excel Input to allow you to save error line numbers into a file (SOURCE_FILE.line for example) During replay, only the lines that have errors in them are passed to the next steps, the other lines are ignored. This is for the use case: if the document contained errors (bad dates, chars in numbers, etc), you simply send the document back to the source (the user/departement that created it probably) and when you get it back, re-run the last transformation.

Returns:

the replay date

setReplayDate

public void setReplayDate(Date replayDate)

Sets the replay date. The replay date is used to indicate that the transformation was replayed (re-tried, run again) with that particular replay date. You can use this in Text File/Excel Input to allow you to save error line numbers into a file (SOURCE_FILE.line for example) During replay, only the lines that have errors in them are passed to the next steps, the other lines are ignored. This is for the use case: if the document contained errors (bad dates, chars in numbers, etc), you simply send the document back to the source (the user/departement that created it probably) and when you get it back, re-run the last transformation.

Parameters:

replayDate - the new replay date

setSafeModeEnabled

public void setSafeModeEnabled(boolean safeModeEnabled)

Turn on safe mode during running: the transformation will run slower but with more checking enabled.

Parameters:

safeModeEnabled - true for safe mode

isSafeModeEnabled

public boolean isSafeModeEnabled()

Checks whether safe mode is enabled.

Returns:

Returns true if the safe mode is enabled: the transformation will run slower but with more checking enabled

addRowProducer

public RowProducer addRowProducer(String stepname,
                                  int copynr)
                           throws KettleException

This adds a row producer to the transformation that just got set up. It is preferable to run this BEFORE execute() but after prepareExecution()

Parameters:

stepname - The step to produce rows for

copynr - The copynr of the step to produce row for (normally 0 unless you have multiple copies running)

Returns:

the row producer

Throws:

KettleException - in case the thread/step to produce rows for could not be found.

See Also:

execute(String[]), prepareExecution(String[])

getParentJob

public Job getParentJob()

Gets the parent job, or null if there is no parent.

Returns:

the parent job, or null if there is no parent

setParentJob

public void setParentJob(Job parentJob)

Sets the parent job for the transformation.

Parameters:

parentJob - The parent job to set

getStepDataInterface

public StepDataInterface getStepDataInterface(String stepname,
                                              int stepcopy)

Finds the StepDataInterface (currently) associated with the specified step.

Parameters:

stepname - The name of the step to look for

stepcopy - The copy number (0 based) of the step

Returns:

The StepDataInterface or null if non found.

hasHaltedSteps

public boolean hasHaltedSteps()

Checks whether the transformation has any steps that are halted.

Returns:

true if one or more steps are halted, false otherwise

getJobStartDate

public Date getJobStartDate()

Gets the job start date.

Returns:

the job start date

getJobEndDate

public Date getJobEndDate()

Gets the job end date.

Returns:

the job end date

setJobEndDate

public void setJobEndDate(Date jobEndDate)

Sets the job end date.

Parameters:

jobEndDate - the jobEndDate to set

setJobStartDate

public void setJobStartDate(Date jobStartDate)

Sets the job start date.

Parameters:

jobStartDate - the jobStartDate to set

getPassedBatchId

public long getPassedBatchId()

Get the batch ID that is passed from the parent job to the transformation. If nothing is passed, it's the transformation's batch ID

Returns:

the parent job's batch ID, or the transformation's batch ID if there is no parent job

setPassedBatchId

public void setPassedBatchId(long jobBatchId)

Sets the passed batch ID of the transformation from the batch ID of the parent job.

Parameters:

jobBatchId - the jobBatchId to set

getBatchId

public long getBatchId()

Gets the batch ID of the transformation.

Returns:

the batch ID of the transformation

setBatchId

public void setBatchId(long batchId)

Sets the batch ID of the transformation.

Parameters:

batchId - the batch ID to set

getThreadName

public String getThreadName()

Gets the name of the thread that contains the transformation.

Returns:

the thread name

setThreadName

public void setThreadName(String threadName)

Sets the thread name for the transformation.

Parameters:

threadName - the thread name

getStatus

public String getStatus()

Gets the status of the transformation (Halting, Finished, Paused, etc.)

Returns:

the status of the transformation

isInitializing

public boolean isInitializing()

Checks whether the transformation is initializing.

Returns:

true if the transformation is initializing, false otherwise

setInitializing

public void setInitializing(boolean initializing)

Sets whether the transformation is initializing.

Parameters:

initializing - true if the transformation is initializing, false otherwise

isPreparing

public boolean isPreparing()

Checks whether the transformation is preparing for execution.

Returns:

true if the transformation is preparing for execution, false otherwise

setPreparing

public void setPreparing(boolean preparing)

Sets whether the transformation is preparing for execution.

Parameters:

preparing - true if the transformation is preparing for execution, false otherwise

isRunning

public boolean isRunning()

Checks whether the transformation is running.

Returns:

true if the transformation is running, false otherwise

setRunning

public void setRunning(boolean running)

Sets whether the transformation is running.

Parameters:

running - true if the transformation is running, false otherwise

executeClustered

public static final TransSplitter executeClustered(TransMeta transMeta,
                                                   TransExecutionConfiguration executionConfiguration)
                                            throws KettleException

Execute the transformation in a clustered fashion. The transformation steps are split and collected in a TransSplitter object

Parameters:

transMeta - the transformation's meta-data

executionConfiguration - the execution configuration

Returns:

the transformation splitter object

Throws:

KettleException - the kettle exception

executeClustered

public static final void executeClustered(TransSplitter transSplitter,
                                          TransExecutionConfiguration executionConfiguration)
                                   throws KettleException

Executes an existing TransSplitter, with the transformation already split.

Parameters:

transSplitter - the trans splitter

executionConfiguration - the execution configuration

Throws:

KettleException - the kettle exception

See Also:

SpoonTransformationDelegate

monitorClusteredTransformation

public static final long monitorClusteredTransformation(LogChannelInterface log,
                                                        TransSplitter transSplitter,
                                                        Job parentJob)

Monitors a clustered transformation every second, after all the transformations in a cluster schema are running.
Now we should verify that they are all running as they should.
If a transformation has an error, we should kill them all.
This should happen in a separate thread to prevent blocking of the UI.

When the master and slave transformations have all finished, we should also run
a cleanup on those transformations to release sockets, etc.

Parameters:

log - the log interface channel

transSplitter - the transformation splitter object

parentJob - the parent job when executed in a job, otherwise just set to null

Returns:

the number of errors encountered

monitorClusteredTransformation

public static final long monitorClusteredTransformation(LogChannelInterface log,
                                                        TransSplitter transSplitter,
                                                        Job parentJob,
                                                        int sleepTimeSeconds)

Monitors a clustered transformation every second, after all the transformations in a cluster schema are running.
Now we should verify that they are all running as they should.
If a transformation has an error, we should kill them all.
This should happen in a separate thread to prevent blocking of the UI.

When the master and slave transformations have all finished, we should also run
a cleanup on those transformations to release sockets, etc.

Parameters:

log - the subject to use for logging

transSplitter - the transformation splitter object

parentJob - the parent job when executed in a job, otherwise just set to null

sleepTimeSeconds - the sleep time in seconds in between slave transformation status polling

Returns:

the number of errors encountered

cleanupCluster

public static int cleanupCluster(LogChannelInterface log,
                                 TransSplitter transSplitter)

Cleanup the cluster, including the master and all slaves, and return the number of errors that occurred.

Parameters:

log - the log channel interface

transSplitter - the TransSplitter object

Returns:

the number of errors that occurred in the clustered transformation

cleanupSlaveServer

public static void cleanupSlaveServer(TransSplitter transSplitter,
                                      SlaveServer slaveServer,
                                      TransMeta slaveTransMeta)
                               throws KettleException

Cleanup the slave server as part of a clustered transformation.

Parameters:

transSplitter - the TransSplitter object

slaveServer - the slave server

slaveTransMeta - the slave transformation meta-data

Throws:

KettleException - if any errors occur during cleanup

getClusteredTransformationResult

public static final Result getClusteredTransformationResult(LogChannelInterface log,
                                                            TransSplitter transSplitter,
                                                            Job parentJob)

Gets the clustered transformation result.

Parameters:

log - the log channel interface

transSplitter - the TransSplitter object

parentJob - the parent job

Returns:

the clustered transformation result

sendToSlaveServer

public static String sendToSlaveServer(TransMeta transMeta,
                                       TransExecutionConfiguration executionConfiguration,
                                       Repository repository)
                                throws KettleException

Send the transformation for execution to a Carte slave server.

Parameters:

transMeta - the transformation meta-data

executionConfiguration - the transformation execution configuration

repository - the repository

Returns:

The Carte object ID on the server.

Throws:

KettleException - if any errors occur during the dispatch to the slave server

isReadyToStart

public boolean isReadyToStart()

Checks whether the transformation is ready to start (i.e. execution preparation was successful)

Returns:

true if the transformation was prepared for execution successfully, false otherwise

See Also:

prepareExecution(String[])

setInternalKettleVariables

public void setInternalKettleVariables(VariableSpace var)

Sets the internal kettle variables.

Parameters:

var - the new internal kettle variables

copyVariablesFrom

public void copyVariablesFrom(VariableSpace space)

Copies variables from a given variable space to this transformation.

Specified by:

copyVariablesFrom in interface VariableSpace

Parameters:

space - the variable space

See Also:

VariableSpace.copyVariablesFrom(org.pentaho.di.core.variables.VariableSpace)

environmentSubstitute

public String environmentSubstitute(String aString)

Substitutes any variable values into the given string, and returns the resolved string.

Specified by:

environmentSubstitute in interface VariableSpace

Parameters:

aString - the string to resolve against environment variables

Returns:

the string after variables have been resolved/susbstituted

See Also:

VariableSpace.environmentSubstitute(java.lang.String)

environmentSubstitute

public String[] environmentSubstitute(String[] aString)

Substitutes any variable values into each of the given strings, and returns an array containing the resolved string(s).

Specified by:

environmentSubstitute in interface VariableSpace

Parameters:

aString - an array of strings to resolve against environment variables

Returns:

the array of strings after variables have been resolved/susbstituted

See Also:

VariableSpace.environmentSubstitute(java.lang.String[])

getParentVariableSpace

public VariableSpace getParentVariableSpace()

Gets the parent variable space.

Specified by:

getParentVariableSpace in interface VariableSpace

Returns:

the parent variable space

See Also:

VariableSpace.getParentVariableSpace()

setParentVariableSpace

public void setParentVariableSpace(VariableSpace parent)

Sets the parent variable space.

Specified by:

setParentVariableSpace in interface VariableSpace

Parameters:

parent - the new parent variable space

See Also:

VariableSpace.setParentVariableSpace(org.pentaho.di.core.variables.VariableSpace)

getVariable

public String getVariable(String variableName,
                          String defaultValue)

Gets the value of the specified variable, or returns a default value if no such variable exists.

Specified by:

getVariable in interface VariableSpace

Parameters:

variableName - the variable name

defaultValue - the default value

Returns:

the value of the specified variable, or returns a default value if no such variable exists

See Also:

VariableSpace.getVariable(java.lang.String, java.lang.String)

getVariable

public String getVariable(String variableName)

Gets the value of the specified variable, or returns a default value if no such variable exists.

Specified by:

getVariable in interface VariableSpace

Parameters:

variableName - the variable name

Returns:

the value of the specified variable, or returns a default value if no such variable exists

See Also:

VariableSpace.getVariable(java.lang.String)

getBooleanValueOfVariable

public boolean getBooleanValueOfVariable(String variableName,
                                         boolean defaultValue)

Returns a boolean representation of the specified variable after performing any necessary substitution. Truth values include case-insensitive versions of "Y", "YES", "TRUE" or "1".

Specified by:

getBooleanValueOfVariable in interface VariableSpace

Parameters:

variableName - the variable name

defaultValue - the default value

Returns:

a boolean representation of the specified variable after performing any necessary substitution

See Also:

VariableSpace.getBooleanValueOfVariable(java.lang.String, boolean)

initializeVariablesFrom

public void initializeVariablesFrom(VariableSpace parent)

Sets the values of the transformation's variables to the values from the parent variables.

Specified by:

initializeVariablesFrom in interface VariableSpace

Parameters:

parent - the parent

See Also:

VariableSpace.initializeVariablesFrom(org.pentaho.di.core.variables.VariableSpace)

listVariables

public String[] listVariables()

Gets a list of variable names for the transformation.

Specified by:

listVariables in interface VariableSpace

Returns:

a list of variable names

See Also:

VariableSpace.listVariables()

setVariable

public void setVariable(String variableName,
                        String variableValue)

Sets the value of the specified variable to the specified value.

Specified by:

setVariable in interface VariableSpace

Parameters:

variableName - the variable name

variableValue - the variable value

See Also:

VariableSpace.setVariable(java.lang.String, java.lang.String)

shareVariablesWith

public void shareVariablesWith(VariableSpace space)

Shares a variable space from another variable space. This means that the object should take over the space used as argument.

Specified by:

shareVariablesWith in interface VariableSpace

Parameters:

space - the variable space

See Also:

VariableSpace.shareVariablesWith(org.pentaho.di.core.variables.VariableSpace)

injectVariables

public void injectVariables(Map<String,String> prop)

Injects variables using the given Map. The behavior should be that the properties object will be stored and at the time the VariableSpace is initialized (or upon calling this method if the space is already initialized). After injecting the link of the properties object should be removed.

Specified by:

injectVariables in interface VariableSpace

Parameters:

prop - the property map

See Also:

VariableSpace.injectVariables(java.util.Map)

pauseRunning

public void pauseRunning()

Pauses the transformation (pause all steps).

resumeRunning

public void resumeRunning()

Resumes running the transformation after a pause (resume all steps).

isPreview

public boolean isPreview()

Checks whether the transformation is being previewed.

Returns:

true if the transformation is being previewed, false otherwise

setPreview

public void setPreview(boolean preview)

Sets whether the transformation is being previewed.

Parameters:

preview - true if the transformation is being previewed, false otherwise

getRepository

public Repository getRepository()

Gets the repository object for the transformation.

Returns:

the repository

setRepository

public void setRepository(Repository repository)

Sets the repository object for the transformation.

Parameters:

repository - the repository object to set

getStepPerformanceSnapShots

public Map<String,List<StepPerformanceSnapShot>> getStepPerformanceSnapShots()

Gets a named list (map) of step performance snapshots.

Returns:

a named list (map) of step performance snapshots

setStepPerformanceSnapShots

public void setStepPerformanceSnapShots(Map<String,List<StepPerformanceSnapShot>> stepPerformanceSnapShots)

Sets the named list (map) of step performance snapshots.

Parameters:

stepPerformanceSnapShots - a named list (map) of step performance snapshots to set

getTransListeners

public List<TransListener> getTransListeners()

Gets a list of the transformation listeners.

Returns:

the transListeners

setTransListeners

public void setTransListeners(List<TransListener> transListeners)

Sets the list of transformation listeners.

Parameters:

transListeners - the transListeners to set

addTransListener

public void addTransListener(TransListener transListener)

Adds a transformation listener.

Parameters:

transListener - the trans listener

setTransStoppedListeners

public void setTransStoppedListeners(List<TransStoppedListener> transStoppedListeners)

Sets the list of stop-event listeners for the transformation.

Parameters:

transStoppedListeners - the list of stop-event listeners to set

getTransStoppedListeners

public List<TransStoppedListener> getTransStoppedListeners()

Gets the list of stop-event listeners for the transformation.

Returns:

the list of stop-event listeners

addTransStoppedListener

public void addTransStoppedListener(TransStoppedListener transStoppedListener)

Adds a stop-event listener to the transformation.

Parameters:

transStoppedListener - the stop-event listener to add

isPaused

public boolean isPaused()

Checks if the transformation is paused.

Returns:

true if the transformation is paused, false otherwise

isStopped

public boolean isStopped()

Checks if the transformation is stopped.

Returns:

true if the transformation is stopped, false otherwise

monitorRemoteTransformation

public static void monitorRemoteTransformation(LogChannelInterface log,
                                               String carteObjectId,
                                               String transName,
                                               SlaveServer remoteSlaveServer)

Monitors a remote transformation every 5 seconds.

Parameters:

log - the log channel interface

carteObjectId - the Carte object ID

transName - the transformation name

remoteSlaveServer - the remote slave server

monitorRemoteTransformation

public static void monitorRemoteTransformation(LogChannelInterface log,
                                               String carteObjectId,
                                               String transName,
                                               SlaveServer remoteSlaveServer,
                                               int sleepTimeSeconds)

Monitors a remote transformation at the specified interval.

Parameters:

log - the log channel interface

carteObjectId - the Carte object ID

transName - the transformation name

remoteSlaveServer - the remote slave server

sleepTimeSeconds - the sleep time (in seconds)

addParameterDefinition

public void addParameterDefinition(String key,
                                   String defValue,
                                   String description)
                            throws DuplicateParamException

Adds a parameter definition to this transformation.

Specified by:

addParameterDefinition in interface NamedParams

Parameters:

key - the name of the parameter

defValue - the default value for the parameter

description - the description of the parameter

Throws:

DuplicateParamException - the duplicate param exception

See Also:

NamedParams.addParameterDefinition(java.lang.String, java.lang.String, java.lang.String)

getParameterDefault

public String getParameterDefault(String key)
                           throws UnknownParamException

Gets the default value of the specified parameter.

Specified by:

getParameterDefault in interface NamedParams

Parameters:

key - the name of the parameter

Returns:

the default value of the parameter

Throws:

UnknownParamException - if the parameter does not exist

See Also:

NamedParams.getParameterDefault(java.lang.String)

getParameterDescription

public String getParameterDescription(String key)
                               throws UnknownParamException

Gets the description of the specified parameter.

Specified by:

getParameterDescription in interface NamedParams

Parameters:

key - the name of the parameter

Returns:

the parameter description

Throws:

UnknownParamException - if the parameter does not exist

See Also:

NamedParams.getParameterDescription(java.lang.String)

getParameterValue

public String getParameterValue(String key)
                         throws UnknownParamException

Gets the value of the specified parameter.

Specified by:

getParameterValue in interface NamedParams

Parameters:

key - the name of the parameter

Returns:

the parameter value

Throws:

UnknownParamException - if the parameter does not exist

See Also:

NamedParams.getParameterValue(java.lang.String)

listParameters

public String[] listParameters()

Gets a list of the parameters for the transformation.

Specified by:

listParameters in interface NamedParams

Returns:

an array of strings containing the names of all parameters for the transformation

See Also:

NamedParams.listParameters()

setParameterValue

public void setParameterValue(String key,
                              String value)
                       throws UnknownParamException

Sets the value for the specified parameter.

Specified by:

setParameterValue in interface NamedParams

Parameters:

key - the name of the parameter

value - the name of the value

Throws:

UnknownParamException - if the parameter does not exist

See Also:

NamedParams.setParameterValue(java.lang.String, java.lang.String)

eraseParameters

public void eraseParameters()

Remove all parameters.

Specified by:

eraseParameters in interface NamedParams

See Also:

NamedParams.eraseParameters()

clearParameters

public void clearParameters()

Clear the values of all parameters.

Specified by:

clearParameters in interface NamedParams

See Also:

NamedParams.clearParameters()

activateParameters

public void activateParameters()

Activates all parameters by setting their values. If no values already exist, the method will attempt to set the parameter to the default value. If no default value exists, the method will set the value of the parameter to the empty string ("").

Specified by:

activateParameters in interface NamedParams

See Also:

NamedParams.activateParameters()

copyParametersFrom

public void copyParametersFrom(NamedParams params)

Copy parameters from a NamedParams object.

Specified by:

copyParametersFrom in interface NamedParams

Parameters:

params - the NamedParams object from which to copy the parameters

See Also:

NamedParams.copyParametersFrom(org.pentaho.di.core.parameters.NamedParams)

getParentTrans

public Trans getParentTrans()

Gets the parent transformation, which is null if no parent transformation exists.

Returns:

a reference to the parent transformation's Trans object, or null if no parent transformation exists

setParentTrans

public void setParentTrans(Trans parentTrans)

Sets the parent transformation.

Parameters:

parentTrans - the parent Trans to set

getMappingStepName

public String getMappingStepName()

Gets the mapping step name.

Returns:

the name of the mapping step that created this transformation

setMappingStepName

public void setMappingStepName(String mappingStepName)

Sets the mapping step name.

Parameters:

mappingStepName - the name of the mapping step that created this transformation

setSocketRepository

public void setSocketRepository(SocketRepository socketRepository)

Sets the socket repository.

Parameters:

socketRepository - the new socket repository

getSocketRepository

public SocketRepository getSocketRepository()

Gets the socket repository.

Returns:

the socket repository

getObjectName

public String getObjectName()

Gets the object name.

Specified by:

getObjectName in interface LoggingObjectInterface

Returns:

the object name

See Also:

LoggingObjectInterface.getObjectName()

getObjectCopy

public String getObjectCopy()

Gets the object copy. For Trans, this always returns null

Specified by:

getObjectCopy in interface LoggingObjectInterface

Returns:

null

See Also:

LoggingObjectInterface.getObjectCopy()

getFilename

public String getFilename()

Gets the filename of the transformation, or null if no filename exists

Specified by:

getFilename in interface LoggingObjectInterface

Returns:

the filename

See Also:

LoggingObjectInterface.getFilename()

getLogChannelId

public String getLogChannelId()

Gets the log channel ID.

Specified by:

getLogChannelId in interface LoggingObjectInterface

Returns:

the log channel ID

See Also:

LoggingObjectInterface.getLogChannelId()

getObjectId

public ObjectId getObjectId()

Gets the object ID.

Specified by:

getObjectId in interface LoggingObjectInterface

Returns:

the object ID

See Also:

LoggingObjectInterface.getObjectId()

getObjectRevision

public ObjectRevision getObjectRevision()

Gets the object revision.

Specified by:

getObjectRevision in interface LoggingObjectInterface

Returns:

the object revision

See Also:

LoggingObjectInterface.getObjectRevision()

getObjectType

public LoggingObjectType getObjectType()

Gets the object type. For Trans, this always returns LoggingObjectType.TRANS

Specified by:

getObjectType in interface LoggingObjectInterface

Returns:

the object type

See Also:

LoggingObjectInterface.getObjectType()

getParent

public LoggingObjectInterface getParent()

Gets the parent logging object interface.

Specified by:

getParent in interface LoggingObjectInterface

Returns:

the parent

See Also:

LoggingObjectInterface.getParent()

getRepositoryDirectory

public RepositoryDirectoryInterface getRepositoryDirectory()

Gets the repository directory.

Specified by:

getRepositoryDirectory in interface LoggingObjectInterface

Returns:

the repository directory

See Also:

LoggingObjectInterface.getRepositoryDirectory()

getLogLevel

public LogLevel getLogLevel()

Gets the log level.

Specified by:

getLogLevel in interface LoggingObjectInterface

Returns:

the log level

See Also:

LoggingObjectInterface.getLogLevel()

setLogLevel

public void setLogLevel(LogLevel logLevel)

Sets the log level.

Parameters:

logLevel - the new log level

getLoggingHierarchy

public List<LoggingHierarchy> getLoggingHierarchy()

Gets the logging hierarchy.

Returns:

the logging hierarchy

getActiveSubtransformations

public Map<String,Trans> getActiveSubtransformations()

Gets the active sub-transformations.

Returns:

a map (by name) of the active sub-transformations

getContainerObjectId

public String getContainerObjectId()

Gets the container object ID.

Specified by:

getContainerObjectId in interface LoggingObjectInterface

Returns:

the Carte object ID

setContainerObjectId

public void setContainerObjectId(String containerObjectId)

Sets the container object ID.

Parameters:

containerObjectId - the Carte object ID to set

getRegistrationDate

public Date getRegistrationDate()

Gets the registration date. For Trans, this always returns null

Specified by:

getRegistrationDate in interface LoggingObjectInterface

Returns:

null

setServletPrintWriter

public void setServletPrintWriter(PrintWriter servletPrintWriter)

Sets the servlet print writer.

Parameters:

servletPrintWriter - the new servlet print writer

getServletPrintWriter

public PrintWriter getServletPrintWriter()

Gets the servlet print writer.

Returns:

the servlet print writer