Package org.apache.hop.imp

Interface IHopImport

All Known Implementing Classes:

HopImportBase

public interface IHopImport

Method Summary

Modifier and Type	Method	Description
String	getImportReport()	Generate an import report in text format with statistics and advice.
org.apache.commons.vfs2.FileObject	getInputFolder()
String	getInputFolderName()
String	getJdbcPropertiesFilename()	Gets jdbcPropertiesFilename
String	getKettlePropertiesFilename()	Gets kettlePropertiesFilename
MultiMetadataProvider	getMetadataProvider()	Gets metadataProvider
org.apache.commons.vfs2.FileObject	getOutputFolder()
String	getOutputFolderName()
String	getSharedXmlFilename()	Gets sharedXmlFilename
String	getTargetConfigFilename()	Gets targetConfigFilename
void	importConnections()	Import connections from the specified source files/folders
void	importFiles()	Import all files from the specified source folder to the target
void	importVariables()	Import variables from the specified source files/folders
void	init(IVariables variables, ILogChannel log)	Initialize the importer
boolean	isSkippingExistingTargetFiles()	Gets skippingExistingTargetFiles
boolean	isSkippingFolders()
boolean	isSkippingHiddenFilesAndFolders()	Gets skippingHiddenFilesAndFolders
void	runImport(IProgressMonitor monitor)	Perform the actual import of all files
void	setJdbcPropertiesFilename(String jdbcPropertiesFilename)
void	setKettlePropertiesFilename(String kettlePropertiesFilename)
void	setMetadataProvider(MultiMetadataProvider metadataProvider)
void	setSharedXmlFilename(String sharedXmlFilename)
void	setSkippingExistingTargetFiles(boolean skippingExistingTargetFiles)
void	setSkippingFolders(boolean skippingFolders)
void	setSkippingHiddenFilesAndFolders(boolean skippingHiddenFilesAndFolders)
void	setTargetConfigFilename(String targetConfigFilename)
void	setValidateInputFolder(String inputFolderName)
void	setValidateOutputFolder(String outputFolderName)

Method Detail

init

void init(IVariables variables,
          ILogChannel log)
   throws HopException

Initialize the importer

Parameters:

variables -

log -

Throws:

HopException

runImport

void runImport(IProgressMonitor monitor)
        throws HopException

Perform the actual import of all files

Parameters:

monitor -

Throws:

HopException

importFiles

void importFiles()
          throws HopException

Import all files from the specified source folder to the target

Throws:

HopException

importConnections

void importConnections()
                throws HopException

Import connections from the specified source files/folders

Throws:

HopException

getImportReport

String getImportReport()

Generate an import report in text format with statistics and advice.

Returns:

The import report

importVariables

void importVariables()
              throws HopException

Import variables from the specified source files/folders

Throws:

HopException

setValidateInputFolder

void setValidateInputFolder(String inputFolderName)
                     throws HopException

Throws:

HopException

getInputFolder

org.apache.commons.vfs2.FileObject getInputFolder()

setValidateOutputFolder

void setValidateOutputFolder(String outputFolderName)
                      throws HopException

Throws:

HopException

getOutputFolder

org.apache.commons.vfs2.FileObject getOutputFolder()

getInputFolderName

String getInputFolderName()

getOutputFolderName

String getOutputFolderName()

isSkippingExistingTargetFiles

boolean isSkippingExistingTargetFiles()

Gets skippingExistingTargetFiles

Returns:

value of skippingExistingTargetFiles

setSkippingExistingTargetFiles

void setSkippingExistingTargetFiles(boolean skippingExistingTargetFiles)

Parameters:

skippingExistingTargetFiles - The skippingExistingTargetFiles to set

getSharedXmlFilename

String getSharedXmlFilename()

Gets sharedXmlFilename

Returns:

value of sharedXmlFilename

setSharedXmlFilename

void setSharedXmlFilename(String sharedXmlFilename)

Parameters:

sharedXmlFilename - The sharedXmlFilename to set

getKettlePropertiesFilename

String getKettlePropertiesFilename()

Gets kettlePropertiesFilename

Returns:

value of kettlePropertiesFilename

setKettlePropertiesFilename

void setKettlePropertiesFilename(String kettlePropertiesFilename)

Parameters:

kettlePropertiesFilename - The kettlePropertiesFilename to set

getJdbcPropertiesFilename

String getJdbcPropertiesFilename()

Gets jdbcPropertiesFilename

Returns:

value of jdbcPropertiesFilename

setJdbcPropertiesFilename

void setJdbcPropertiesFilename(String jdbcPropertiesFilename)

Parameters:

jdbcPropertiesFilename - The jdbcPropertiesFilename to set

getTargetConfigFilename

String getTargetConfigFilename()

Gets targetConfigFilename

Returns:

value of targetConfigFilename

isSkippingHiddenFilesAndFolders

boolean isSkippingHiddenFilesAndFolders()

Gets skippingHiddenFilesAndFolders

Returns:

value of skippingHiddenFilesAndFolders

setSkippingHiddenFilesAndFolders

void setSkippingHiddenFilesAndFolders(boolean skippingHiddenFilesAndFolders)

Parameters:

skippingHiddenFilesAndFolders - The skippingHiddenFilesAndFolders to set

setTargetConfigFilename

void setTargetConfigFilename(String targetConfigFilename)

Parameters:

targetConfigFilename - The targetConfigFilename to set

isSkippingFolders

boolean isSkippingFolders()

setSkippingFolders

void setSkippingFolders(boolean skippingFolders)

Parameters:

skippingFolders - The skippingFolders to set

getMetadataProvider

MultiMetadataProvider getMetadataProvider()

Gets metadataProvider

Returns:

value of metadataProvider

setMetadataProvider

void setMetadataProvider(MultiMetadataProvider metadataProvider)

Parameters:

metadataProvider - The metadataProvider to set