Package org.apache.hop.ui.hopgui.perspective.explorer.file.types.base

Class BaseExplorerFileTypeHandler

java.lang.Object

org.apache.hop.ui.hopgui.perspective.explorer.file.types.base.BaseExplorerFileTypeHandler

All Implemented Interfaces:

IActionContextHandlersProvider, IHopFileTypeHandler

Direct Known Subclasses:

BaseTextExplorerFileTypeHandler, SvgExplorerFileTypeHandler

public abstract class BaseExplorerFileTypeHandler
extends Object
implements IHopFileTypeHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected ExplorerFile	explorerFile
protected HopGui	hopGui
protected ExplorerPerspective	perspective

Constructor Summary

Constructors

Constructor	Description
BaseExplorerFileTypeHandler(HopGui hopGui, ExplorerPerspective perspective, ExplorerFile explorerFile)

Method Summary

Modifier and Type	Method	Description
void	applyStateProperties(Map<String,Object> stateProperties)
void	close()	Actually close the file, remove it from the user interface.
void	copySelectedToClipboard()	Copy the selected items to the clipboard
void	cutSelectedToClipboard()	Cut the selected items to the clipboard
void	debug()	Debug the file
void	deleteSelected()	Delete the selected items
List<IGuiContextHandler>	getContextHandlers()
ExplorerFile	getExplorerFile()	Gets explorerFile
String	getFilename()
IHopFileType	getFileType()	Get a hold of the file type details
HopGui	getHopGui()	Gets hopGui
String	getName()	Get the user friendly name of the file being handled
ExplorerPerspective	getPerspective()	Gets perspective
Map<String,Object>	getStateProperties()	Describe the state properties of the file being handled: zoomLevel, scrollX, scrollY, active, ...
Object	getSubject()	What is this handling? (pipeline, workflow, ...)
IVariables	getVariables()	The variables associated with the file.
boolean	hasChanged()	See if there anything has been changed by the user
boolean	isCloseable()	Perform any task needed to close a file, save it if needed
void	pasteFromClipboard()	Paste items from the clipboard
void	pause()	Pause execution
void	preview()	Preview this file
protected String	readTextFileContent(String encoding)
void	redo()	Redo a change to the file
void	redraw()	Refresh the graphical file representation after model changes
void	resume()	Resume execution
void	save()	Save the file without asking for a new filename
void	saveAs(String filename)	Save the file after asking for a filename
void	selectAll()	Select all items in the current files
void	setExplorerFile(ExplorerFile explorerFile)
void	setFilename(String filename)	Change the filename of the hop file
void	setHopGui(HopGui hopGui)
void	setName(String name)	Set the user friendly name of the underlying file
void	setPerspective(ExplorerPerspective perspective)
void	start()	Start execution
void	stop()	Stop execution
void	undo()	Undo a change to the file
void	unselectAll()	Unselect all items in the current file
void	updateGui()	Update the toolbar, menus and so on.

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.file.IHopFileTypeHandler

markDeleted, reload

Field Detail

hopGui

protected HopGui hopGui

perspective

protected ExplorerPerspective perspective

explorerFile

protected ExplorerFile explorerFile

Constructor Detail

BaseExplorerFileTypeHandler

public BaseExplorerFileTypeHandler(HopGui hopGui,
                                   ExplorerPerspective perspective,
                                   ExplorerFile explorerFile)

Method Detail

readTextFileContent

protected String readTextFileContent(String encoding)
                              throws HopException

Throws:

HopException

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Specified by:

getContextHandlers in interface IActionContextHandlersProvider

getSubject

public Object getSubject()

Description copied from interface: IHopFileTypeHandler

What is this handling? (pipeline, workflow, ...)

Specified by:

getSubject in interface IHopFileTypeHandler

Returns:

The subject being handled

getName

public String getName()

Description copied from interface: IHopFileTypeHandler

Get the user friendly name of the file being handled

Specified by:

getName in interface IHopFileTypeHandler

Returns:

The user friendly name

setName

public void setName(String name)

Description copied from interface: IHopFileTypeHandler

Set the user friendly name of the underlying file

Specified by:

setName in interface IHopFileTypeHandler

Parameters:

name - The user friendly name

getFileType

public IHopFileType getFileType()

Description copied from interface: IHopFileTypeHandler

Get a hold of the file type details

Specified by:

getFileType in interface IHopFileTypeHandler

Returns:

getFilename

public String getFilename()

Specified by:

getFilename in interface IHopFileTypeHandler

