ExcelInputMeta

java.lang.Object
- org.pentaho.di.trans.step.BaseStepMeta
- - org.pentaho.di.trans.steps.excelinput.ExcelInputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface
```
public class ExcelInputMeta
extends BaseStepMeta
implements StepMetaInterface
```
Meta data for the Excel step.

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`RequiredFilesCode`
`static String[]`	`RequiredFilesDesc`
`static String`	`STRING_SEPARATOR`
`static int`	`TYPE_TRIM_BOTH`
`static String[]`	`type_trim_code`
`static String[]`	`type_trim_desc`
`static int`	`TYPE_TRIM_LEFT`
`static int`	`TYPE_TRIM_NONE`
`static int`	`TYPE_TRIM_RIGHT`

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors
Constructor and Description

ExcelInputMeta()

Constructors
Constructor and Description
`ExcelInputMeta()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`allocate(int nrfiles, int nrsheets, int nrfields)`
`void`	`allocateFiles(int nrfiles)`
`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`	`exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)`
`String`	`getAcceptingField()`
`StepMeta`	`getAcceptingStep()`
`String`	`getAcceptingStepName()`
`String`	`getBadLineFilesExtension()`
`org.pentaho.di.core.row.RowMetaInterface`	`getEmptyFields()`
`String`	`getEncoding()`
`String`	`getErrorFilesDestinationDirectory()`
`String`	`getErrorFilesExtension()`
`String[]`	`getExcludeFileMask()`
`String[]`	`getExludeFileMask()` Deprecated.
`String`	`getExtensionField()`
`ExcelInputField[]`	`getField()`
`void`	`getFields(org.pentaho.di.core.row.RowMetaInterface row, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)` Gets the fields.
`String`	`getFileField()`
`org.pentaho.di.core.fileinput.FileInputList`	`getFileList(org.pentaho.di.core.variables.VariableSpace space)`
`String[]`	`getFileMask()`
`String[]`	`getFileName()`
`String[]`	`getFilePaths(org.pentaho.di.core.variables.VariableSpace space)`
`String[]`	`getFileRequired()`
`String[]`	`getIncludeSubFolders()`
`String[]`	`getInfoSteps()`
`String`	`getLastModificationDateField()`
`String`	`getLineNumberFilesDestinationDirectory()`
`String`	`getLineNumberFilesExtension()`
`String`	`getLookupStepname()`
`String`	`getPathField()`
`String`	`getRequiredFilesCode(String tt)`
`String`	`getRequiredFilesDesc(String tt)`
`String`	`getRootUriField()`
`long`	`getRowLimit()`
`String`	`getRowNumberField()`
`String`	`getSheetField()`
`String[]`	`getSheetName()`
`String`	`getSheetRowNumberField()`
`String`	`getShortFileNameField()`
`String`	`getSizeField()`
`SpreadSheetType`	`getSpreadSheetType()`
`int[]`	`getStartColumn()`
`int[]`	`getStartRow()`
`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.
`static int`	`getTrimTypeByCode(String tt)`
`static int`	`getTrimTypeByDesc(String tt)`
`static String`	`getTrimTypeCode(int i)`
`static String`	`getTrimTypeDesc(int i)`
`String`	`getUriField()`
`String[]`	`getUsedLibraries()`
`String`	`getWarningFilesDestinationDirectory()`
`String`	`getXML()` Produces the XML string that describes this step's information.
`boolean`	`ignoreEmptyRows()`
`boolean`	`isAcceptingFilenames()`
`boolean`	`isAddResultFile()`
`boolean`	`isErrorIgnored()`
`boolean`	`isErrorLineSkipped()`
`String`	`isHiddenField()`
`boolean`	`isStrictTypes()`
`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
`boolean`	`readAllSheets()` Read all sheets if the sheet names are left blank.
`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`	`searchInfoAndTargetSteps(List<StepMeta> steps)` Change step names into step objects to allow them to be name-changed etc.
`void`	`setAcceptingField(String acceptingField)`
`void`	`setAcceptingFilenames(boolean acceptingFilenames)`
`void`	`setAcceptingStep(StepMeta acceptingStep)`
`void`	`setAcceptingStepName(String acceptingStepName)`
`void`	`setAddResultFile(boolean isaddresult)`
`void`	`setBadLineFilesExtension(String badLineFilesExtension)`
`void`	`setDefault()` Set default values
`void`	`setEncoding(String encoding)`
`void`	`setErrorFilesDestinationDirectory(String errorLineFilesDestinationDirectory)`
`void`	`setErrorFilesExtension(String errorLineFilesExtension)`
`void`	`setErrorIgnored(boolean errorIgnored)`
`void`	`setErrorLineSkipped(boolean errorLineSkipped)`
`void`	`setExcludeFileMask(String[] excludeFileMask)`
`void`	`setExtensionField(String field)`
`void`	`setField(ExcelInputField[] fields)`
`void`	`setFileField(String fileField)`
`void`	`setFileMask(String[] fileMask)`
`void`	`setFileName(String[] fileName)`
`void`	`setFileRequired(String[] fileRequiredin)`
`void`	`setIgnoreEmptyRows(boolean ignoreEmptyRows)`
`void`	`setIncludeSubFolders(String[] includeSubFoldersin)`
`void`	`setIsHiddenField(String field)`
`void`	`setLastModificationDateField(String field)`
`void`	`setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)`
`void`	`setLineNumberFilesExtension(String lineNumberFilesExtension)`
`void`	`setPathField(String field)`
`void`	`setRootUriField(String field)`
`void`	`setRowLimit(long rowLimit)`
`void`	`setRowNumberField(String rowNumberField)`
`void`	`setSheetField(String sheetField)`
`void`	`setSheetName(String[] sheetName)`
`void`	`setSheetRowNumberField(String rowNumberField)`
`void`	`setShortFileNameField(String field)`
`void`	`setSizeField(String field)`
`void`	`setSpreadSheetType(SpreadSheetType spreadSheetType)`
`void`	`setStartColumn(int[] startColumn)`
`void`	`setStartRow(int[] startRow)`
`void`	`setStartsWithHeader(boolean startsWithHeader)`
`void`	`setStopOnEmpty(boolean stopOnEmpty)`
`void`	`setStrictTypes(boolean strictTypes)`
`void`	`setUriField(String field)`
`void`	`setWarningFilesDestinationDirectory(String badLineFilesDestinationDirectory)`
`boolean`	`startsWithHeader()`
`boolean`	`stopOnEmpty()`

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

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

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, setChanged, setParentStepMeta, supportsErrorHandling

- Field Detail
  - RequiredFilesDesc
```
public static final String[] RequiredFilesDesc
```
  - RequiredFilesCode
```
public static final String[] RequiredFilesCode
```
  - TYPE_TRIM_NONE
```
public static final int TYPE_TRIM_NONE
```
    See Also:
    
    Constant Field Values
  - TYPE_TRIM_LEFT
```
public static final int TYPE_TRIM_LEFT
```
    See Also:
    
    Constant Field Values
  - TYPE_TRIM_RIGHT
```
public static final int TYPE_TRIM_RIGHT
```
    See Also:
    
    Constant Field Values
  - TYPE_TRIM_BOTH
```
public static final int TYPE_TRIM_BOTH
```
    See Also:
    
    Constant Field Values
  - type_trim_code
```
public static final String[] type_trim_code
```
  - type_trim_desc
```
public static final String[] type_trim_desc
```
  - STRING_SEPARATOR
```
public static final String STRING_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExcelInputMeta
```
public ExcelInputMeta()
```
- Method Detail
  - getShortFileNameField
```
public String getShortFileNameField()
```
    Returns:
    
    Returns the shortFileFieldName.
  - setShortFileNameField
```
public void setShortFileNameField(String field)
```
    Parameters:
    
    field - The shortFileFieldName to set.
  - getPathField
```
public String getPathField()
```
    Returns:
    
    Returns the pathFieldName.
  - setPathField
```
public void setPathField(String field)
```
    Parameters:
    
    field - The pathFieldName to set.
  - isHiddenField
```
public String isHiddenField()
```
    Returns:
    
    Returns the hiddenFieldName.
  - setIsHiddenField
```
public void setIsHiddenField(String field)
```
    Parameters:
    
    field - The hiddenFieldName to set.
  - getLastModificationDateField
```
public String getLastModificationDateField()
```
    Returns:
    
    Returns the lastModificationTimeFieldName.
  - setLastModificationDateField
```
public void setLastModificationDateField(String field)
```
    Parameters:
    
    field - The lastModificationTimeFieldName to set.
  - getUriField
```
public String getUriField()
```
    Returns:
    
    Returns the uriNameFieldName.
  - setUriField
```
public void setUriField(String field)
```
    Parameters:
    
    field - The uriNameFieldName to set.
  - getRootUriField
```
public String getRootUriField()
```
    Returns:
    
    Returns the uriNameFieldName.
  - setRootUriField
```
public void setRootUriField(String field)
```
    Parameters:
    
    field - The rootUriNameFieldName to set.
  - getExtensionField
