org.pentaho.di.trans.steps.accessinput

Class AccessInputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.accessinput.AccessInputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class AccessInputMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
AccessInputMeta()

Method Summary

Methods

Modifier and Type	Method and Description
void	allocate(int nrfiles, int nrfields)
void	allocateFields(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	getDynamicFilenameField()
String[]	getExludeFileMask()
String	getExtensionField()
void	getFields(org.pentaho.di.core.row.RowMetaInterface r, 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[]	getFileMask()
String[]	getFileName()
static String	getFilename(org.apache.commons.vfs.FileObject fileObject)
String	getFilenameField()
String[]	getFileRequired()
org.pentaho.di.core.fileinput.FileInputList	getFiles(org.pentaho.di.core.variables.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.
StepMetaInjectionInterface	getStepMetaInjectionInterface()
String	getTableName()
String	gettablenameField()
static int	getTrimTypeByCode(String tt)
String	getUriField()
static org.pentaho.di.core.row.ValueMetaInterface	getValueMeta(com.healthmarketscience.jackcess.Column c) Returns kettle type from Microsoft Access database
static org.pentaho.di.core.row.ValueMetaAndData	getValueMetaAndData(com.healthmarketscience.jackcess.Column c, String name, Object data) Returns kettle type from Microsoft Access database also convert data to prepare kettle value
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<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
boolean	resetRowNumber()
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	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 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, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, 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, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta

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, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta

Field Detail

RequiredFilesDesc

public static final String[] RequiredFilesDesc

RequiredFilesCode

public static final String[] RequiredFilesCode

type_trim_code

public static final String[] type_trim_code

PREFIX_SYSTEM

public static final String PREFIX_SYSTEM

Prefix that flags system tables

See Also:

Constant Field Values

Constructor Detail

AccessInputMeta

public AccessInputMeta()

Method Detail

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.

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.

getInputFields

public AccessInputField[] getInputFields()

Returns:

Returns the input fields.

setInputFields

public void setInputFields(AccessInputField[] inputFields)

Parameters:

inputFields - The input fields to set.

getExludeFileMask

public String[] getExludeFileMask()

Returns:

Returns the excludeFileMask.

setExcludeFileMask

public void setExcludeFileMask(String[] excludeFileMask)

Parameters:

excludeFileMask - The excludeFileMask to set.

getFileMask

public String[] getFileMask()

Returns:

Returns the fileMask.

getFileRequired

public String[] getFileRequired()

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

setFileMask

public void setFileMask(String[] fileMask)

Parameters:

fileMask - The fileMask to set.

setFileRequired

public void setFileRequired(String[] fileRequiredin)

getRequiredFilesCode

public String getRequiredFilesCode(String tt)

getIncludeSubFolders

public String[] getIncludeSubFolders()

setIncludeSubFolders

public void setIncludeSubFolders(String[] includeSubFoldersin)

getFileName

public String[] getFileName()

Returns:

Returns the fileName.

setFileName

public void setFileName(String[] fileName)

Parameters:

fileName - The fileName to set.

getFilenameField

public String getFilenameField()

Returns:

Returns the filenameField.

getDynamicFilenameField

public String getDynamicFilenameField()

Returns:

Returns the dynamic filename field (from previous steps)

setDynamicFilenameField

public void setDynamicFilenameField(String dynamicFilenameField)

Parameters:

dynamicFilenameField - The dynamic filename field to set.

setFilenameField

public void setFilenameField(String filenameField)

Parameters:

filenameField - The filenameField to set.

includeFilename

public boolean includeFilename()

Returns:

Returns the includeFilename.

includeTablename

public boolean includeTablename()

Returns:

Returns the includeTablename.

setIncludeFilename

public void setIncludeFilename(boolean includeFilename)

Parameters:

includeFilename - The includeFilename to set.

setIncludeTablename

public void setIncludeTablename(boolean includeTablename)

Parameters:

includeTablename - The includeTablename to set.

includeRowNumber

public boolean includeRowNumber()

Returns:

Returns the includeRowNumber.

isFileField

public boolean isFileField()

Returns:

Returns the File field.

setFileField

public void setFileField(boolean filefield)

Parameters:

filefield - The filefield to set.

resetRowNumber

public boolean resetRowNumber()

Returns:

Returns the resetRowNumber.

setIncludeRowNumber

public void setIncludeRowNumber(boolean includeRowNumber)

Parameters:

includeRowNumber - The includeRowNumber to set.

setAddResultFile

public void setAddResultFile(boolean isaddresult)

Parameters:

isaddresult - The isaddresult to set.

isAddResultFile

public boolean isAddResultFile()

Returns:

Returns isaddresult.

setResetRowNumber

public void setResetRowNumber(boolean resetRowNumber)

Parameters:

resetRowNumber - The resetRowNumber 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.

gettablenameField

public String gettablenameField()

Returns:

Returns the tablenameField.

getTableName

public String getTableName()

Returns:

Returns the TableName.

setRowNumberField

public void setRowNumberField(String rowNumberField)

Parameters:

rowNumberField - The rowNumberField to set.

setTablenameField

public void setTablenameField(String tablenameField)

Parameters:

tablenameField - The tablenameField to set.

setTableName

public void setTableName(String TableName)

Parameters:

TableName - The table name 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

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.

allocate

public void allocate(int nrfiles,
            int nrfields)

allocateFiles

public void allocateFiles(int nrfiles)

allocateFields

public void allocateFields(int nrfields)

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 r,
             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:

r - 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

getTrimTypeByCode

public static final int getTrimTypeByCode(String tt)

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)

getFiles

public org.pentaho.di.core.fileinput.FileInputList getFiles(org.pentaho.di.core.variables.VariableSpace space)

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

getFilename

public static String getFilename(org.apache.commons.vfs.FileObject fileObject)

getStep

public StepInterface getStep(StepMeta stepMeta,
                    StepDataInterface stepDataInterface,
                    int cnr,
                    TransMeta tr,
                    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

tr - 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.

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

getValueMeta

public static org.pentaho.di.core.row.ValueMetaInterface getValueMeta(com.healthmarketscience.jackcess.Column c)

Returns kettle type from Microsoft Access database

Parameters:

: - MS Access column

Returns:

valuemeta

getValueMetaAndData

public static org.pentaho.di.core.row.ValueMetaAndData getValueMetaAndData(com.healthmarketscience.jackcess.Column c,
                                                           String name,
                                                           Object data)

Returns kettle type from Microsoft Access database also convert data to prepare kettle value

Parameters:

: - MS Access column

: - destination field name

: - MS Access column value

Returns:

valuemeta and data

getStepMetaInjectionInterface

public StepMetaInjectionInterface getStepMetaInjectionInterface()

Specified by:

getStepMetaInjectionInterface in interface StepMetaInterface

Overrides:

getStepMetaInjectionInterface in class BaseStepMeta

Returns:

Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.