Package org.pentaho.di.ui.job.entry

Class JobEntryDialog

java.lang.Object
org.eclipse.swt.widgets.Dialog
org.pentaho.di.ui.job.entry.JobEntryDialog
Direct Known Subclasses:
JobEntryBaseDialog, JobEntryCheckFilesLockedDialog, JobEntryColumnsExistDialog, JobEntryCopyFilesDialog, JobEntryCopyMoveResultFilenamesDialog, JobEntryCreateFileDialog, JobEntryCreateFolderDialog, JobEntryDelayDialog, JobEntryDeleteFileDialog, JobEntryDeleteFilesDialog, JobEntryDeleteFoldersDialog, JobEntryDeleteResultFilenamesDialog, JobEntryDosToUnixDialog, JobEntryEvalDialog, JobEntryEvalFilesMetricsDialog, JobEntryEvalTableContentDialog, JobEntryFileCompareDialog, JobEntryFileExistsDialog, JobEntryFilesExistDialog, JobEntryFolderIsEmptyDialog, JobEntryFoldersCompareDialog, JobEntryHTTPDialog, JobEntryMoveFilesDialog, JobEntryMssqlBulkLoadDialog, JobEntryMysqlBulkFileDialog, JobEntryMysqlBulkLoadDialog, JobEntryPGPDecryptFilesDialog, JobEntryPGPEncryptFilesDialog, JobEntryPGPVerifyDialog, JobEntryPingDialog, JobEntrySendNagiosPassiveCheckDialog, JobEntrySetVariablesDialog, JobEntryShellDialog, JobEntrySimpleEvalDialog, JobEntrySNMPTrapDialog, JobEntrySpecialDialog, JobEntrySQLDialog, JobEntrySuccessDialog, JobEntrySyslogDialog, JobEntryTableExistsDialog, JobEntryTalendJobExecDialog, JobEntryTelnetDialog, JobEntryTruncateTablesDialog, JobEntryUnZipDialog, JobEntryWaitForFileDialog, JobEntryWaitForSQLDialog, JobEntryWebServiceAvailableDialog, JobEntryWriteToFileDialog, JobEntryWriteToLogDialog, JobEntryZipFileDialog, JobStepDialog, MissingEntryDialog
public class JobEntryDialog extends org.eclipse.swt.widgets.Dialog
The JobEntryDialog class is responsible for constructing and opening the settings dialog for the job entry. Whenever the user opens the job entry settings in Spoon, it will instantiate the dialog class passing in the JobEntryInterface object and call the 
 open()

