|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.excelinput.ExcelInputMeta
public class ExcelInputMeta
Meta data for the Excel step.
Field Summary | |
---|---|
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
|
Constructor Summary | |
---|---|
ExcelInputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfiles,
int nrsheets,
int nrfields)
|
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)
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)
Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. |
String |
getAcceptingField()
|
StepMeta |
getAcceptingStep()
|
String |
getAcceptingStepName()
|
String |
getBadLineFilesExtension()
|
org.pentaho.di.core.row.RowMetaInterface |
getEmptyFields()
|
String |
getEncoding()
|
String |
getErrorFilesDestinationDirectory()
|
String |
getErrorFilesExtension()
|
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)
Get the fields that are emitted by this step |
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[] |
getInfoSteps()
|
String |
getLineNumberFilesDestinationDirectory()
|
String |
getLineNumberFilesExtension()
|
String |
getLookupStepname()
|
long |
getRowLimit()
|
String |
getRowNumberField()
|
String |
getSheetField()
|
String[] |
getSheetName()
|
String |
getSheetRowNumberField()
|
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[] |
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()
|
boolean |
isStrictTypes()
|
void |
loadXML(Node stepnode,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
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,
long id_step,
List<org.pentaho.di.core.database.DatabaseMeta> databases,
Map<String,org.pentaho.di.core.Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
long id_transformation,
long id_step)
Save the steps data into a Kettle repository |
void |
searchInfoAndTargetSteps(List<StepMeta> steps)
|
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 |
setField(ExcelInputField[] fields)
|
void |
setFileField(String fileField)
|
void |
setFileMask(String[] fileMask)
|
void |
setFileName(String[] fileName)
|
void |
setFileRequired(String[] fileRequired)
|
void |
setIgnoreEmptyRows(boolean ignoreEmptyRows)
|
void |
setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)
|
void |
setLineNumberFilesExtension(String lineNumberFilesExtension)
|
void |
setRowLimit(long rowLimit)
|
void |
setRowNumberField(String rowNumberField)
|
void |
setSheetField(String sheetField)
|
void |
setSheetName(String[] sheetName)
|
void |
setSheetRowNumberField(String rowNumberField)
|
void |
setStartColumn(int[] startColumn)
|
void |
setStartRow(int[] startRow)
|
void |
setStartsWithHeader(boolean startsWithHeader)
|
void |
setStopOnEmpty(boolean stopOnEmpty)
|
void |
setStrictTypes(boolean strictTypes)
|
void |
setWarningFilesDestinationDirectory(String badLineFilesDestinationDirectory)
|
boolean |
startsWithHeader()
|
boolean |
stopOnEmpty()
|
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
analyseImpact, cancelQueries, chosesTargetSteps, excludeFromRowLayoutVerification, getDialogClassName, getID, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedArguments, getUsedDatabaseConnections, hasChanged, setChanged, setChanged, setID, setInfoSteps, setTargetSteps, 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, cancelQueries, excludeFromRowLayoutVerification, getDialogClassName, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getTargetSteps, getUsedArguments, getUsedDatabaseConnections, setInfoSteps, setTargetSteps, supportsErrorHandling |
Field Detail |
---|
public static final int TYPE_TRIM_NONE
public static final int TYPE_TRIM_LEFT
public static final int TYPE_TRIM_RIGHT
public static final int TYPE_TRIM_BOTH
public static final String[] type_trim_code
public static final String[] type_trim_desc
public static final String STRING_SEPARATOR
Constructor Detail |
---|
public ExcelInputMeta()
Method Detail |
---|
public ExcelInputField[] getField()
public void setField(ExcelInputField[] fields)
fields
- The excel input fields to set.public String getFileField()
public void setFileField(String fileField)
fileField
- The fileField to set.public String[] getFileMask()
public void setFileMask(String[] fileMask)
fileMask
- The fileMask to set.public String[] getFileName()
public void setFileName(String[] fileName)
fileName
- The fileName to set.public boolean ignoreEmptyRows()
public void setIgnoreEmptyRows(boolean ignoreEmptyRows)
ignoreEmptyRows
- The ignoreEmptyRows to set.public long getRowLimit()
public void setRowLimit(long rowLimit)
rowLimit
- The rowLimit to set.public String getRowNumberField()
public void setRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField to set.public String getSheetRowNumberField()
public void setSheetRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField to set.public String getSheetField()
public void setSheetField(String sheetField)
sheetField
- The sheetField to set.public String[] getSheetName()
public void setSheetName(String[] sheetName)
sheetName
- The sheetName to set.public int[] getStartColumn()
public void setStartColumn(int[] startColumn)
startColumn
- The startColumn to set.public int[] getStartRow()
public void setStartRow(int[] startRow)
startRow
- The startRow to set.public boolean startsWithHeader()
public void setStartsWithHeader(boolean startsWithHeader)
startsWithHeader
- The startsWithHeader to set.public boolean stopOnEmpty()
public void setStopOnEmpty(boolean stopOnEmpty)
stopOnEmpty
- The stopOnEmpty to set.public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public void allocate(int nrfiles, int nrsheets, int nrfields)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
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) throws org.pentaho.di.core.exception.KettleStepException
StepMetaInterface
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- The fields that are entering the step. These are changed to reflect the output metadata.name
- The name of the step to be used as origininfo
- The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not.
Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]nextStep
- if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.space
- TODO
org.pentaho.di.core.exception.KettleStepException
- when an error occurred searching for the fields.public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, long id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, long id_transformation, long id_step) throws org.pentaho.di.core.exception.KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public static final int getTrimTypeByCode(String tt)
public static final int getTrimTypeByDesc(String tt)
public static final String getTrimTypeCode(int i)
public static final String getTrimTypeDesc(int i)
public String[] getFilePaths(org.pentaho.di.core.variables.VariableSpace space)
public org.pentaho.di.core.fileinput.FileInputList getFileList(org.pentaho.di.core.variables.VariableSpace space)
public String getLookupStepname()
public void searchInfoAndTargetSteps(List<StepMeta> steps)
searchInfoAndTargetSteps
in interface StepMetaInterface
searchInfoAndTargetSteps
in class BaseStepMeta
steps
- optionally search the info step in a list of stepspublic String[] getInfoSteps()
getInfoSteps
in interface StepMetaInterface
getInfoSteps
in class BaseStepMeta
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)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic org.pentaho.di.core.row.RowMetaInterface getEmptyFields()
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public String getWarningFilesDestinationDirectory()
public void setWarningFilesDestinationDirectory(String badLineFilesDestinationDirectory)
public String getBadLineFilesExtension()
public void setBadLineFilesExtension(String badLineFilesExtension)
public boolean isErrorIgnored()
public void setErrorIgnored(boolean errorIgnored)
public String getErrorFilesDestinationDirectory()
public void setErrorFilesDestinationDirectory(String errorLineFilesDestinationDirectory)
public String getErrorFilesExtension()
public void setErrorFilesExtension(String errorLineFilesExtension)
public String getLineNumberFilesDestinationDirectory()
public void setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)
public String getLineNumberFilesExtension()
public void setLineNumberFilesExtension(String lineNumberFilesExtension)
public boolean isErrorLineSkipped()
public void setErrorLineSkipped(boolean errorLineSkipped)
public boolean isStrictTypes()
public void setStrictTypes(boolean strictTypes)
public String[] getFileRequired()
public void setFileRequired(String[] fileRequired)
public String getAcceptingField()
public void setAcceptingField(String acceptingField)
acceptingField
- The acceptingField to set.public boolean isAcceptingFilenames()
public void setAcceptingFilenames(boolean acceptingFilenames)
acceptingFilenames
- The acceptingFilenames to set.public StepMeta getAcceptingStep()
public void setAcceptingStep(StepMeta acceptingStep)
acceptingStep
- The acceptingStep to set.public String getAcceptingStepName()
public void setAcceptingStepName(String acceptingStepName)
acceptingStepName
- The acceptingStepName to set.public String[] getUsedLibraries()
getUsedLibraries
in interface StepMetaInterface
getUsedLibraries
in class BaseStepMeta
public String getEncoding()
public void setEncoding(String encoding)
encoding
- the encoding to setpublic void setAddResultFile(boolean isaddresult)
isaddresult
- The isaddresult to set.public boolean isAddResultFile()
public boolean readAllSheets()
public String exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws org.pentaho.di.core.exception.KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- the variable space to userepository
- The repository to optionally load other resources from (to be converted to XML)
org.pentaho.di.core.exception.KettleException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |