Package org.apache.hop.ui.core.metadata

Class MetadataEditor<T extends IHopMetadata>

java.lang.Object

org.apache.hop.ui.core.metadata.MetadataFileTypeHandler

org.apache.hop.ui.core.metadata.MetadataEditor<T>

All Implemented Interfaces:

IMetadataEditor<T>, IActionContextHandlersProvider, IHopFileTypeHandler

Direct Known Subclasses:

DatabaseMetaEditor, ExecutionDataProfileEditor, ExecutionInfoLocationEditor, HopServerEditor, PartitionSchemaEditor, PipelineRunConfigurationEditor, WebServiceEditor, WorkflowRunConfigurationEditor

public abstract class MetadataEditor<T extends IHopMetadata>
extends MetadataFileTypeHandler
implements IMetadataEditor<T>

Abstract implementation of all metadata editors.

Field Summary

Fields

Modifier and Type	Field	Description
protected HopGui	hopGui
protected org.eclipse.swt.graphics.Image	image
protected boolean	isChanged
protected MetadataManager<T>	manager
protected T	metadata
protected String	originalName
protected String	title
protected org.eclipse.swt.graphics.Image	titleImage
protected String	toolTip

Constructor Summary

Constructors

Constructor	Description
MetadataEditor(HopGui hopGui, MetadataManager<T> manager, T metadata)

Method Summary

Modifier and Type	Method	Description
org.eclipse.swt.widgets.Button[]	createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Button	createHelpButton(org.eclipse.swt.widgets.Shell shell)
void	dispose()
boolean	equals(Object o)
HopGui	getHopGui()
org.eclipse.swt.graphics.Image	getImage()
T	getMetadata()
MetadataManager<T>	getMetadataManager()
org.eclipse.swt.widgets.Shell	getShell()
String	getTitle()	Return the title of the editor
org.eclipse.swt.graphics.Image	getTitleImage()	Returns the title image of this editor
String	getTitleToolTip()	Returns the title tool tip text of this editor
abstract void	getWidgetsContent(T meta)	Inline usage: Reads the information or state of the various widgets and modifies the provided metadata object.
boolean	hasChanged()	See if there anything has been changed by the user
int	hashCode()
boolean	isCloseable()	Perform any task needed to close a file, save it if needed
void	resetChanged()	Clear the changed flag
void	save()	Save the file without asking for a new filename
void	saveAs(String filename)	Save the file after asking for a filename
void	setChanged()	Flag the editor as changed
boolean	setFocus()
protected void	setImage(org.eclipse.swt.graphics.Image image)
void	setMetadata(T metadata)
protected void	setTitle(String title)
protected void	setTitleImage(org.eclipse.swt.graphics.Image image)
protected void	setTitleToolTip(String toolTip)
abstract void	setWidgetsContent()	Inline usage: copy information from the metadata onto the various widgets
void	updateGui()	Update the toolbar, menus and so on.

Methods inherited from class org.apache.hop.ui.core.metadata.MetadataFileTypeHandler

applyStateProperties, close, copySelectedToClipboard, cutSelectedToClipboard, debug, deleteSelected, getContextHandlers, getFilename, getFileType, getName, getStateProperties, getSubject, getVariables, pasteFromClipboard, pause, preview, redo, redraw, resume, selectAll, setFilename, setName, start, stop, undo, unselectAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hop.ui.hopgui.file.IHopFileTypeHandler

markDeleted, reload

Methods inherited from interface org.apache.hop.ui.core.metadata.IMetadataEditor

createControl

Field Detail

hopGui

protected HopGui hopGui

manager

protected MetadataManager<T extends IHopMetadata> manager

metadata

protected T extends IHopMetadata metadata

title

protected String title

toolTip

protected String toolTip

titleImage

protected org.eclipse.swt.graphics.Image titleImage

image

protected org.eclipse.swt.graphics.Image image

isChanged

protected boolean isChanged

originalName

protected String originalName

Constructor Detail

MetadataEditor

public MetadataEditor(HopGui hopGui,
                      MetadataManager<T> manager,
                      T metadata)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createButtonsForButtonBar

public org.eclipse.swt.widgets.Button[] createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)

createHelpButton

