|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object Dialog org.pentaho.di.ui.trans.step.BaseStepDialog
public class BaseStepDialog
This class provides functionality common to Step Dialogs.
Field Summary | |
---|---|
static LoggingObjectInterface |
loggingObject
The logging object interface for this dialog. |
Constructor Summary | |
---|---|
BaseStepDialog(Shell parent,
BaseStepMeta baseStepMeta,
TransMeta transMeta,
String stepname)
Instantiates a new base step dialog. |
|
BaseStepDialog(Shell parent,
int nr,
BaseStepMeta in,
TransMeta tr)
Instantiates a new base step dialog. |
Method Summary | |
---|---|
CCombo |
addConnectionLine(Composite parent,
Control previous,
int middle,
int margin)
Adds the connection line. |
CCombo |
addConnectionLine(Composite parent,
Control previous,
int middle,
int margin,
Class<? extends DatabaseInterface> databaseType)
Adds the connection line. |
CCombo |
addConnectionLine(Composite parent,
Control previous,
int middle,
int margin,
Label wlConnection,
Button wbnConnection,
Button wbeConnection)
Adds the connection line. |
CCombo |
addConnectionLine(Composite parent,
Control previous,
int middle,
int margin,
Label wlConnection,
Button wbnConnection,
Button wbeConnection,
Class<? extends DatabaseInterface> databaseType)
Adds the connection line. |
void |
addDatabases(CCombo wConnection)
Adds the databases to the Combo Box component. |
void |
addDatabases(CCombo wConnection,
Class<? extends DatabaseInterface> databaseType)
Adds the databases with the specified type to the Combo Box component. |
void |
dispose()
Dispose this dialog. |
static void |
generateFieldMapping(Shell shell,
RowMetaInterface sourceFields,
RowMetaInterface targetFields,
List<SourceToTargetMapping> fieldMapping)
Create a new field mapping between source and target steps. |
static void |
getFieldsFromPrevious(ComboVar comboVar,
TransMeta transMeta,
StepMeta stepMeta)
Gets fields from previous steps and populate a ComboVar. |
static void |
getFieldsFromPrevious(RowMetaInterface row,
TableView tableView,
int keyColumn,
int[] nameColumn,
int[] dataTypeColumn,
int lengthColumn,
int precisionColumn,
TableItemInsertListener listener)
Gets unused fields from previous steps and inserts them as rows into a table view. |
static void |
getFieldsFromPrevious(TransMeta transMeta,
StepMeta stepMeta,
TableView tableView,
int keyColumn,
int[] nameColumn,
int[] dataTypeColumn,
int lengthColumn,
int precisionColumn,
TableItemInsertListener listener)
Gets unused fields from previous steps and inserts them as rows into a table view. |
static ModifyListener |
getModifyListenerTooltipText(Text textField)
Gets the modify listener tooltip text. |
Repository |
getRepository()
Gets the repository associated with this dialog. |
boolean |
isBasic()
Checks if the log level is basic. |
boolean |
isDebug()
Checks if the log level is debug. |
boolean |
isDetailed()
Checks if the log level is detailed. |
boolean |
isRowLevel()
Checks if the log level is row level. |
void |
logBasic(String message)
Log the message at a basic logging level. |
void |
logBasic(String message,
Object... arguments)
Log the message with arguments at a basic logging level. |
void |
logDebug(String message)
Log the message at a debug logging level. |
void |
logDebug(String message,
Object... arguments)
Log the message with arguments at a debug logging level. |
void |
logDetailed(String message)
Log the message at a detailed logging level. |
void |
logDetailed(String message,
Object... arguments)
Log the message with arguments at a detailed logging level. |
void |
logError(String message)
Log the message at a error logging level. |
void |
logError(String message,
Object... arguments)
Log the message with arguments at a error logging level. |
void |
logError(String message,
Throwable e)
Log the message with the associated Throwable object at a error logging level. |
void |
logMinimal(String message)
Log the message at a minimal logging level. |
void |
logMinimal(String message,
Object... arguments)
Log the message with arguments at a minimal logging level. |
void |
logRowlevel(String message)
Log the message at a rowlevel logging level. |
void |
logRowlevel(String message,
Object... arguments)
Log the message with arguments at a rowlevel logging level. |
static void |
positionBottomButtons(Composite composite,
Button[] buttons,
int margin,
Control lastControl)
Position the specified buttons at the bottom of the parent composite. |
void |
selectDatabase(CCombo wConnection,
String name)
Selects the database with the specified name in the Combo Box component. |
static void |
setMinimalShellHeight(Shell shell,
Control[] controls,
int margin,
int extra)
Sets the minimal shell height. |
void |
setRepository(Repository repository)
Sets the repository associated with this dialog. |
void |
setShellImage(Shell shell,
StepMetaInterface stepMetaInterface)
Sets the shell image. |
void |
setSize()
Set the shell size, based upon the previous time the geometry was saved in the Properties file. |
static void |
setSize(Shell shell)
Sets the size of this dialog with respect to the given shell. |
static void |
setSize(Shell shell,
int minWidth,
int minHeight,
boolean packIt)
Sets the size of this dialog with respect to the given parameters. |
static void |
setTraverseOrder(Control[] controls)
Sets the traverse order for the given controls. |
void |
storeScreenSize()
Store screen size. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final LoggingObjectInterface loggingObject
Constructor Detail |
---|
public BaseStepDialog(Shell parent, BaseStepMeta baseStepMeta, TransMeta transMeta, String stepname)
parent
- the parent shellbaseStepMeta
- the associated base step metadatatransMeta
- the associated transformation metadatastepname
- the step namepublic BaseStepDialog(Shell parent, int nr, BaseStepMeta in, TransMeta tr)
parent
- the parent shellnr
- the number of rowsin
- the base step metadatatr
- the transformation metadataMethod Detail |
---|
public void setShellImage(Shell shell, StepMetaInterface stepMetaInterface)
shell
- the shellstepMetaInterface
- the step meta interfacepublic void dispose()
public void setSize()
public static final void positionBottomButtons(Composite composite, Button[] buttons, int margin, Control lastControl)
The default alignment for buttons in the system will be used. This is set as an LAF
property with the key Button_Position
and has the valid values
of left, center, right
with center
being the default.
composite
- the compositebuttons
- The buttons to position.margin
- The margin between the buttons in pixelslastControl
- the last controlpublic static final ModifyListener getModifyListenerTooltipText(Text textField)
textField
- the text field
public void addDatabases(CCombo wConnection)
wConnection
- the Combo Box componentpublic void addDatabases(CCombo wConnection, Class<? extends DatabaseInterface> databaseType)
wConnection
- the Combo Box componentdatabaseType
- the database typepublic void selectDatabase(CCombo wConnection, String name)
wConnection
- the Combo Box componentname
- the name of the database to selectpublic CCombo addConnectionLine(Composite parent, Control previous, int middle, int margin)
parent
- the parent UI componentprevious
- the previous UI componentmiddle
- the middlemargin
- the margin
public CCombo addConnectionLine(Composite parent, Control previous, int middle, int margin, Class<? extends DatabaseInterface> databaseType)
parent
- the parent UI componentprevious
- the previous UI componentmiddle
- the middlemargin
- the margindatabaseType
- the database type
public CCombo addConnectionLine(Composite parent, Control previous, int middle, int margin, Label wlConnection, Button wbnConnection, Button wbeConnection)
parent
- the parent UI componentprevious
- the previous UI componentmiddle
- the middlemargin
- the marginwlConnection
- the connection labelwbnConnection
- the "new connection" buttonwbeConnection
- the "edit connection" button
public CCombo addConnectionLine(Composite parent, Control previous, int middle, int margin, Label wlConnection, Button wbnConnection, Button wbeConnection, Class<? extends DatabaseInterface> databaseType)
parent
- the parent UI componentprevious
- the previous UI componentmiddle
- the middlemargin
- the marginwlConnection
- the connection labelwbnConnection
- the "new connection" buttonwbeConnection
- the "edit connection" buttondatabaseType
- the database type
public void storeScreenSize()
public Repository getRepository()
public void setRepository(Repository repository)
repository
- The repository to set.public static void setMinimalShellHeight(Shell shell, Control[] controls, int margin, int extra)
shell
- the shellcontrols
- the controls to measuremargin
- the margin between the componentsextra
- the extra paddingpublic static void setSize(Shell shell)
shell
- the new sizepublic static void setSize(Shell shell, int minWidth, int minHeight, boolean packIt)
shell
- the shellminWidth
- the minimum widthminHeight
- the minimum heightpackIt
- true to pack the dialog components, false otherwisepublic static final void setTraverseOrder(Control[] controls)
controls
- the new traverse orderpublic static final void getFieldsFromPrevious(TransMeta transMeta, StepMeta stepMeta, TableView tableView, int keyColumn, int[] nameColumn, int[] dataTypeColumn, int lengthColumn, int precisionColumn, TableItemInsertListener listener)
transMeta
- the transformation metadatastepMeta
- the step metadatatableView
- the table viewkeyColumn
- the key columnnameColumn
- the name columndataTypeColumn
- the data type columnlengthColumn
- the length columnprecisionColumn
- the precision columnlistener
- a listener for tables insert eventspublic static final void getFieldsFromPrevious(RowMetaInterface row, TableView tableView, int keyColumn, int[] nameColumn, int[] dataTypeColumn, int lengthColumn, int precisionColumn, TableItemInsertListener listener)
row
- the input fieldstableView
- the table view to modifykeyColumn
- the column in the table view to match with the names of the fields, checks for existance if >0nameColumn
- the column numbers in which the name should end up indataTypeColumn
- the target column numbers in which the data type should end up inlengthColumn
- the length column where the length should end up in (if >0)precisionColumn
- the length column where the precision should end up in (if >0)listener
- A listener that you can use to do custom modifications to the inserted table item, based on a value from the provided rowpublic static final void getFieldsFromPrevious(ComboVar comboVar, TransMeta transMeta, StepMeta stepMeta)
comboVar
- the Combo Box (with Variables) to populatetransMeta
- the transformation metadatastepMeta
- the step metadatapublic static final void generateFieldMapping(Shell shell, RowMetaInterface sourceFields, RowMetaInterface targetFields, List<SourceToTargetMapping> fieldMapping) throws KettleException
shell
- the shell of the parent windowsourceFields
- the source fieldstargetFields
- the target fieldsfieldMapping
- the list of source to target mappings to default to (can be empty but not null)
KettleException
- in case something goes wrong during the field mappingpublic boolean isBasic()
public boolean isDetailed()
public boolean isDebug()
public boolean isRowLevel()
public void logMinimal(String message)
message
- the message to logpublic void logMinimal(String message, Object... arguments)
message
- the messagearguments
- the argumentspublic void logBasic(String message)
message
- the messagepublic void logBasic(String message, Object... arguments)
message
- the messagearguments
- the argumentspublic void logDetailed(String message)
message
- the messagepublic void logDetailed(String message, Object... arguments)
message
- the messagearguments
- the argumentspublic void logDebug(String message)
message
- the messagepublic void logDebug(String message, Object... arguments)
message
- the messagearguments
- the argumentspublic void logRowlevel(String message)
message
- the messagepublic void logRowlevel(String message, Object... arguments)
message
- the messagearguments
- the argumentspublic void logError(String message)
message
- the messagepublic void logError(String message, Throwable e)
message
- the messagee
- the epublic void logError(String message, Object... arguments)
message
- the messagearguments
- the arguments
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |