Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pentaho.di.job.entries.unzip
Class JobEntryUnZip

    java.lang.Object
      org.pentaho.di.job.entry.JobEntryBase
          org.pentaho.di.job.entries.unzip.JobEntryUnZip

All Implemented Interfaces:
  Cloneable, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

    public class JobEntryUnZip

extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'unzip' job entry. Its main use would be to unzip files in a directory

Since:
  25-09-2007
Author:
  Samatar Hassan

Field Summary
`int` | `afterunzip`
`static int` | `IF_FILE_EXISTS_FAIL`
`static int` | `IF_FILE_EXISTS_OVERWRITE`
`static int` | `IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE`
`static int` | `IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE`
`static int` | `IF_FILE_EXISTS_OVERWRITE_ZIP_BIG`
`static int` | `IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL`
`static int` | `IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL`
`static int` | `IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL`
`static int` | `IF_FILE_EXISTS_SKIP`
`static int` | `IF_FILE_EXISTS_UNIQ`
`String` | `SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED`
`String` | `SUCCESS_IF_ERRORS_LESS`
`String` | `SUCCESS_IF_NO_ERRORS`
`static String[]` | `typeIfFileExistsCode`
`static String[]` | `typeIfFileExistsDesc`

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase
`category_order`

Constructor Summary
`JobEntryUnZip()`
`JobEntryUnZip(JobEntryBase jeb)`
`JobEntryUnZip(String n)`

Method Summary
`void` | `check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta)` Support for overrides not having to put in a check method
`Object` | `clone()`
`boolean` | `evaluates()` check whether or not this job entry evaluates.
`org.pentaho.di.core.Result` | `execute(org.pentaho.di.core.Result previousResult, int nr, Repository rep, Job parentJob)`
`boolean` | `getDatafromprevious()`
`String` | `getDateTimeFormat()`
`int` | `getIfFileExist()`
`static String` | `getIfFileExistsCode(int i)`
`static int` | `getIfFileExistsInt(String desc)`
`String` | `getLimit()`
`String` | `getMoveToDirectory()`
`String` | `getSourceDirectory()`
`String` | `getSuccessCondition()`
`String` | `getWildcard()`
`String` | `getWildcardExclude()`
`String` | `getWildcardSource()`
`String` | `getXML()`
`String` | `getZipFilename()`
`boolean` | `isAddFileToResult()`
`boolean` | `isCreateFolder()`
`boolean` | `isCreateMoveToDirectory()`
`boolean` | `isCreateRootFolder()`
`boolean` | `isDateInFilename()`
`boolean` | `isSpecifyFormat()`
`boolean` | `isTimeInFilename()`
`void` | `loadRep(Repository rep, long id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)`
`void` | `loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)`
`void` | `saveRep(Repository rep, long id_job)`
`void` | `setAddFileToResult(boolean addfiletoresultin)`
`void` | `setCreateFolder(boolean createfolder)`
`void` | `setCreateMoveToDirectory(boolean createMoveToDirectory)`
`void` | `setCreateRootFolder(boolean rootzip)`
`void` | `setDatafromprevious(boolean isfromprevious)`
`void` | `setDateInFilename(boolean adddate)`
`void` | `setDateTimeFormat(String date_time_format)`
`void` | `setIfFileExists(int iffileexist)`
`void` | `setLimit(String nr_limitin)`
`void` | `setMoveToDirectory(String movetodirectory)`
`void` | `setSourceDirectory(String targetdirectoryin)`
`void` | `setSpecifyFormat(boolean SpecifyFormat)`
`void` | `setSuccessCondition(String success_condition)`
`void` | `setTimeInFilename(boolean addtime)`
`void` | `setWildcard(String wildcard)`
`void` | `setWildcardExclude(String wildcardexclude)`
`void` | `setWildcardSource(String wildcardSource)`
`void` | `setZipFilename(String zipFilename)`

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
`clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, exportResources, getBooleanValueOfVariable, getConfigId, getDescription, getDialogClassName, getFilename, getHolderType, getID, getJobEntryType, getName, getParentVariableSpace, getPluginID, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeCode, getTypeCode, getTypeDesc, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, initializeVariablesFrom, injectVariables, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadXML, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setParentVariableSpace, setPluginID, setVariable, shareVariablesWith, toString`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
`clear, exportResources, getConfigId, getDescription, getDialogClassName, getFilename, getID, getJobEntryType, getName, getPluginID, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeCode, getUsedDatabaseConnections, hasChanged, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setPluginID`

Field Detail

### afterunzip

    public int afterunzip

### SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED

    public String SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED

### SUCCESS_IF_ERRORS_LESS

    public String SUCCESS_IF_ERRORS_LESS

### SUCCESS_IF_NO_ERRORS

    public String SUCCESS_IF_NO_ERRORS

### IF_FILE_EXISTS_SKIP

    public static final int IF_FILE_EXISTS_SKIP

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE

    public static final int IF_FILE_EXISTS_OVERWRITE

See Also:
  Constant Field Values

### IF_FILE_EXISTS_UNIQ

    public static final int IF_FILE_EXISTS_UNIQ

See Also:
  Constant Field Values

### IF_FILE_EXISTS_FAIL

    public static final int IF_FILE_EXISTS_FAIL

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE

    public static final int IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE

    public static final int IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_ZIP_BIG

    public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_BIG

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL

    public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL

    public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL

See Also:
  Constant Field Values

### IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL

    public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL

See Also:
  Constant Field Values

### typeIfFileExistsCode

    public static final String[] typeIfFileExistsCode

### typeIfFileExistsDesc

    public static final String[] typeIfFileExistsDesc

Constructor Detail

### JobEntryUnZip

    public JobEntryUnZip(String n)

### JobEntryUnZip

    public JobEntryUnZip()

### JobEntryUnZip

    public JobEntryUnZip(JobEntryBase jeb)

Method Detail

### clone

    public Object clone()

  Specified by:
    `clone` in interface `JobEntryInterface`
  Overrides:
    `clone` in class `JobEntryBase`

### getXML

    public String getXML()

  Specified by:
    `getXML` in interface `JobEntryInterface`
  Overrides:
    `getXML` in class `JobEntryBase`

### loadXML

    public void loadXML(Node entrynode,
                        List<org.pentaho.di.core.database.DatabaseMeta> databases,
                        List<SlaveServer> slaveServers,
                        Repository rep)
                 throws org.pentaho.di.core.exception.KettleXMLException

  Specified by:
    `loadXML` in interface `JobEntryInterface`
  Throws:
    `org.pentaho.di.core.exception.KettleXMLException`

### loadRep

    public void loadRep(Repository rep,
                        long id_jobentry,
                        List<org.pentaho.di.core.database.DatabaseMeta> databases,
                        List<SlaveServer> slaveServers)
                 throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `loadRep` in interface `JobEntryInterface`
  Overrides:
    `loadRep` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### saveRep

    public void saveRep(Repository rep,
                        long id_job)
                 throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `saveRep` in interface `JobEntryInterface`
  Overrides:
    `saveRep` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### execute

    public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult,
                                              int nr,
                                              Repository rep,
                                              Job parentJob)

  Specified by:
    `execute` in interface `JobEntryInterface`

### evaluates

    public boolean evaluates()

  Description copied from class: `JobEntryBase`
  check whether or not this job entry evaluates.

  Specified by:
    `evaluates` in interface `JobEntryInterface`
  Overrides:
    `evaluates` in class `JobEntryBase`
  Returns:
    true if the job entry evaluates

### getIfFileExistsInt

    public static final int getIfFileExistsInt(String desc)

### getIfFileExistsCode

    public static final String getIfFileExistsCode(int i)

### getIfFileExist

    public int getIfFileExist()

  Returns:
    Returns the iffileexist.

### setIfFileExists

    public void setIfFileExists(int iffileexist)

  Parameters:
    `setIfFileExist` - The iffileexist to set.

### isCreateMoveToDirectory

    public boolean isCreateMoveToDirectory()

### setCreateMoveToDirectory

    public void setCreateMoveToDirectory(boolean createMoveToDirectory)

### setZipFilename

    public void setZipFilename(String zipFilename)

### setWildcard

    public void setWildcard(String wildcard)

### setWildcardExclude

    public void setWildcardExclude(String wildcardexclude)

### setSourceDirectory

    public void setSourceDirectory(String targetdirectoryin)

### setMoveToDirectory

    public void setMoveToDirectory(String movetodirectory)

### getSourceDirectory

    public String getSourceDirectory()

### getMoveToDirectory

    public String getMoveToDirectory()

### getZipFilename

    public String getZipFilename()

### getWildcardSource

    public String getWildcardSource()

### setWildcardSource

    public void setWildcardSource(String wildcardSource)

### getWildcard

    public String getWildcard()

### getWildcardExclude

    public String getWildcardExclude()

### setAddFileToResult

    public void setAddFileToResult(boolean addfiletoresultin)

### isAddFileToResult

    public boolean isAddFileToResult()

### setDateInFilename

    public void setDateInFilename(boolean adddate)

### isDateInFilename

    public boolean isDateInFilename()

### setTimeInFilename

    public void setTimeInFilename(boolean addtime)

### isTimeInFilename

    public boolean isTimeInFilename()

### isSpecifyFormat

    public boolean isSpecifyFormat()

### setSpecifyFormat

    public void setSpecifyFormat(boolean SpecifyFormat)

### getDateTimeFormat

    public String getDateTimeFormat()

### setDateTimeFormat

    public void setDateTimeFormat(String date_time_format)

### setDatafromprevious

    public void setDatafromprevious(boolean isfromprevious)

### getDatafromprevious

    public boolean getDatafromprevious()

### setCreateRootFolder

    public void setCreateRootFolder(boolean rootzip)

### isCreateRootFolder

    public boolean isCreateRootFolder()

### setCreateFolder

    public void setCreateFolder(boolean createfolder)

### isCreateFolder

    public boolean isCreateFolder()

### setLimit

    public void setLimit(String nr_limitin)

### getLimit

    public String getLimit()

### setSuccessCondition

    public void setSuccessCondition(String success_condition)

### getSuccessCondition

    public String getSuccessCondition()

### check

    public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                      JobMeta jobMeta)

  Description copied from class: `JobEntryBase`
  Support for overrides not having to put in a check method

  Specified by:
    `check` in interface `JobEntryInterface`
  Overrides:
    `check` in class `JobEntryBase`
  Parameters:
    `remarks` - CheckResults from checking the job entry
    `jobMeta` - JobMeta information letting threading back to the JobMeta possible

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD