|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.accessinput.AccessInputMeta
public class AccessInputMeta
Field Summary | |
---|---|
static String |
PREFIX_SYSTEM
Prefix that flags system tables |
static String[] |
RequiredFilesCode
|
static String[] |
RequiredFilesDesc
|
static String[] |
type_trim_code
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
AccessInputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfiles,
int nrfields)
|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepMeta,
RowMetaInterface prev,
String[] input,
String[] output,
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(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 |
getDynamicFilenameField()
|
String[] |
getExludeFileMask()
|
String |
getExtensionField()
|
void |
getFields(RowMetaInterface r,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String[] |
getFileMask()
|
String[] |
getFileName()
|
static String |
getFilename(org.apache.commons.vfs.FileObject fileObject)
|
String |
getFilenameField()
|
String[] |
getFileRequired()
|
FileInputList |
getFiles(VariableSpace space)
|
String[] |
getIncludeSubFolders()
|
AccessInputField[] |
getInputFields()
|
String |
getLastModificationDateField()
|
String |
getPathField()
|
String |
getRequiredFilesCode(String tt)
|
String |
getRequiredFilesDesc(String tt)
|
String |
getRootUriField()
|
long |
getRowLimit()
|
String |
getRowNumberField()
|
String |
getShortFileNameField()
|
String |
getSizeField()
|
StepInterface |
getStep(StepMeta stepMeta,
StepDataInterface stepDataInterface,
int cnr,
TransMeta tr,
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 |
getTableName()
|
String |
gettablenameField()
|
static int |
getTrimTypeByCode(String tt)
|
String |
getUriField()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
includeFilename()
|
boolean |
includeRowNumber()
|
boolean |
includeTablename()
|
boolean |
isAddResultFile()
|
boolean |
isFileField()
|
String |
isHiddenField()
|
void |
loadXML(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Load the values for this step from an XML Node |
void |
readRep(Repository rep,
ObjectId id_step,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Read the steps information from a Kettle repository |
boolean |
resetRowNumber()
|
void |
saveRep(Repository rep,
ObjectId id_transformation,
ObjectId id_step)
Save the steps data into a Kettle repository |
void |
setAddResultFile(boolean isaddresult)
|
void |
setDefault()
Set default values |
void |
setDynamicFilenameField(String dynamicFilenameField)
|
void |
setExcludeFileMask(String[] excludeFileMask)
|
void |
setExtensionField(String field)
|
void |
setFileField(boolean filefield)
|
void |
setFileMask(String[] fileMask)
|
void |
setFileName(String[] fileName)
|
void |
setFilenameField(String filenameField)
|
void |
setFileRequired(String[] fileRequiredin)
|
void |
setIncludeFilename(boolean includeFilename)
|
void |
setIncludeRowNumber(boolean includeRowNumber)
|
void |
setIncludeSubFolders(String[] includeSubFoldersin)
|
void |
setIncludeTablename(boolean includeTablename)
|
void |
setInputFields(AccessInputField[] inputFields)
|
void |
setIsHiddenField(String field)
|
void |
setLastModificationDateField(String field)
|
void |
setPathField(String field)
|
void |
setResetRowNumber(boolean resetRowNumber)
|
void |
setRootUriField(String field)
|
void |
setRowLimit(long rowLimit)
|
void |
setRowNumberField(String rowNumberField)
|
void |
setShortFileNameField(String field)
|
void |
setSizeField(String field)
|
void |
setTableName(String TableName)
|
void |
setTablenameField(String tablenameField)
|
void |
setUriField(String field)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String[] RequiredFilesDesc
public static final String[] RequiredFilesCode
public static final String[] type_trim_code
public static final String PREFIX_SYSTEM
Constructor Detail |
---|
public AccessInputMeta()
Method Detail |
---|
public String getExtensionField()
public void setExtensionField(String field)
field
- The extensionFieldName to set.public String getSizeField()
public void setSizeField(String field)
field
- The sizeFieldName to set.public String getShortFileNameField()
public void setShortFileNameField(String field)
field
- The shortFileFieldName to set.public String getPathField()
public void setPathField(String field)
field
- The pathFieldName to set.public String isHiddenField()
public void setIsHiddenField(String field)
field
- The hiddenFieldName to set.public String getLastModificationDateField()
public void setLastModificationDateField(String field)
field
- The lastModificationTimeFieldName to set.public String getUriField()
public void setUriField(String field)
field
- The uriNameFieldName to set.public String getRootUriField()
public void setRootUriField(String field)
field
- The rootUriNameFieldName to set.public AccessInputField[] getInputFields()
public void setInputFields(AccessInputField[] inputFields)
inputFields
- The input fields to set.public String[] getExludeFileMask()
public void setExcludeFileMask(String[] excludeFileMask)
excludeFileMask
- The excludeFileMask to set.public String[] getFileMask()
public String[] getFileRequired()
public String getRequiredFilesDesc(String tt)
public void setFileMask(String[] fileMask)
fileMask
- The fileMask to set.public void setFileRequired(String[] fileRequiredin)
public String getRequiredFilesCode(String tt)
public String[] getIncludeSubFolders()
public void setIncludeSubFolders(String[] includeSubFoldersin)
public String[] getFileName()
public void setFileName(String[] fileName)
fileName
- The fileName to set.public String getFilenameField()
public String getDynamicFilenameField()
public void setDynamicFilenameField(String dynamicFilenameField)
dynamicFilenameField
- The dynamic filename field to set.public void setFilenameField(String filenameField)
filenameField
- The filenameField to set.public boolean includeFilename()
public boolean includeTablename()
public void setIncludeFilename(boolean includeFilename)
includeFilename
- The includeFilename to set.public void setIncludeTablename(boolean includeTablename)
includeTablename
- The includeTablename to set.public boolean includeRowNumber()
public boolean isFileField()
public void setFileField(boolean filefield)
filefield
- The filefield to set.public boolean resetRowNumber()
public void setIncludeRowNumber(boolean includeRowNumber)
includeRowNumber
- The includeRowNumber to set.public void setAddResultFile(boolean isaddresult)
isaddresult
- The isaddresult to set.public boolean isAddResultFile()
public void setResetRowNumber(boolean resetRowNumber)
resetRowNumber
- The resetRowNumber to set.public long getRowLimit()
public void setRowLimit(long rowLimit)
rowLimit
- The rowLimit to set.public String getRowNumberField()
public String gettablenameField()
public String getTableName()
public void setRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField to set.public void setTablenameField(String tablenameField)
tablenameField
- The tablenameField to set.public void setTableName(String TableName)
TableName
- The table name to set.public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws 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.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void allocate(int nrfiles, int nrfields)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
r
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exceptionpublic static final int getTrimTypeByCode(String tt)
public void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public FileInputList getFiles(VariableSpace space)
public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, 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 static String getFilename(org.apache.commons.vfs.FileObject fileObject)
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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 gettr
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
public String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- the spacedefinitions
- the definitionsresourceNamingInterface
- the resource naming interfacerepository
- the repository
KettleException
- the kettle exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |