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

Class ExplorerFileType

java.lang.Object

org.apache.hop.ui.hopgui.perspective.explorer.file.ExplorerFileType

All Implemented Interfaces:

IHopFileType

public class ExplorerFileType
extends Object
implements IHopFileType

Field Summary

Fields inherited from interface org.apache.hop.ui.hopgui.file.IHopFileType

CAPABILITY_ALIGN_BOTTOM, CAPABILITY_ALIGN_LEFT, CAPABILITY_ALIGN_RIGHT, CAPABILITY_ALIGN_TOP, CAPABILITY_CLOSE, CAPABILITY_COPY, CAPABILITY_CUT, CAPABILITY_DEBUG, CAPABILITY_DELETE, CAPABILITY_DISTRIBUTE_HORIZONTAL, CAPABILITY_DISTRIBUTE_VERTICAL, CAPABILITY_EXPORT_TO_SVG, CAPABILITY_FILE_HISTORY, CAPABILITY_HANDLE_METADATA, CAPABILITY_NEW, CAPABILITY_PASTE, CAPABILITY_PAUSE, CAPABILITY_PREVIEW, CAPABILITY_SAVE, CAPABILITY_SAVE_AS, CAPABILITY_SELECT, CAPABILITY_SNAP_TO_GRID, CAPABILITY_START, CAPABILITY_STOP

Constructor Summary

Constructors

Constructor	Description
ExplorerFileType()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Properties	getCapabilities()
List<IGuiContextHandler>	getContextHandlers()
String	getDefaultFileExtension()	Returns the default file extension in lowercase prefixed with dot (.xxx) for this file type.
String	getFileTypeImage()	The icon image for this file type
String[]	getFilterExtensions()
String[]	getFilterNames()
String	getName()
boolean	hasCapability(String capability)	Check to see if the capability is present
boolean	isHandledBy(String filename, boolean checkContent)	Look at the given file and see if it's handled by this type.
IHopFileTypeHandler	newFile(HopGui hopGui, IVariables parentVariableSpace)
IHopFileTypeHandler	openFile(HopGui hopGui, String filename, IVariables parentVariableSpace)	Load and display the file
boolean	supportsFile(IHasFilename metaObject)	Checks whether or not this file type supports the given metadata class

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplorerFileType

public ExplorerFileType()

Method Detail

getName

public String getName()

Specified by:

getName in interface IHopFileType

Returns:

The name of this file type

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDefaultFileExtension

public String getDefaultFileExtension()

Description copied from interface: IHopFileType

Returns the default file extension in lowercase prefixed with dot (.xxx) for this file type.

Specified by:

getDefaultFileExtension in interface IHopFileType

Returns:

The default file extension

getFilterExtensions

public String[] getFilterExtensions()

Specified by:

getFilterExtensions in interface IHopFileType

Returns:

The file type extensions.

getFilterNames

public String[] getFilterNames()

Specified by:

getFilterNames in interface IHopFileType

Returns:

The file names (matching the extensions)

getCapabilities

public Properties getCapabilities()

Specified by:

getCapabilities in interface IHopFileType

Returns:

The capabilities of this file handler

hasCapability

public boolean hasCapability(String capability)

Description copied from interface: IHopFileType

Check to see if the capability is present

Specified by:

hasCapability in interface IHopFileType

Parameters:

capability - The capability to check

Returns:

True if the capability is set to any non-null value

openFile

public IHopFileTypeHandler openFile(HopGui hopGui,
                                    String filename,
                                    IVariables parentVariableSpace)
                             throws HopException

Description copied from interface: IHopFileType

Load and display the file

Specified by:

openFile in interface IHopFileType

Parameters:

hopGui - The hop GUI to reference

filename - The filename to load

parentVariableSpace - The parent variablespace to inherit from

Returns:

The hop file handler

Throws:

HopException

newFile

public IHopFileTypeHandler newFile(HopGui hopGui,
                                   IVariables parentVariableSpace)
                            throws HopException

Specified by:

newFile in interface IHopFileType

Throws:

HopException

isHandledBy

public boolean isHandledBy(String filename,
                           boolean checkContent)
                    throws HopException

Description copied from interface: IHopFileType

Look at the given file and see if it's handled by this type. Usually this is done by simply looking at the file extension. In rare cases we look at the content.

Specified by:

isHandledBy in interface IHopFileType

Parameters:

filename - The filename

checkContent - True if we want to look inside the file content

Returns:

true if this HopFile is handling the file

Throws:

HopException - In case something goes wrong like: file doesn't exist, a permission problem, ...

supportsFile

public boolean supportsFile(IHasFilename metaObject)

Description copied from interface: IHopFileType

Checks whether or not this file type supports the given metadata class

Specified by:

supportsFile in interface IHopFileType

Parameters:

metaObject - The object to verify support for

Returns:

getContextHandlers

public List<IGuiContextHandler> getContextHandlers()

Specified by:

getContextHandlers in interface IHopFileType

Returns:

A list of context handlers allowing you to see all the actions that can be taken with the current file type. (CRUD, ...)

getFileTypeImage

public String getFileTypeImage()

Description copied from interface: IHopFileType

The icon image for this file type

Specified by:

getFileTypeImage in interface IHopFileType

Returns:

The path to the SVG file, a logo for this file type