```
public String getExtensionField()
```
    Returns:
    
    Returns the extensionFieldName.
  - setExtensionField
```
public void setExtensionField(String field)
```
    Parameters:
    
    field - The extensionFieldName to set.
  - getSizeField
```
public String getSizeField()
```
    Returns:
    
    Returns the sizeFieldName.
  - setSizeField
```
public void setSizeField(String field)
```
    Parameters:
    
    field - The sizeFieldName to set.
  - getField
```
public ExcelInputField[] getField()
```
    Returns:
    
    Returns the fieldLength.
  - setField
```
public void setField(ExcelInputField[] fields)
```
    Parameters:
    
    fields - The excel input fields to set.
  - getFileField
```
public String getFileField()
```
    Returns:
    
    Returns the fileField.
  - setFileField
```
public void setFileField(String fileField)
```
    Parameters:
    
    fileField - The fileField to set.
  - getFileMask
```
public String[] getFileMask()
```
    Returns:
    
    Returns the fileMask.
  - setFileMask
```
public void setFileMask(String[] fileMask)
```
    Parameters:
    
    fileMask - The fileMask to set.
  - getExludeFileMask
```
@Deprecated
public String[] getExludeFileMask()
```
    Deprecated.
    
    Returns:
    
    Returns the excludeFileMask. Deprecated due to typo
  - getExcludeFileMask
```
public String[] getExcludeFileMask()
```
    Returns:
    
    Returns the excludeFileMask.
  - setExcludeFileMask
```
public void setExcludeFileMask(String[] excludeFileMask)
```
    Parameters:
    
    excludeFileMask - The excludeFileMask to set.
  - getIncludeSubFolders
```
public String[] getIncludeSubFolders()
```
  - setIncludeSubFolders
```
public void setIncludeSubFolders(String[] includeSubFoldersin)
```
  - getRequiredFilesCode
```
public String getRequiredFilesCode(String tt)
```
  - getRequiredFilesDesc
```
public String getRequiredFilesDesc(String tt)
```
  - getFileName
```
public String[] getFileName()
```
    Returns:
    
    Returns the fileName.
  - setFileName
```
public void setFileName(String[] fileName)
```
    Parameters:
    
    fileName - The fileName to set.
  - ignoreEmptyRows
```
public boolean ignoreEmptyRows()
```
    Returns:
    
    Returns the ignoreEmptyRows.
  - setIgnoreEmptyRows
```
public void setIgnoreEmptyRows(boolean ignoreEmptyRows)
```
    Parameters:
    
    ignoreEmptyRows - The ignoreEmptyRows to set.
  - getRowLimit
```
public long getRowLimit()
```
    Returns:
    
    Returns the rowLimit.
  - setRowLimit
```
public void setRowLimit(long rowLimit)
```
    Parameters:
    
    rowLimit - The rowLimit to set.
  - getRowNumberField
```
public String getRowNumberField()
```
    Returns:
    
    Returns the rowNumberField.
  - setRowNumberField
```
public void setRowNumberField(String rowNumberField)
```
    Parameters:
    
    rowNumberField - The rowNumberField to set.
  - getSheetRowNumberField
```
public String getSheetRowNumberField()
```
    Returns:
    
    Returns the sheetRowNumberField.
  - setSheetRowNumberField
```
public void setSheetRowNumberField(String rowNumberField)
```
    Parameters:
    
    rowNumberField - The rowNumberField to set.
  - getSheetField
```
public String getSheetField()
```
    Returns:
    
    Returns the sheetField.
  - setSheetField
```
public void setSheetField(String sheetField)
```
    Parameters:
    
    sheetField - The sheetField to set.
  - getSheetName
```
public String[] getSheetName()
```
    Returns:
    
    Returns the sheetName.
  - setSheetName
```
public void setSheetName(String[] sheetName)
```
    Parameters:
    
    sheetName - The sheetName to set.
  - getStartColumn
```
public int[] getStartColumn()
```
    Returns:
    
    Returns the startColumn.
  - setStartColumn
```
public void setStartColumn(int[] startColumn)
```
    Parameters:
    
    startColumn - The startColumn to set.
  - getStartRow
```
public int[] getStartRow()
```
    Returns:
    
    Returns the startRow.
  - setStartRow
```
public void setStartRow(int[] startRow)
```
    Parameters:
    
    startRow - The startRow to set.
  - startsWithHeader
```
public boolean startsWithHeader()
```
    Returns:
    
    Returns the startsWithHeader.
  - setStartsWithHeader
```
public void setStartsWithHeader(boolean startsWithHeader)
```
    Parameters:
    
    startsWithHeader - The startsWithHeader to set.
  - stopOnEmpty