Returns:

The filename of the hop file

setFilename

public void setFilename(String filename)

Description copied from interface: IHopFileTypeHandler

Change the filename of the hop file

Specified by:

setFilename in interface IHopFileTypeHandler

Parameters:

filename - The new filename

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

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

Throws:

HopException

start

public void start()

Description copied from interface: IHopFileTypeHandler

Start execution

Specified by:

start in interface IHopFileTypeHandler

stop

public void stop()

Description copied from interface: IHopFileTypeHandler

Stop execution

Specified by:

stop in interface IHopFileTypeHandler

pause

public void pause()

Description copied from interface: IHopFileTypeHandler

Pause execution

Specified by:

pause in interface IHopFileTypeHandler

resume

public void resume()

Description copied from interface: IHopFileTypeHandler

Resume execution

Specified by:

resume in interface IHopFileTypeHandler

preview

public void preview()

Description copied from interface: IHopFileTypeHandler

Preview this file

Specified by:

preview in interface IHopFileTypeHandler

debug

public void debug()

Description copied from interface: IHopFileTypeHandler

Debug the file

Specified by:

debug in interface IHopFileTypeHandler

redraw

public void redraw()

Description copied from interface: IHopFileTypeHandler

Refresh the graphical file representation after model changes

Specified by:

redraw in interface IHopFileTypeHandler

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

selectAll

public void selectAll()

Description copied from interface: IHopFileTypeHandler

Select all items in the current files

Specified by:

selectAll in interface IHopFileTypeHandler

unselectAll

public void unselectAll()

Description copied from interface: IHopFileTypeHandler

Unselect all items in the current file

Specified by:

unselectAll in interface IHopFileTypeHandler

copySelectedToClipboard

public void copySelectedToClipboard()

Description copied from interface: IHopFileTypeHandler

Copy the selected items to the clipboard

Specified by:

copySelectedToClipboard in interface IHopFileTypeHandler

cutSelectedToClipboard

public void cutSelectedToClipboard()

Description copied from interface: IHopFileTypeHandler

Cut the selected items to the clipboard

Specified by:

cutSelectedToClipboard in interface IHopFileTypeHandler

deleteSelected

public void deleteSelected()

Description copied from interface: IHopFileTypeHandler

Delete the selected items

Specified by:

deleteSelected in interface IHopFileTypeHandler

pasteFromClipboard

public void pasteFromClipboard()

Description copied from interface: IHopFileTypeHandler

Paste items from the clipboard

Specified by:

pasteFromClipboard in interface IHopFileTypeHandler

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

Returns:

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

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

Returns:

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

undo

public void undo()

Description copied from interface: IHopFileTypeHandler

Undo a change to the file

Specified by:

undo in interface IHopFileTypeHandler

redo

public void redo()

Description copied from interface: IHopFileTypeHandler

Redo a change to the file

Specified by:

redo in interface IHopFileTypeHandler

getStateProperties

public Map<String,Object> getStateProperties()

Description copied from interface: IHopFileTypeHandler

Describe the state properties of the file being handled: zoomLevel, scrollX, scrollY, active, ...

Specified by:

getStateProperties in interface IHopFileTypeHandler

Returns:

The state properties

close

public void close()

Description copied from interface: IHopFileTypeHandler

Actually close the file, remove it from the user interface.

Specified by:

close in interface IHopFileTypeHandler

applyStateProperties

public void applyStateProperties(Map<String,Object> stateProperties)

Specified by:

applyStateProperties in interface IHopFileTypeHandler

getVariables

public IVariables getVariables()

Description copied from interface: IHopFileTypeHandler

The variables associated with the file. It's usually keeping internal variables and other file specific settings like active unit test settings.

Specified by:

getVariables in interface IHopFileTypeHandler

Returns:

The variables associated with the loaded file

getHopGui

public HopGui getHopGui()

Gets hopGui

Returns:

value of hopGui

setHopGui

public void setHopGui(HopGui hopGui)

Parameters:

hopGui - The hopGui to set

getPerspective

public ExplorerPerspective getPerspective()

Gets perspective

Returns:

value of perspective

setPerspective

public void setPerspective(ExplorerPerspective perspective)

Parameters:

perspective - The perspective to set

getExplorerFile

public ExplorerFile getExplorerFile()

Gets explorerFile

Returns:

value of explorerFile

setExplorerFile

public void setExplorerFile(ExplorerFile explorerFile)

Parameters:

explorerFile - The explorerFile to set