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

Class HopDataOrchestrationPerspective

java.lang.Object

org.apache.hop.ui.hopgui.perspective.dataorch.HopDataOrchestrationPerspective

All Implemented Interfaces:

IActionContextHandlersProvider, IHopPerspective, TabClosable

@HopPerspectivePlugin(id="100-HopDataOrchestrationPerspective",
                      name="i18n::DataOrchestrationPerspective.Name",
                      image="ui/images/data_orch.svg",
                      description="i18n::DataOrchestrationPerspective.Description")
@GuiPlugin(description="i18n::DataOrchestrationPerspective.GuiPlugin.Description")
public class HopDataOrchestrationPerspective
extends Object
implements IHopPerspective, TabClosable

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID_PERSPECTIVE_TOOLBAR_ITEM

Constructor Summary

Constructors

Constructor	Description
HopDataOrchestrationPerspective()

Method Summary

Modifier and Type	Method	Description
void	activate()	Switch to this perspective (shown).
IHopFileTypeHandler	addPipeline(HopGui hopGui, PipelineMeta pipelineMeta, HopPipelineFileType pipelineFile)	Add a new pipeline tab to the tab folder...
IHopFileTypeHandler	addWorkflow(HopGui hopGui, WorkflowMeta workflowMeta, HopWorkflowFileType workflowFile)	Add a new workflow tab to the tab folder...
void	closeTab(org.eclipse.swt.custom.CTabFolderEvent event, org.eclipse.swt.custom.CTabItem tabItem)	Close the tab on the perspective
TabItemHandler	findPipeline(String logChannelId)
TabItemHandler	findTabItemHandler(IHopFileTypeHandler handler)
TabItemHandler	findTabItemHandler(org.eclipse.swt.custom.CTabItem tabItem)
TabItemHandler	findTabItemHandlerWithFilename(String filename)
TabItemHandler	findWorkflow(String logChannelId)
IHopFileTypeHandler	getActiveFileTypeHandler()	Get the active file type handler.
TabItemHandler	getActiveItem()	Gets activeItem
List<IGuiContextHandler>	getContextHandlers()	Get the currently active context handlers in the perspective...
org.eclipse.swt.widgets.Control	getControl()
HopGui	getHopGui()	Gets hopGui
String	getId()
List<TabItemHandler>	getItems()	Gets items
HopPipelineFileType<PipelineMeta>	getPipelineFileType()	Gets pipelineFileType
List<ISearchable>	getSearchables()
List<IHopFileType>	getSupportedHopFileTypes()	Get a list of supported file types for this perspective
org.eclipse.swt.custom.CTabFolder	getTabFolder()	Gets tabFolder
HopWorkflowFileType<WorkflowMeta>	getWorkflowFileType()	Gets jobFileType
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	perspectiveActivated()	Notify this perspective that it has been activated.
boolean	remove(IHopFileTypeHandler typeHandler)	Remove the file type handler from this perspective, from the tab folder.
void	setActiveFileTypeHandler(IHopFileTypeHandler activeFileTypeHandler)	Set the focus on the given file type handler.
void	setActiveItem(TabItemHandler activeItem)
void	setHopGui(HopGui hopGui)
void	setItems(List<TabItemHandler> items)
void	setTabFolder(org.eclipse.swt.custom.CTabFolder tabFolder)
void	switchToTab(TabItemHandler tabItemHandler)
void	updateTabLabel(org.eclipse.swt.custom.CTabItem tabItem, String filename, String name)
void	updateTabs()	Update all the tab labels...

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

ID_PERSPECTIVE_TOOLBAR_ITEM

public static final String ID_PERSPECTIVE_TOOLBAR_ITEM

See Also:

Constant Field Values

Constructor Detail

HopDataOrchestrationPerspective

public HopDataOrchestrationPerspective()

Method Detail

getId

public String getId()

Specified by:

getId in interface IHopPerspective

activate

@GuiKeyboardShortcut(control=true,
                     shift=true,
                     key=100)
