org.pentaho.di.trans.steps.aggregaterows
Class AggregateRowsMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.aggregaterows.AggregateRowsMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class AggregateRowsMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static String[] aggregateTypeDesc
           
static int TYPE_AGGREGATE_AVERAGE
           
static int TYPE_AGGREGATE_COUNT
           
static int TYPE_AGGREGATE_FIRST
           
static int TYPE_AGGREGATE_FIRST_NULL
           
static int TYPE_AGGREGATE_LAST
           
static int TYPE_AGGREGATE_LAST_NULL
           
static int TYPE_AGGREGATE_MAX
           
static int TYPE_AGGREGATE_MIN
           
static int TYPE_AGGREGATE_NONE
           
static int TYPE_AGGREGATE_SUM
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
AggregateRowsMeta()
           
 
Method Summary
 void allocate(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.
 int[] getAggregateType()
           
 String[] getFieldName()
           
 String[] getFieldNewName()
           
 void getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 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 getType(String at)
           
static String getTypeDesc(int t)
           
 String getXML()
          Produces the XML string that describes this step's information.
 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 setAggregateType(int[] aggregateType)
           
 void setDefault()
          Set default values
 void setFieldName(String[] fieldName)
           
 void setFieldNewName(String[] fieldNewName)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, 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, 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, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Field Detail

TYPE_AGGREGATE_NONE

public static final int TYPE_AGGREGATE_NONE
See Also:
Constant Field Values

TYPE_AGGREGATE_SUM

public static final int TYPE_AGGREGATE_SUM
See Also:
Constant Field Values

TYPE_AGGREGATE_AVERAGE

public static final int TYPE_AGGREGATE_AVERAGE
See Also:
Constant Field Values

TYPE_AGGREGATE_COUNT

public static final int TYPE_AGGREGATE_COUNT
See Also:
Constant Field Values

TYPE_AGGREGATE_MIN

public static final int TYPE_AGGREGATE_MIN
See Also:
Constant Field Values

TYPE_AGGREGATE_MAX

public static final int TYPE_AGGREGATE_MAX
See Also:
Constant Field Values

TYPE_AGGREGATE_FIRST

public static final int TYPE_AGGREGATE_FIRST
See Also:
Constant Field Values

TYPE_AGGREGATE_LAST

public static final int TYPE_AGGREGATE_LAST
See Also:
Constant Field Values

TYPE_AGGREGATE_FIRST_NULL

public static final int TYPE_AGGREGATE_FIRST_NULL
See Also:
Constant Field Values

TYPE_AGGREGATE_LAST_NULL

public static final int TYPE_AGGREGATE_LAST_NULL
See Also:
Constant Field Values

aggregateTypeDesc

public static final String[] aggregateTypeDesc
Constructor Detail

AggregateRowsMeta

public AggregateRowsMeta()
Method Detail

getAggregateType

public int[] getAggregateType()
Returns:
Returns the aggregateType.

setAggregateType

public void setAggregateType(int[] aggregateType)
Parameters:
aggregateType - The aggregateType to set.

getFieldName

public String[] getFieldName()
Returns:
Returns the fieldName.

setFieldName

public void setFieldName(String[] fieldName)
Parameters:
fieldName - The fieldName to set.

getFieldNewName

public String[] getFieldNewName()
Returns:
Returns the fieldNewName.

setFieldNewName

public void setFieldNewName(String[] fieldNewName)
Parameters:
fieldNewName - The fieldNewName 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.)

allocate

public void allocate(int nrfields)

getTypeDesc

public static final String getTypeDesc(int t)

getType

public static final int getType(String at)

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

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface row,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from class: BaseStepMeta
Gets the fields.

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
row - the input row meta
name - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

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.

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)

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

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