protected org.eclipse.swt.widgets.Button createHelpButton(org.eclipse.swt.widgets.Shell shell)

getHopGui

public HopGui getHopGui()

getMetadataManager

public MetadataManager<T> getMetadataManager()

getMetadata

public T getMetadata()

Specified by:

getMetadata in interface IMetadataEditor<T extends IHopMetadata>

setMetadata

public void setMetadata(T metadata)

Specified by:

setMetadata in interface IMetadataEditor<T extends IHopMetadata>

getShell

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

getImage

public org.eclipse.swt.graphics.Image getImage()

setImage

protected void setImage(org.eclipse.swt.graphics.Image image)

getTitle

public String getTitle()

Description copied from interface: IMetadataEditor

Return the title of the editor

Specified by:

getTitle in interface IMetadataEditor<T extends IHopMetadata>

Returns:

The title of this editor

setTitle

protected void setTitle(String title)

getTitleImage

public org.eclipse.swt.graphics.Image getTitleImage()

Description copied from interface: IMetadataEditor

Returns the title image of this editor

Specified by:

getTitleImage in interface IMetadataEditor<T extends IHopMetadata>

Returns:

setTitleImage

protected void setTitleImage(org.eclipse.swt.graphics.Image image)

getTitleToolTip

public String getTitleToolTip()

Description copied from interface: IMetadataEditor

Returns the title tool tip text of this editor

Specified by:

getTitleToolTip in interface IMetadataEditor<T extends IHopMetadata>

Returns:

setTitleToolTip

protected void setTitleToolTip(String toolTip)

hasChanged

public boolean hasChanged()

Description copied from interface: IHopFileTypeHandler

See if there anything has been changed by the user

Specified by:

hasChanged in interface IHopFileTypeHandler

Specified by:

hasChanged in interface IMetadataEditor<T extends IHopMetadata>

Overrides:

hasChanged in class MetadataFileTypeHandler

Returns:

true if there were changes worth saving, false if nothing has been changed.

resetChanged

public void resetChanged()

Description copied from interface: IMetadataEditor

Clear the changed flag

Specified by:

resetChanged in interface IMetadataEditor<T extends IHopMetadata>

setChanged

public void setChanged()

Description copied from interface: IMetadataEditor

Flag the editor as changed

Specified by:

setChanged in interface IMetadataEditor<T extends IHopMetadata>

setWidgetsContent

public abstract void setWidgetsContent()

Inline usage: copy information from the metadata onto the various widgets

getWidgetsContent

public abstract void getWidgetsContent(T meta)

Inline usage: Reads the information or state of the various widgets and modifies the provided metadata object.

Parameters:

meta - The metadata object to populate from the widgets

isCloseable

public boolean isCloseable()

Description copied from interface: IHopFileTypeHandler

Perform any task needed to close a file, save it if needed

Specified by:

isCloseable in interface IHopFileTypeHandler

Overrides:

isCloseable in class MetadataFileTypeHandler

Returns:

true if the file is ready to close. Return false if there was a problem saving or any other issue.

save

public void save()
          throws HopException

Description copied from interface: IHopFileTypeHandler

Save the file without asking for a new filename

Specified by:

save in interface IHopFileTypeHandler

Specified by:

save in interface IMetadataEditor<T extends IHopMetadata>

Overrides:

save in class MetadataFileTypeHandler

Throws:

HopException

saveAs

public void saveAs(String filename)
            throws HopException

Description copied from interface: IHopFileTypeHandler

Save the file after asking for a filename

Specified by:

saveAs in interface IHopFileTypeHandler

Specified by:

saveAs in interface IMetadataEditor<T extends IHopMetadata>

Overrides:

saveAs in class MetadataFileTypeHandler

Throws:

HopException

setFocus

public boolean setFocus()

Specified by:

setFocus in interface IMetadataEditor<T extends IHopMetadata>

dispose

public void dispose()

Specified by:

dispose in interface IMetadataEditor<T extends IHopMetadata>

updateGui

public void updateGui()

Description copied from interface: IHopFileTypeHandler

Update the toolbar, menus and so on. This is needed after a file, context or capabilities changes

Specified by:

updateGui in interface IHopFileTypeHandler

Overrides:

updateGui in class MetadataFileTypeHandler