Package org.apache.hop.ui.hopgui.perspective.execution

Class ExecutionPerspective

java.lang.Object

org.apache.hop.ui.hopgui.perspective.execution.ExecutionPerspective

All Implemented Interfaces:

IActionContextHandlersProvider, IHopPerspective, TabClosable

@HopPerspectivePlugin(id="150-HopExecutionPerspective",
                      name="i18n::ExecutionPerspective.Name",
                      description="i18n::ExecutionPerspective.Description",
                      image="ui/images/location.svg")
@GuiPlugin
public class ExecutionPerspective
extends Object
implements IHopPerspective, TabClosable

Field Summary

Fields

Modifier and Type	Field	Description
static String	GUI_PLUGIN_TOOLBAR_PARENT_ID
static String	KEY_HELP
static Class<?>	PKG
static String	TOOLBAR_ITEM_DELETE
static String	TOOLBAR_ITEM_DUPLICATE
static String	TOOLBAR_ITEM_EDIT
static String	TOOLBAR_ITEM_REFRESH

Constructor Summary

Constructors

Constructor	Description
ExecutionPerspective()

Method Summary

Modifier and Type	Method	Description
void	activate()	Switch to this perspective (shown).
void	addViewer(IExecutionViewer viewer)
void	closeTab(org.eclipse.swt.custom.CTabFolderEvent event, org.eclipse.swt.custom.CTabItem tabItem)	Close the tab on the perspective
void	createExecutionViewer(String locationName, Execution execution, ExecutionState executionState)
void	createLastExecutionView(String locationName, ExecutionType executionType, String name)	Simply search the tree items to look for the first matching pipeline execution
protected void	createTabFolder(org.eclipse.swt.widgets.Composite parent)
protected void	createTree(org.eclipse.swt.widgets.Composite parent)
void	delete()
IExecutionViewer	findViewer(String logChannelId, String name)	Find a metadata editor
IHopFileTypeHandler	getActiveFileTypeHandler()	Get the active file type handler capable of saving, executing, printing, ...
IExecutionViewer	getActiveViewer()
List<IGuiContextHandler>	getContextHandlers()
org.eclipse.swt.widgets.Control	getControl()
String	getId()
static ExecutionPerspective	getInstance()
List<TabItemHandler>	getItems()	Get the list of tabs handled by and currently open in the perspective
Map<String,ExecutionInfoLocation>	getLocationMap()	Gets locationMap
protected MetadataManager<IHopMetadata>	getMetadataManager(String objectKey)
List<ISearchable>	getSearchables()
protected org.eclipse.swt.widgets.Shell	getShell()
List<IHopFileType>	getSupportedHopFileTypes()	Get a list of supported file types for this perspective
org.eclipse.swt.custom.CTabFolder	getTabFolder()	Get the tabFolder of the perspective
boolean	hasNavigationNextFile()
boolean	hasNavigationPreviousFile()
void	initialize(HopGui hopGui, org.eclipse.swt.widgets.Composite parent)	Initialize this perspective
boolean	isActive()	See if this perspective is active (shown)
void	navigateToNextFile()	Navigate the file usage history to the next file
void	navigateToPreviousFile()	Navigate the file usage history to the previous file
void	onNewViewer()
protected void	onTabClose(org.eclipse.swt.custom.CTabFolderEvent event)
void	perspectiveActivated()	Notify this perspective that it has been activated.
void	refresh()
boolean	remove(IHopFileTypeHandler typeHandler)	Remove this file type handler from the perspective
void	setActiveFileTypeHandler(IHopFileTypeHandler fileTypeHandler)	Set the focus on the given file type handler.
void	setActiveViewer(IExecutionViewer viewer)
void	updateGui()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hop.ui.hopgui.perspective.TabClosable

getOtherTabs, getTabsToLeft, getTabsToRight

Field Detail

PKG

public static final Class<?> PKG

GUI_PLUGIN_TOOLBAR_PARENT_ID

public static final String GUI_PLUGIN_TOOLBAR_PARENT_ID

See Also:

Constant Field Values

TOOLBAR_ITEM_EDIT

public static final String TOOLBAR_ITEM_EDIT

See Also:

Constant Field Values

TOOLBAR_ITEM_DUPLICATE

public static final String TOOLBAR_ITEM_DUPLICATE

See Also:

Constant Field Values

TOOLBAR_ITEM_DELETE

public static final String TOOLBAR_ITEM_DELETE

See Also:

Constant Field Values

TOOLBAR_ITEM_REFRESH

public static final String TOOLBAR_ITEM_REFRESH

See Also:

Constant Field Values

KEY_HELP

public static final String KEY_HELP

See Also:

Constant Field Values

Constructor Detail

ExecutionPerspective

public ExecutionPerspective()

Method Detail

getInstance

public static ExecutionPerspective getInstance()

getId

public String getId()

Specified by:

getId in interface IHopPerspective

activate

@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=105)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=105)
public void activate()

Description copied from interface: IHopPerspective

Switch to this perspective (shown).

Specified by:

activate in interface IHopPerspective

perspectiveActivated

public void perspectiveActivated()

Description copied from interface: IHopPerspective

Notify this perspective that it has been activated.

Specified by:

perspectiveActivated in interface IHopPerspective

isActive

public boolean isActive()

Description copied from interface: IHopPerspective

See if this perspective is active (shown)

Specified by:

isActive in interface IHopPerspective

Returns:

True if the perspective is currently shown

getSupportedHopFileTypes

public List<IHopFileType> getSupportedHopFileTypes()

