Class DataGridMeta
- java.lang.Object
-
- org.pentaho.di.trans.step.BaseStepMeta
-
- org.pentaho.di.trans.steps.datagrid.DataGridMeta
-
- All Implemented Interfaces:
Cloneable
,StepAttributesInterface
,StepMetaInterface
public class DataGridMeta extends BaseStepMeta implements StepMetaInterface
-
-
Field Summary
Fields Modifier and Type Field Description static String
FIELD
static String
FIELD_NAME
static String
FIELD_NULL_IF
static String
SPACES_XML
-
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE
-
-
Constructor Summary
Constructors Constructor Description DataGridMeta()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
allocate(int nrfields)
Object
clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc.String[]
getCurrency()
List<List<String>>
getDataLines()
String[]
getDecimal()
String[]
getFieldFormat()
int[]
getFieldLength()
String[]
getFieldName()
String[]
getFieldNullIf()
String
getFieldNullIf(String fieldName)
int[]
getFieldPrecision()
void
getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, 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[]
getFieldType()
String[]
getGroup()
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.StepMetaInjectionInterface
getStepMetaInjectionInterface()
String
getXML()
Produces the XML string that describes this step's information.boolean[]
isSetEmptyString()
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 Nodevoid
readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idStep, List<org.pentaho.di.core.database.DatabaseMeta> databases)
Read the steps information from a Kettle repositoryvoid
saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idTransformation, org.pentaho.di.repository.ObjectId idStep)
Save the steps data into a Kettle repositoryvoid
setCurrency(String[] currency)
void
setDataLines(List<List<String>> dataLines)
void
setDecimal(String[] decimal)
void
setDefault()
Set default valuesvoid
setEmptyString(boolean[] setEmptyString)
void
setFieldFormat(String[] fieldFormat)
void
setFieldLength(int[] fieldLength)
void
setFieldName(String[] fieldName)
void
setFieldNullIf(String[] fieldNullIf)
void
setFieldPrecision(int[] fieldPrecision)
void
setFieldType(String[] fieldType)
void
setGroup(String[] group)
-
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta, supportsErrorHandling
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling
-
-
-
-
Field Detail
-
SPACES_XML
public static final String SPACES_XML
- See Also:
- Constant Field Values
-
FIELD_NAME
public static final String FIELD_NAME
- See Also:
- Constant Field Values
-
FIELD_NULL_IF
public static final String FIELD_NULL_IF
- See Also:
- Constant Field Values
-
FIELD
public static final String FIELD
- See Also:
- Constant Field Values
-
-
Method Detail
-
isSetEmptyString
public boolean[] isSetEmptyString()
- Returns:
- the setEmptyString
-
setEmptyString
public void setEmptyString(boolean[] setEmptyString)
- Parameters:
setEmptyString
- the setEmptyString to set
-
getCurrency
public String[] getCurrency()
- Returns:
- Returns the currency.
-
setCurrency
public void setCurrency(String[] currency)
- Parameters:
currency
- The currency to set.
-
getDecimal
public String[] getDecimal()
- Returns:
- Returns the decimal.
-
setDecimal
public void setDecimal(String[] decimal)
- Parameters:
decimal
- The decimal to set.
-
getFieldFormat
public String[] getFieldFormat()
- Returns:
- Returns the fieldFormat.
-
setFieldFormat
public void setFieldFormat(String[] fieldFormat)
- Parameters:
fieldFormat
- The fieldFormat to set.
-
getFieldLength
public int[] getFieldLength()
- Returns:
- Returns the fieldLength.
-
setFieldLength
public void setFieldLength(int[] fieldLength)
- Parameters:
fieldLength
- The fieldLength to set.
-
getFieldName
public String[] getFieldName()
- Returns:
- Returns the fieldName.
-
setFieldName
public void setFieldName(String[] fieldName)
- Parameters:
fieldName
- The fieldName to set.
-
getFieldPrecision
public int[] getFieldPrecision()
- Returns:
- Returns the fieldPrecision.
-
setFieldPrecision
public void setFieldPrecision(int[] fieldPrecision)
- Parameters:
fieldPrecision
- The fieldPrecision to set.
-
getFieldType
public String[] getFieldType()
- Returns:
- Returns the fieldType.
-
setFieldType
public void setFieldType(String[] fieldType)
- Parameters:
fieldType
- The fieldType to set.
-
getGroup
public String[] getGroup()
- Returns:
- Returns the group.
-
setGroup
public void setGroup(String[] group)
- Parameters:
group
- The group to set.
-
getFieldNullIf
public String[] getFieldNullIf()
- Returns:
- The values indicating that a string field should be treated as null
-
setFieldNullIf
public void setFieldNullIf(String[] fieldNullIf)
- Parameters:
fieldNullIf
- The values to use indicating that a string field is null
-
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 interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseStepMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata from- Throws:
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)
-
allocate
public void allocate(int nrfields)
-
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 interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
setDefault
public void setDefault()
Description copied from interface:StepMetaInterface
Set default values- Specified by:
setDefault
in interfaceStepMetaInterface
-
getFields
public void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, 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 interfaceStepMetaInterface
- Overrides:
getFields
in classBaseStepMeta
- Parameters:
rowMeta
- the input row meta that is modified in this method to reflect the output row metadata of the stepname
- Name of the step to use as input for the origin field in the valuesinfo
- Fields used as extra lookup informationnextStep
- the next step that is targetedspace
- the space The variable space to use to replace variablesrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- 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
-
getFieldNullIf
public String getFieldNullIf(String fieldName) throws org.pentaho.di.core.exception.KettleException
- Throws:
org.pentaho.di.core.exception.KettleException
-
getXML
public String getXML()
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseStepMeta
- 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 idStep, 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 interfaceStepMetaInterface
- Overrides:
readRep
in classBaseStepMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromidStep
- The step IDdatabases
- 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 idTransformation, org.pentaho.di.repository.ObjectId idStep) throws org.pentaho.di.core.exception.KettleException
Description copied from interface:StepMetaInterface
Save the steps data into a Kettle repository- Specified by:
saveRep
in interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseStepMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toidTransformation
- The transformation IDidStep
- The step ID- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
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 interfaceStepMetaInterface
- Parameters:
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 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 interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
getStepMetaInjectionInterface
public StepMetaInjectionInterface getStepMetaInjectionInterface()
- Specified by:
getStepMetaInjectionInterface
in interfaceStepMetaInterface
- Overrides:
getStepMetaInjectionInterface
in classBaseStepMeta
- 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.
-
-