org.pentaho.di.trans.steps.ldifinput
Class LDIFInputMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.ldifinput.LDIFInputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class LDIFInputMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

static String[]	RequiredFilesCode
static String[]	RequiredFilesDesc

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

LDIFInputMeta()

Method Summary

boolean	AddToResultFilename()
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	getContentTypeField()
String	getDNField()
String	getDynamicFilenameField()
String[]	getExludeFileMask()
String	getExtensionField()
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String[]	getFileMask()
String[]	getFileName()
String	getFilenameField()
String[]	getFileRequired()
FileInputList	getFiles(VariableSpace space)
String[]	getIncludeSubFolders()
LDIFInputField[]	getInputFields()
String	getLastModificationDateField()
String	getMultiValuedSeparator()
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	getUriField()
String	getXML() Produces the XML string that describes this step's information.
boolean	includeContentType()
boolean	IncludeDN()
boolean	includeFilename()
boolean	includeRowNumber()
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
void	saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	setAddToResultFilename(boolean addtoresultfilename)
void	setContentTypeField(String contentTypeField)
void	setDefault() Set default values
void	setDNField(String DNField)
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	setIncludeContentType(boolean includeContentType)
void	setIncludeDN(boolean includeDN)
void	setIncludeFilename(boolean includeFilename)
void	setIncludeRowNumber(boolean includeRowNumber)
void	setIncludeSubFolders(String[] includeSubFoldersin)
void	setInputFields(LDIFInputField[] inputFields)
void	setIsHiddenField(String field)
void	setLastModificationDateField(String field)
void	setMultiValuedSeparator(String multiValuedSeparator)
void	setPathField(String field)
void	setRootUriField(String field)
void	setRowLimit(long rowLimit)
void	setRowNumberField(String rowNumberField)
void	setShortFileNameField(String field)
void	setSizeField(String field)
void	setUriField(String field)
boolean	supportsErrorHandling()

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

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, 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, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta

Field Detail

RequiredFilesDesc

public static final String[] RequiredFilesDesc

RequiredFilesCode

public static final String[] RequiredFilesCode

Constructor Detail

LDIFInputMeta

public LDIFInputMeta()

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.

getExludeFileMask

public String[] getExludeFileMask()

Returns:

Returns the excludeFileMask.

setExcludeFileMask

public void setExcludeFileMask(String[] excludeFileMask)

Parameters:

excludeFileMask - The excludeFileMask to set.

getInputFields

public LDIFInputField[] getInputFields()

Returns:

Returns the input fields.

setInputFields

public void setInputFields(LDIFInputField[] inputFields)

Parameters:

inputFields - The input fields to set.

getFileMask

public String[] getFileMask()

Returns:

Returns the fileMask.

setFileMask

public void setFileMask(String[] fileMask)

Parameters:

fileMask - The fileMask to set.

getFileRequired

public String[] getFileRequired()

setFileRequired

public void setFileRequired(String[] fileRequiredin)

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.

setFileField

public void setFileField(boolean filefield)

Parameters:

filefield - The filefield to set.

isFileField

public boolean isFileField()

Returns:

Returns the File field.

includeFilename

public boolean includeFilename()

Returns:

Returns the includeFilename.

setIncludeFilename

public void setIncludeFilename(boolean includeFilename)

Parameters:

includeFilename - The includeFilename to set.

includeRowNumber

public boolean includeRowNumber()

Returns:

Returns the includeRowNumber.

setIncludeRowNumber

public void setIncludeRowNumber(boolean includeRowNumber)

Parameters:

includeRowNumber - The includeRowNumber to set.

includeContentType

public boolean includeContentType()

Returns:

Returns the includeContentType.

setIncludeContentType

public void setIncludeContentType(boolean includeContentType)

Parameters:

includeRowNumber - The includeRowNumber to set.

setIncludeDN

public void setIncludeDN(boolean includeDN)

Parameters:

includeDN - The includeDN to set.

IncludeDN

public boolean IncludeDN()

Returns:

Returns the includeDN.

setMultiValuedSeparator

public void setMultiValuedSeparator(String multiValuedSeparator)

Parameters:

multiValuedSeparator - The multi-valued separator filed.

getMultiValuedSeparator

public String getMultiValuedSeparator()

Returns:

Returns the multi valued separator.

setAddToResultFilename

public void setAddToResultFilename(boolean addtoresultfilename)

Parameters:

addtoresultfilename - The addtoresultfilename to set.

AddToResultFilename

public boolean AddToResultFilename()

Returns:

Returns the addtoresultfilename.

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.

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.

getContentTypeField

public String getContentTypeField()

Returns:

Returns the contentTypeField.

setContentTypeField

public void setContentTypeField(String contentTypeField)

Parameters:

contentTypeField - The contentTypeField to set.

getDNField

public String getDNField()

Returns:

Returns the DNField.

setDNField

public void setDNField(String DNField)

Parameters:

DNField - The DNField to set.

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

counters - Counters to reference.

Throws:

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)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

Description copied from interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

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

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

Throws:

KettleStepException - when an error occurred searching for the fields.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Parameters:

rep - The repository to read from

id_step - The step ID

databases - The databases to reference

counters - The counters to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Parameters:

rep - The Kettle repository to save to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

getFiles

public FileInputList getFiles(VariableSpace space)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)

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

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

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.

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

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(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository)
                       throws KettleException

Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. So what this does is turn the name of files into absolute paths OR it simply includes the resource in the ZIP file. For now, we'll simply turn it into an absolute path and pray that the file is on a shared drive or something like that. TODO: create options to configure this behavior

Specified by:

exportResources in interface StepMetaInterface

Overrides:

exportResources in class BaseStepMeta

Parameters:

space - the variable space to use

repository - The repository to optionally load other resources from (to be converted to XML)

Returns:

the filename of the exported resource

Throws:

KettleException