```
public boolean stopOnEmpty()
```
    Returns:
    
    Returns the stopOnEmpty.
  - setStopOnEmpty
```
public void setStopOnEmpty(boolean stopOnEmpty)
```
    Parameters:
    
    stopOnEmpty - The stopOnEmpty to set.
  - 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
  - allocate
```
public void allocate(int nrfiles,
                     int nrsheets,
                     int nrfields)
```
  - allocateFiles
```
public void allocateFiles(int nrfiles)
```
  - setDefault
```
public void setDefault()
```
    Description copied from interface: StepMetaInterface
    
    Set default values
    
    Specified by:
    
    setDefault in interface StepMetaInterface
  - getFields
```
public void getFields(org.pentaho.di.core.row.RowMetaInterface row,
                      String name,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException
```
    Description copied from class: BaseStepMeta
    
    Gets the fields.
    
    Specified by:
    
    getFields in interface StepMetaInterface
    
    Overrides:
    
    getFields in class BaseStepMeta
    
    Parameters:
    
    row - the input row meta that is modified in this method to reflect the output row metadata of the step
    
    name - Name of the step to use as input for the origin field in the values
    
    info - Fields used as extra lookup information
    
    nextStep - the next step that is targeted
    
    space - the space The variable space to use to replace variables
    
    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
    
    Throws:
    
    org.pentaho.di.core.exception.KettleStepException - the kettle step exception
  - 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)
  - getTrimTypeByCode
```
public static final int getTrimTypeByCode(String tt)
```
  - getTrimTypeByDesc
```
public static final int getTrimTypeByDesc(String tt)
```
  - getTrimTypeCode
```
public static final String getTrimTypeCode(int i)
```
  - getTrimTypeDesc
```
public static final String getTrimTypeDesc(int i)
```
  - getFilePaths
```
public String[] getFilePaths(org.pentaho.di.core.variables.VariableSpace space)
```
  - getFileList
```
public org.pentaho.di.core.fileinput.FileInputList getFileList(org.pentaho.di.core.variables.VariableSpace space)
```
  - getLookupStepname
```
public String getLookupStepname()
```
  - searchInfoAndTargetSteps
```
public void searchInfoAndTargetSteps(List<StepMeta> steps)
```
    Description copied from class: BaseStepMeta
    
    Change step names into step objects to allow them to be name-changed etc.
    
    Specified by:
    
    searchInfoAndTargetSteps in interface StepMetaInterface
    
    Overrides:
    
    searchInfoAndTargetSteps in class BaseStepMeta
    
    Parameters:
    
    steps - the steps to reference
  - getInfoSteps
```
public String[] getInfoSteps()
```
  - 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
  - getEmptyFields
```
public org.pentaho.di.core.row.RowMetaInterface getEmptyFields()
```
  - 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.
  - getWarningFilesDestinationDirectory
```
public String getWarningFilesDestinationDirectory()
```
  - setWarningFilesDestinationDirectory
```
public void setWarningFilesDestinationDirectory(String badLineFilesDestinationDirectory)
```
  - getBadLineFilesExtension
```
public String getBadLineFilesExtension()
```
  - setBadLineFilesExtension
```
public void setBadLineFilesExtension(String badLineFilesExtension)
```
  - isErrorIgnored
```
public boolean isErrorIgnored()
```
  - setErrorIgnored
```
public void setErrorIgnored(boolean errorIgnored)
```
  - getErrorFilesDestinationDirectory
```
public String getErrorFilesDestinationDirectory()
```
  - setErrorFilesDestinationDirectory
```
public void setErrorFilesDestinationDirectory(String errorLineFilesDestinationDirectory)
```
  - getErrorFilesExtension
```
public String getErrorFilesExtension()
```
  - setErrorFilesExtension
```
public void setErrorFilesExtension(String errorLineFilesExtension)
```
  - getLineNumberFilesDestinationDirectory
```
public String getLineNumberFilesDestinationDirectory()
```
  - setLineNumberFilesDestinationDirectory
```
public void setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)
```
  - getLineNumberFilesExtension
```
public String getLineNumberFilesExtension()
```
  - setLineNumberFilesExtension
```
public void setLineNumberFilesExtension(String lineNumberFilesExtension)
```
  - isErrorLineSkipped
```
public boolean isErrorLineSkipped()
```
  - setErrorLineSkipped
```
public void setErrorLineSkipped(boolean errorLineSkipped)
```
  - isStrictTypes
```
public boolean isStrictTypes()
```
  - setStrictTypes
