Package org.apache.hop.ui.pipeline.dialog

Class PipelinePreviewProgressDialog

java.lang.Object

org.apache.hop.ui.pipeline.dialog.PipelinePreviewProgressDialog

public class PipelinePreviewProgressDialog
extends Object

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

Constructor Summary

Constructors

Constructor	Description
PipelinePreviewProgressDialog(org.eclipse.swt.widgets.Shell shell, IVariables variables, PipelineMeta pipelineMeta, String[] previewTransformNames, int[] previewSize)	Creates a new dialog that will handle the wait while previewing a pipeline...

Method Summary

Modifier and Type	Method	Description
String	getLoggingText()
Pipeline	getPipeline()
PipelineDebugMeta	getPipelineDebugMeta()
List<Object[]>	getPreviewRows(String transformName)
IRowMeta	getPreviewRowsMeta(String transformName)
boolean	isCancelled()
PipelineMeta	open()
PipelineMeta	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

PipelinePreviewProgressDialog

public PipelinePreviewProgressDialog(org.eclipse.swt.widgets.Shell shell,
                                     IVariables variables,
                                     PipelineMeta pipelineMeta,
                                     String[] previewTransformNames,
                                     int[] previewSize)

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

Method Detail

open

public PipelineMeta open()

open

public PipelineMeta 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 PipelineMeta

getPreviewRows

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

Parameters:

transformName - the name of the transform to get the preview rows for

Returns:

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

getPreviewRowsMeta

public IRowMeta getPreviewRowsMeta(String transformName)

Parameters:

transformName - the name of the transform 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

getPipeline

public Pipeline getPipeline()

Returns:

The pipeline object that executed the preview PipelineMeta

getPipelineDebugMeta

public PipelineDebugMeta getPipelineDebugMeta()

Returns:

the pipelineDebugMeta