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

Class MetadataPerspective

java.lang.Object

org.apache.hop.ui.hopgui.perspective.metadata.MetadataPerspective

All Implemented Interfaces:

IActionContextHandlersProvider, IHopPerspective, TabClosable

@HopPerspectivePlugin(id="200-HopMetadataPerspective",
                      name="i18n::MetadataPerspective.Name",
                      description="i18n::MetadataPerspective.Description",
                      image="ui/images/metadata.svg")
@GuiPlugin(description="i18n::MetadataPerspective.GuiPlugin.Description")
public class MetadataPerspective
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_NEW
static String	TOOLBAR_ITEM_REFRESH

Constructor Summary

Constructors

Constructor	Description
MetadataPerspective()

Method Summary

Modifier and Type	Method	Description
void	activate()	Switch to this perspective (shown).
void	addEditor(MetadataEditor<?> editor)
void	closeTab(org.eclipse.swt.custom.CTabFolderEvent event, org.eclipse.swt.custom.CTabItem tabItem)	Close the tab on the perspective
protected void	createTabFolder(org.eclipse.swt.widgets.Composite parent)
protected void	createTree(org.eclipse.swt.widgets.Composite parent)
void	duplicateMetadata()
MetadataEditor<?>	findEditor(String objectKey, String name)	Find a metadata editor
MetadataEditor<?>	getActiveEditor()
IHopFileTypeHandler	getActiveFileTypeHandler()	Get the active file type handler capable of saving, executing, printing, ...
List<IGuiContextHandler>	getContextHandlers()
org.eclipse.swt.widgets.Control	getControl()
String	getId()
static MetadataPerspective	getInstance()
List<TabItemHandler>	getItems()	Get the list of tabs handled by and currently open in the perspective
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
void	goToElement(Class<? extends IHopMetadata> managedClass, String elementName)
void	goToType(Class<? extends IHopMetadata> managedClass)
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	onDeleteMetadata()
void	onEditMetadata()
void	onNewMetadata()
void	onRenameMetadata()
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	setActiveEditor(MetadataEditor<?> editor)
void	setActiveFileTypeHandler(IHopFileTypeHandler fileTypeHandler)	Set the focus on the given file type handler.
void	updateEditor(MetadataEditor<?> editor)
void	updateGui()	Update HopGui menu and toolbar...
protected void	updateSelection()

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_NEW

public static final String TOOLBAR_ITEM_NEW

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

MetadataPerspective

public MetadataPerspective()

Method Detail

getInstance

public static MetadataPerspective getInstance()

getId

public String getId()

Specified by:

getId in interface IHopPerspective

activate

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

addEditor

public void addEditor(MetadataEditor<?> editor)

findEditor

public MetadataEditor<?> findEditor(String objectKey,
                                    String name)

Find a metadata editor

Parameters:

objectKey - the metadata annotation key

name - the name of the metadata

Returns:

the metadata editor or null if not found

setActiveEditor

public void setActiveEditor(MetadataEditor<?> editor)

getActiveEditor

public MetadataEditor<?> getActiveEditor()

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)

onNewMetadata

@GuiToolbarElement(root="MetadataPerspective-Toolbar",
                   id="MetadataPerspective-Toolbar-10000-New",
                   toolTip="i18n::MetadataPerspective.ToolbarElement.New.Tooltip",
                   image="ui/images/new.svg")
public void onNewMetadata()

onEditMetadata

public void onEditMetadata()

onRenameMetadata

@GuiToolbarElement(root="MetadataPerspective-Toolbar",
                   id="MetadataPerspective-Toolbar-10010-Edit",
                   toolTip="i18n::MetadataPerspective.ToolbarElement.Edit.Tooltip",
                   image="ui/images/edit.svg")
public void onRenameMetadata()

onDeleteMetadata

@GuiToolbarElement(root="MetadataPerspective-Toolbar",
                   id="MetadataPerspective-Toolbar-10040-Delete",
                   toolTip="i18n::MetadataPerspective.ToolbarElement.Delete.Tooltip",
                   image="ui/images/delete.svg")
public void onDeleteMetadata()

duplicateMetadata

@GuiToolbarElement(root="MetadataPerspective-Toolbar",
                   id="MetadataPerspective-Toolbar-10030-Duplicate",
                   toolTip="i18n::MetadataPerspective.ToolbarElement.CreateCopy.Tooltip",
                   image="ui/images/duplicate.svg")
public void duplicateMetadata()

updateEditor

public void updateEditor(MetadataEditor<?> editor)

updateGui

public void updateGui()

Update HopGui menu and toolbar...

refresh

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

updateSelection

protected void updateSelection()

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:

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

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

goToType

public void goToType(Class<? extends IHopMetadata> managedClass)

goToElement

public void goToElement(Class<? extends IHopMetadata> managedClass,
                        String elementName)