@GuiOsxKeyboardShortcut(command=true,
                        shift=true,
                        key=100)
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

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

findTabItemHandler

public TabItemHandler findTabItemHandler(org.eclipse.swt.custom.CTabItem tabItem)

findTabItemHandler

public TabItemHandler findTabItemHandler(IHopFileTypeHandler handler)

addPipeline

public IHopFileTypeHandler addPipeline(HopGui hopGui,
                                       PipelineMeta pipelineMeta,
                                       HopPipelineFileType pipelineFile)
                                throws HopException

Add a new pipeline tab to the tab folder...

Parameters:

pipelineMeta -

Returns:

Throws:

HopException

updateTabLabel

public void updateTabLabel(org.eclipse.swt.custom.CTabItem tabItem,
                           String filename,
                           String name)

addWorkflow

public IHopFileTypeHandler addWorkflow(HopGui hopGui,
                                       WorkflowMeta workflowMeta,
                                       HopWorkflowFileType workflowFile)
                                throws HopException

Add a new workflow tab to the tab folder...

Parameters:

workflowMeta -

Returns:

The file type handler

Throws:

HopException

remove

public boolean remove(IHopFileTypeHandler typeHandler)

Remove the file type handler from this perspective, from the tab folder. This simply tries to remove the item, does not

Specified by:

remove in interface IHopPerspective

Parameters:

typeHandler - The file type handler to remove

Returns:

true if the handler was removed from the perspective, false if it wasn't (cancelled, not possible, ...)

getActiveFileTypeHandler

public IHopFileTypeHandler getActiveFileTypeHandler()

Get the active file type handler. If none is active return an empty handler which does do anything.

Specified by:

getActiveFileTypeHandler in interface IHopPerspective

Returns:

the active file type handler or if none is active return an empty handler which does do anything.

setActiveFileTypeHandler

public void setActiveFileTypeHandler(IHopFileTypeHandler activeFileTypeHandler)

Description copied from interface: IHopPerspective

Set the focus on the given file type handler.

Specified by:

setActiveFileTypeHandler in interface IHopPerspective

switchToTab

public void switchToTab(TabItemHandler tabItemHandler)

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

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

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Get the currently active context handlers in the perspective...

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

Returns:

updateTabs

public void updateTabs()

Update all the tab labels...

findTabItemHandlerWithFilename

public TabItemHandler findTabItemHandlerWithFilename(String filename)

getSearchables

public List<ISearchable> getSearchables()

Specified by:

getSearchables in interface IHopPerspective

Returns:

A list of searchable items

findPipeline

public TabItemHandler findPipeline(String logChannelId)

findWorkflow

public TabItemHandler findWorkflow(String logChannelId)

getItems

public List<TabItemHandler> getItems()

Gets items

Specified by:

getItems in interface IHopPerspective

Returns:

value of items

setItems

public void setItems(List<TabItemHandler> items)

Parameters:

items - The items to set

getActiveItem

public TabItemHandler getActiveItem()

Gets activeItem

Returns:

value of activeItem

setActiveItem

public void setActiveItem(TabItemHandler activeItem)

Parameters:

activeItem - The activeItem to set

getHopGui

public HopGui getHopGui()

Gets hopGui

Returns:

value of hopGui

setHopGui

public void setHopGui(HopGui hopGui)

Parameters:

hopGui - The hopGui to set

getControl

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

Specified by:

getControl in interface IHopPerspective

Returns:

The control of this perspective

getTabFolder

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

Gets tabFolder

Specified by:

getTabFolder in interface TabClosable

Returns:

value of tabFolder

setTabFolder

public void setTabFolder(org.eclipse.swt.custom.CTabFolder tabFolder)

Parameters:

tabFolder - The tabFolder to set

getPipelineFileType

public HopPipelineFileType<PipelineMeta> getPipelineFileType()

Gets pipelineFileType

Returns:

value of pipelineFileType

getWorkflowFileType

public HopWorkflowFileType<WorkflowMeta> getWorkflowFileType()

Gets jobFileType

Returns:

value of jobFileType

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