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

Class HopFileTypeBase

java.lang.Object

org.apache.hop.ui.hopgui.file.HopFileTypeBase

All Implemented Interfaces:

IHopFileType

Direct Known Subclasses:

BaseExplorerFileType, HopPipelineFileType, HopWorkflowFileType

public abstract class HopFileTypeBase
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
HopFileTypeBase()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
abstract Properties	getCapabilities()
abstract String[]	getFilterExtensions()
abstract 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.

Methods inherited from class java.lang.Object

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

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

getContextHandlers, getDefaultFileExtension, getFileTypeImage, getFilterNames, newFile, openFile, supportsFile

Constructor Detail

HopFileTypeBase

public HopFileTypeBase()

Method Detail

getName

public abstract String getName()

Specified by:

getName in interface IHopFileType

Returns:

The name of this file type

getCapabilities

public abstract Properties getCapabilities()

Specified by:

getCapabilities in interface IHopFileType

Returns:

The capabilities of this file handler

getFilterExtensions

public abstract String[] getFilterExtensions()

Specified by:

getFilterExtensions in interface IHopFileType

Returns:

The file type extensions.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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, ...

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