Package org.pentaho.di.trans.steps.zipfile

Class ZipFileMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.zipfile.ZipFileMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class ZipFileMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final int	OPERATION_TYPE_DELETE
static final int	OPERATION_TYPE_MOVE
static final int	OPERATION_TYPE_NOTHING
static final String[]	operationTypeCode	The operations type codes
static final String[]	operationTypeDesc	The operations description

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor	Description
ZipFileMeta()

Method Summary

Modifier and Type	Method	Description
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)	Checks the settings of this step and puts the findings in a remarks List.
Object	clone()	Make an exact copy of this step, make sure to explicitly copy Collections etc.
String	getBaseFolderField()
String	getDynamicSourceFileNameField()
String	getDynamicTargetFileNameField()
String	getMoveToFolderField()
int	getOperationType()
static int	getOperationTypeByDesc(String tt)
static String	getOperationTypeDesc(int i)
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)	Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData()	Get a new instance of the appropriate data class.
String	getXML()	Produces the XML string that describes this step's information.
boolean	isaddTargetFileNametoResult()
boolean	isCreateParentFolder()
boolean	isKeepSouceFolder()
boolean	isOverwriteZipEntry()
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore)	Load the values for this step from an XML Node
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases)	Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step)	Save the steps data into a Kettle repository
void	setaddTargetFileNametoResult(boolean addresultfilenames)
void	setBaseFolderField(String baseFolderField)
void	setCreateParentFolder(boolean createparentfolder)
void	setDefault()	Set default values
void	setDynamicSourceFileNameField(String sourcefilenamefield)
void	setDynamicTargetFileNameField(String targetfilenamefield)
void	setKeepSouceFolder(boolean value)
void	setMoveToFolderField(String movetofolderfield)
void	setOperationType(int operationType)
void	setOverwriteZipEntry(boolean overwritezipentry)
boolean	supportsErrorHandling()

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta

Field Details

operationTypeDesc

public static final String[] operationTypeDesc

The operations description

operationTypeCode

public static final String[] operationTypeCode

The operations type codes

OPERATION_TYPE_NOTHING

public static final int OPERATION_TYPE_NOTHING

See Also:

• Constant Field Values

OPERATION_TYPE_MOVE

public static final int OPERATION_TYPE_MOVE

See Also:

• Constant Field Values

OPERATION_TYPE_DELETE

public static final int OPERATION_TYPE_DELETE

See Also:

• Constant Field Values

Constructor Details

ZipFileMeta

public ZipFileMeta()

Method Details

getDynamicSourceFileNameField

public String getDynamicSourceFileNameField()

Returns:

Returns the sourcefilenamefield.

setDynamicSourceFileNameField

public void setDynamicSourceFileNameField(String sourcefilenamefield)

Parameters:

sourcefilenamefield - The sourcefilenamefield to set.

getBaseFolderField

public String getBaseFolderField()

Returns:

Returns the baseFolderField.

setBaseFolderField

public void setBaseFolderField(String baseFolderField)

Parameters:

baseFolderField - The baseFolderField to set.

getMoveToFolderField

public String getMoveToFolderField()

Returns:

Returns the movetofolderfield.

setMoveToFolderField

public void setMoveToFolderField(String movetofolderfield)

Parameters:

movetofolderfield - The movetofolderfield to set.

getDynamicTargetFileNameField

public String getDynamicTargetFileNameField()

Returns:

Returns the targetfilenamefield.

setDynamicTargetFileNameField

public void setDynamicTargetFileNameField(String targetfilenamefield)

Parameters:

targetfilenamefield - The targetfilenamefield to set.

isaddTargetFileNametoResult

public boolean isaddTargetFileNametoResult()

isOverwriteZipEntry

public boolean isOverwriteZipEntry()

isCreateParentFolder

public boolean isCreateParentFolder()

isKeepSouceFolder

public boolean isKeepSouceFolder()

setKeepSouceFolder

public void setKeepSouceFolder(boolean value)

setaddTargetFileNametoResult

public void setaddTargetFileNametoResult(boolean addresultfilenames)

setOverwriteZipEntry

public void setOverwriteZipEntry(boolean overwritezipentry)

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)

loadXML

public void loadXML(Node stepnode,
 List<org.pentaho.di.core.database.DatabaseMeta> databases,
 org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

clone

public Object clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getXML

public String getXML()

Description copied from class: BaseStepMeta

Produces the XML string that describes this step's information.

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

String containing the XML describing this step.

readRep

public void readRep(Repository rep,
 org.pentaho.metastore.api.IMetaStore metaStore,
 org.pentaho.di.repository.ObjectId id_step,
 List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
 org.pentaho.metastore.api.IMetaStore metaStore,
 org.pentaho.di.repository.ObjectId id_transformation,
 org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write to

id_transformation - The transformation ID

id_step - The step ID

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
 TransMeta transMeta,
 StepMeta stepMeta,
 org.pentaho.di.core.row.RowMetaInterface prev,
 String[] input,
 String[] output,
 org.pentaho.di.core.row.RowMetaInterface info,
 org.pentaho.di.core.variables.VariableSpace space,
 Repository repository,
 org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from interface: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

Specified by:

check in interface StepMetaInterface

Overrides:

check in class BaseStepMeta

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepMeta - The stepMeta to help checking

prev - The fields coming from the previous step

input - The input step names

output - The output step names

info - The fields that are used as information by the step

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

getStep

public StepInterface getStep(StepMeta stepMeta,
 StepDataInterface stepDataInterface,
 int cnr,
 TransMeta transMeta,
 Trans trans)

Description copied from interface: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

Specified by:

getStep in interface StepMetaInterface

Parameters:

stepMeta - The step info

stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.

cnr - The copy nr to get

transMeta - The transformation info

trans - The launching transformation

getStepData

public StepDataInterface getStepData()

Description copied from interface: StepMetaInterface

Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:

getStepData in interface StepMetaInterface

Returns:

The appropriate StepDataInterface class.

supportsErrorHandling

public boolean supportsErrorHandling()

Specified by:

supportsErrorHandling in interface StepMetaInterface

Overrides:

supportsErrorHandling in class BaseStepMeta

Returns:

true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

getOperationType

public int getOperationType()

getOperationTypeByDesc

public static int getOperationTypeByDesc(String tt)

setOperationType

public void setOperationType(int operationType)

getOperationTypeDesc

public static String getOperationTypeDesc(int i)