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

Class HopPipelineFileType<T extends PipelineMeta>

java.lang.Object

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

org.apache.hop.ui.hopgui.file.pipeline.HopPipelineFileType<T>

All Implemented Interfaces:

IHopFileType

@HopFileTypePlugin(id="HopFile-Pipeline-Plugin",
                   description="The pipeline file information for the Hop GUI",
                   image="ui/images/pipeline.svg")
public class HopPipelineFileType<T extends PipelineMeta>
extends HopFileTypeBase
implements IHopFileType

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTION_ID_NEW_PIPELINE
static String	PIPELINE_FILE_TYPE_DESCRIPTION
static Class<?>	PKG

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
HopPipelineFileType()

Method Summary

Modifier and Type	Method	Description
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	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 org.apache.hop.ui.hopgui.file.HopFileTypeBase

equals, hasCapability

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

hasCapability

Field Detail

PKG

public static final Class<?> PKG

PIPELINE_FILE_TYPE_DESCRIPTION

public static final String PIPELINE_FILE_TYPE_DESCRIPTION

See Also:

Constant Field Values

ACTION_ID_NEW_PIPELINE

public static final String ACTION_ID_NEW_PIPELINE

See Also:

Constant Field Values

Constructor Detail

HopPipelineFileType

public HopPipelineFileType()

Method Detail

getName

public String getName()

Specified by:

getName in interface IHopFileType

Specified by:

getName in class HopFileTypeBase

Returns:

The name of this file type

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

Specified by:

getFilterExtensions in class HopFileTypeBase

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

Specified by:

getCapabilities in class HopFileTypeBase

Returns:

The capabilities of this file handler

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

Overrides:

isHandledBy in class HopFileTypeBase

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