Description copied from interface: IHopPerspective

Get a list of supported file types for this perspective

Specified by:

getSupportedHopFileTypes in interface IHopPerspective

Returns:

The list of supported file types

initialize

public void initialize(HopGui hopGui,
                       org.eclipse.swt.widgets.Composite parent)

Description copied from interface: IHopPerspective

Initialize this perspective

Specified by:

initialize in interface IHopPerspective

Parameters:

hopGui - The parent Hop GUI

getMetadataManager

protected MetadataManager<IHopMetadata> getMetadataManager(String objectKey)
                                                    throws HopException

Throws:

HopException

createTree

protected void createTree(org.eclipse.swt.widgets.Composite parent)

createTabFolder

protected void createTabFolder(org.eclipse.swt.widgets.Composite parent)

addViewer

public void addViewer(IExecutionViewer viewer)

findViewer

public IExecutionViewer findViewer(String logChannelId,
                                   String name)

Find a metadata editor

Parameters:

logChannelId - the ID of the execution (log channel)

name - the name of the workflow or pipeline which is executing

Returns:

the metadata editor or null if not found

setActiveViewer

public void setActiveViewer(IExecutionViewer viewer)

getActiveViewer

public IExecutionViewer getActiveViewer()

getActiveFileTypeHandler

public IHopFileTypeHandler getActiveFileTypeHandler()

Description copied from interface: IHopPerspective

Get the active file type handler capable of saving, executing, printing, ... a file

Specified by:

getActiveFileTypeHandler in interface IHopPerspective

Returns:

The active file type handler

setActiveFileTypeHandler

public void setActiveFileTypeHandler(IHopFileTypeHandler fileTypeHandler)

Description copied from interface: IHopPerspective

Set the focus on the given file type handler.

Specified by:

setActiveFileTypeHandler in interface IHopPerspective

onTabClose

protected void onTabClose(org.eclipse.swt.custom.CTabFolderEvent event)

onNewViewer

public void onNewViewer()

createExecutionViewer

public void createExecutionViewer(String locationName,
                                  Execution execution,
                                  ExecutionState executionState)
                           throws Exception

Throws:

Exception

createLastExecutionView

public void createLastExecutionView(String locationName,
                                    ExecutionType executionType,
                                    String name)
                             throws Exception

Simply search the tree items to look for the first matching pipeline execution

Parameters:

locationName - the exec info location to use

executionType - The type of execution to look for

name - The name of the pipeline

Throws:

Exception

updateGui

public void updateGui()

refresh

@GuiToolbarElement(root="ExecutionPerspective-Toolbar",
                   id="ExecutionPerspective-Toolbar-10100-Refresh",
                   toolTip="i18n::ExecutionPerspective.ToolbarElement.Refresh.Tooltip",
                   image="ui/images/refresh.svg")
@GuiKeyboardShortcut(key=16777230)
@GuiOsxKeyboardShortcut(key=16777230)
public void refresh()

remove

public boolean remove(IHopFileTypeHandler typeHandler)

Description copied from interface: IHopPerspective

Remove this file type handler from the perspective

Specified by:

remove in interface IHopPerspective

Parameters:

typeHandler - The file type handler to remove

Returns:

delete

@GuiToolbarElement(root="ExecutionPerspective-Toolbar",
                   id="ExecutionPerspective-Toolbar-10040-Delete",
                   toolTip="i18n::ExecutionPerspective.ToolbarElement.Delete.Tooltip",
                   image="ui/images/delete.svg",
                   separator=true)
@GuiKeyboardShortcut(key=127)
@GuiOsxKeyboardShortcut(key=127)
public void delete()

getItems

public List<TabItemHandler> getItems()

Description copied from interface: IHopPerspective

Get the list of tabs handled by and currently open in the perspective

Specified by:

getItems in interface IHopPerspective

Returns:

The list of tab items

navigateToPreviousFile

public void navigateToPreviousFile()

Description copied from interface: IHopPerspective

Navigate the file usage history to the previous file

Specified by:

navigateToPreviousFile in interface IHopPerspective

navigateToNextFile

public void navigateToNextFile()

Description copied from interface: IHopPerspective

Navigate the file usage history to the next file

Specified by:

navigateToNextFile in interface IHopPerspective

hasNavigationPreviousFile

public boolean hasNavigationPreviousFile()

Specified by:

hasNavigationPreviousFile in interface IHopPerspective

hasNavigationNextFile

public boolean hasNavigationNextFile()

Specified by:

hasNavigationNextFile in interface IHopPerspective

getControl

public org.eclipse.swt.widgets.Control getControl()

Specified by:

getControl in interface IHopPerspective

Returns:

The control of this perspective

getShell

protected org.eclipse.swt.widgets.Shell getShell()

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

getSearchables

public List<ISearchable> getSearchables()

Specified by:

getSearchables in interface IHopPerspective

Returns:

A list of searchable items

getLocationMap

public Map<String,ExecutionInfoLocation> getLocationMap()

Gets locationMap

Returns:

value of locationMap

closeTab

public void closeTab(org.eclipse.swt.custom.CTabFolderEvent event,
                     org.eclipse.swt.custom.CTabItem tabItem)

Description copied from interface: TabClosable

Close the tab on the perspective

Specified by:

closeTab in interface TabClosable

getTabFolder

public org.eclipse.swt.custom.CTabFolder getTabFolder()

Description copied from interface: TabClosable

Get the tabFolder of the perspective

Specified by:

getTabFolder in interface TabClosable