method on the dialog. SWT is the native windowing environment of Spoon, and it is typically the framework used for implementing job entry dialogs.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected DatabaseDialog
    databaseDialog
    A reference to a database dialog
    protected org.pentaho.di.job.entry.JobEntryInterface
    jobEntryInt
    A reference to the job entry interface
    protected org.pentaho.di.job.JobMeta
    jobMeta
    The job metadata object.
    static final org.pentaho.di.core.logging.LoggingObjectInterface
    loggingObject
    The loggingObject for the dialog
    protected org.pentaho.metastore.api.IMetaStore
    metaStore
    the MetaStore
    protected org.eclipse.swt.widgets.Shell
    parent
    A reference to the parent shell
    protected PropsUI
    props
    A reference to the properties user interface
    protected org.pentaho.di.repository.Repository
    rep
    The repository
    protected org.eclipse.swt.widgets.Shell
    shell
    A reference to the shell object

  • Constructor Summary

    Constructors
    Constructor
    Description
    JobEntryDialog(org.eclipse.swt.widgets.Shell parent, org.pentaho.di.job.entry.JobEntryInterface jobEntry, org.pentaho.di.repository.Repository rep, org.pentaho.di.job.JobMeta jobMeta)
    Instantiates a new job entry dialog.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.swt.custom.CCombo
    addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, int middle, int margin)
    Adds the connection line for the given parent and previous control, and returns a combo box UI component
    org.eclipse.swt.custom.CCombo
    addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, int middle, int margin, org.eclipse.swt.widgets.Label wlConnection, org.eclipse.swt.widgets.Button wbwConnection, org.eclipse.swt.widgets.Button wbnConnection, org.eclipse.swt.widgets.Button wbeConnection)
    Adds the connection line for the given parent and previous control, and returns a combo box UI component
    void
    addDatabases(org.eclipse.swt.custom.CCombo wConnection)
    Adds the databases from the job metadata to the combo box.
    org.pentaho.metastore.api.IMetaStore
    getMetaStore()
     
    protected String
    getPathOf(org.pentaho.di.repository.RepositoryElementMetaInterface object)
     
    void
    selectDatabase(org.eclipse.swt.custom.CCombo wConnection, String name)
    Selects a database from the combo box
    void
    setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)
     

    Methods inherited from class org.eclipse.swt.widgets.Dialog

    checkSubclass, getParent, getStyle, getText, setText

    Methods inherited from class java.lang.Object

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

  • Field Details

    • loggingObject

      public static final org.pentaho.di.core.logging.LoggingObjectInterface loggingObject
      The loggingObject for the dialog

    • jobEntryInt

      protected org.pentaho.di.job.entry.JobEntryInterface jobEntryInt
      A reference to the job entry interface

    • rep

      protected org.pentaho.di.repository.Repository rep
      The repository

    • metaStore

      protected org.pentaho.metastore.api.IMetaStore metaStore
      the MetaStore

    • jobMeta

      protected org.pentaho.di.job.JobMeta jobMeta
      The job metadata object.

    • shell

      protected org.eclipse.swt.widgets.Shell shell
      A reference to the shell object

    • props

      protected PropsUI props
      A reference to the properties user interface

    • parent

      protected org.eclipse.swt.widgets.Shell parent
      A reference to the parent shell

    • databaseDialog

      protected DatabaseDialog databaseDialog
      A reference to a database dialog

  • Constructor Details

    • JobEntryDialog

      public JobEntryDialog(org.eclipse.swt.widgets.Shell parent, org.pentaho.di.job.entry.JobEntryInterface jobEntry, org.pentaho.di.repository.Repository rep, org.pentaho.di.job.JobMeta jobMeta)
      Instantiates a new job entry dialog.
      Parameters:
      parent - the parent shell
      jobEntry - the job entry interface
      rep - the repository
      jobMeta - the job metadata object

  • Method Details

    • addConnectionLine

      public org.eclipse.swt.custom.CCombo addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, int middle, int margin)
      Adds the connection line for the given parent and previous control, and returns a combo box UI component
      Parameters:
      parent - the parent composite object
      previous - the previous control
      middle - the middle
      margin - the margin
      Returns:
      the combo box UI component

    • addConnectionLine

      public org.eclipse.swt.custom.CCombo addConnectionLine(org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.widgets.Control previous, int middle, int margin, org.eclipse.swt.widgets.Label wlConnection, org.eclipse.swt.widgets.Button wbwConnection, org.eclipse.swt.widgets.Button wbnConnection, org.eclipse.swt.widgets.Button wbeConnection)
      Adds the connection line for the given parent and previous control, and returns a combo box UI component
      Parameters:
      parent - the parent composite object
      previous - the previous control
      middle - the middle
      margin - the margin
      wlConnection - the connection label
      wbnConnection - the "new connection" button
      wbeConnection - the "edit connection" button
      Returns:
      the combo box UI component

    • addDatabases

      public void addDatabases(org.eclipse.swt.custom.CCombo wConnection)
      Adds the databases from the job metadata to the combo box.
      Parameters:
      wConnection - the w connection

    • selectDatabase

      public void selectDatabase(org.eclipse.swt.custom.CCombo wConnection, String name)
      Selects a database from the combo box
      Parameters:
      wConnection - the combo box list of connections
      name - the name

    • getMetaStore

      public org.pentaho.metastore.api.IMetaStore getMetaStore()

    • setMetaStore

      public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)

    • getPathOf

      protected String getPathOf(org.pentaho.di.repository.RepositoryElementMetaInterface object)