org.pentaho.di.ui.trans.dialog

Class TransPreviewProgressDialog

java.lang.Object

org.pentaho.di.ui.trans.dialog.TransPreviewProgressDialog

public class TransPreviewProgressDialog
extends Object

Takes care of displaying a dialog that will handle the wait while previewing a transformation...

Since:

13-jan-2006

Author:

Matt

Constructor Summary

Constructors

Constructor and Description
TransPreviewProgressDialog(org.eclipse.swt.widgets.Shell shell, TransMeta transMeta, String[] previewStepNames, int[] previewSize) Creates a new dialog that will handle the wait while previewing a transformation...

Method Summary

Modifier and Type	Method and Description
String	getLoggingText()
List<Object[]>	getPreviewRows(String stepname)
RowMetaInterface	getPreviewRowsMeta(String stepname)
Trans	getTrans()
TransDebugMeta	getTransDebugMeta()
boolean	isCancelled()
TransMeta	open()
TransMeta	open(boolean showErrorDialogs) Opens the progress dialog

Methods inherited from class java.lang.Object

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

Constructor Detail

TransPreviewProgressDialog

public TransPreviewProgressDialog(org.eclipse.swt.widgets.Shell shell,
                                  TransMeta transMeta,
                                  String[] previewStepNames,
                                  int[] previewSize)

Creates a new dialog that will handle the wait while previewing a transformation...

Method Detail

open

public TransMeta open()

open

public TransMeta open(boolean showErrorDialogs)

Opens the progress dialog

Parameters:

showErrorDialogs - dictates whether error dialogs should be shown when errors occur - can be set to false to let the caller control error dialogs instead.

Returns:

a TransMeta

getPreviewRows

public List<Object[]> getPreviewRows(String stepname)

Parameters:

stepname - the name of the step to get the preview rows for

Returns:

A list of rows as the result of the preview run.

getPreviewRowsMeta

public RowMetaInterface getPreviewRowsMeta(String stepname)

Parameters:

stepname - the name of the step to get the preview rows for

Returns:

A description of the row (metadata)

isCancelled

public boolean isCancelled()

Returns:

true is the preview was canceled by the user

getLoggingText

public String getLoggingText()

Returns:

The logging text from the latest preview run

getTrans

public Trans getTrans()

Returns:

The transformation object that executed the preview TransMeta

getTransDebugMeta

public TransDebugMeta getTransDebugMeta()

Returns:

the transDebugMeta