```
public void setStrictTypes(boolean strictTypes)
```
  - getFileRequired
```
public String[] getFileRequired()
```
  - setFileRequired
```
public void setFileRequired(String[] fileRequiredin)
```
  - getAcceptingField
```
public String getAcceptingField()
```
    Returns:
    
    Returns the acceptingField.
  - setAcceptingField
```
public void setAcceptingField(String acceptingField)
```
    Parameters:
    
    acceptingField - The acceptingField to set.
  - isAcceptingFilenames
```
public boolean isAcceptingFilenames()
```
    Returns:
    
    Returns the acceptingFilenames.
  - setAcceptingFilenames
```
public void setAcceptingFilenames(boolean acceptingFilenames)
```
    Parameters:
    
    acceptingFilenames - The acceptingFilenames to set.
  - getAcceptingStep
```
public StepMeta getAcceptingStep()
```
    Returns:
    
    Returns the acceptingStep.
  - setAcceptingStep
```
public void setAcceptingStep(StepMeta acceptingStep)
```
    Parameters:
    
    acceptingStep - The acceptingStep to set.
  - getAcceptingStepName
```
public String getAcceptingStepName()
```
    Returns:
    
    Returns the acceptingStepName.
  - setAcceptingStepName
```
public void setAcceptingStepName(String acceptingStepName)
```
    Parameters:
    
    acceptingStepName - The acceptingStepName to set.
  - getUsedLibraries
```
public String[] getUsedLibraries()
```
    Specified by:
    
    getUsedLibraries in interface StepMetaInterface
    
    Overrides:
    
    getUsedLibraries in class BaseStepMeta
    
    Returns:
    
    the libraries that this step or plug-in uses.
  - getEncoding
```
public String getEncoding()
```
    Returns:
    
    the encoding
  - setEncoding
```
public void setEncoding(String encoding)
```
    Parameters:
    
    encoding - the encoding to set
  - setAddResultFile
```
public void setAddResultFile(boolean isaddresult)
```
    Parameters:
    
    isaddresult - The isaddresult to set.
  - isAddResultFile
```
public boolean isAddResultFile()
```
    Returns:
    
    Returns isaddresult.
  - readAllSheets
```
public boolean readAllSheets()
```
    Read all sheets if the sheet names are left blank.
    
    Returns:
    
    true if all sheets are read.
  - exportResources
```
public String exportResources(org.pentaho.di.core.variables.VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws org.pentaho.di.core.exception.KettleException
```
    Specified by:
    
    exportResources in interface StepMetaInterface
    
    Overrides:
    
    exportResources in class BaseStepMeta
    
    Parameters:
    
    space - the variable space to use
    
    definitions -
    
    resourceNamingInterface -
    
    repository - The repository to optionally load other resources from (to be converted to XML)
    
    metaStore - the metaStore in which non-kettle metadata could reside.
    
    Returns:
    
    the filename of the exported resource
    
    Throws:
    
    org.pentaho.di.core.exception.KettleException
  - getSpreadSheetType
```
public SpreadSheetType getSpreadSheetType()
```
  - setSpreadSheetType
```
public void setSpreadSheetType(SpreadSheetType spreadSheetType)
```

Class ExcelInputMeta

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

RequiredFilesDesc

RequiredFilesCode

TYPE_TRIM_NONE

TYPE_TRIM_LEFT

TYPE_TRIM_RIGHT

TYPE_TRIM_BOTH

type_trim_code

type_trim_desc

STRING_SEPARATOR

Constructor Detail

ExcelInputMeta

Method Detail

getShortFileNameField

setShortFileNameField

getPathField

setPathField

isHiddenField

setIsHiddenField

getLastModificationDateField

setLastModificationDateField

getUriField

setUriField

getRootUriField

setRootUriField

getExtensionField

setExtensionField

getSizeField

setSizeField

getField

setField

getFileField

setFileField

getFileMask

setFileMask

getExludeFileMask

getExcludeFileMask

setExcludeFileMask

getIncludeSubFolders

setIncludeSubFolders

getRequiredFilesCode

getRequiredFilesDesc

getFileName

setFileName

ignoreEmptyRows

setIgnoreEmptyRows

getRowLimit

setRowLimit

getRowNumberField

setRowNumberField

getSheetRowNumberField

setSheetRowNumberField

getSheetField

setSheetField

getSheetName

setSheetName

getStartColumn

setStartColumn

getStartRow

setStartRow

startsWithHeader

setStartsWithHeader

stopOnEmpty

setStopOnEmpty

loadXML

clone

allocate

allocateFiles

setDefault

getFields

getXML

readRep