org.pentaho.di.trans.steps.analyticquery
Class AnalyticQueryMeta

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

public class AnalyticQueryMeta
extends BaseStepMeta
implements StepMetaInterface

Since:
27-jan-2009
Author:
ngoodman

Field Summary
static int TYPE_FUNCT_LAG
           
static int TYPE_FUNCT_LEAD
           
static String[] typeGroupCode
           
static String[] typeGroupLongDesc
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
AnalyticQueryMeta()
          END arrays are one for each configured analytic function
 
Method Summary
 void allocate(int sizegroup, 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[] getAggregateField()
           
 int[] getAggregateType()
           
 void getFields(RowMetaInterface r, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String[] getGroupField()
           
 int getNumberOfFields()
           
 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.
 String[] getSubjectField()
           
 TransMeta.TransformationType[] getSupportedTransformationTypes()
           
static int getType(String desc)
           
static String getTypeDesc(int i)
           
static String getTypeDescLong(int i)
           
 int[] getValueField()
           
 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 setAggregateField(String[] aggregateField)
           
 void setAggregateType(int[] aggregateType)
           
 void setDefault()
          Set default values
 void setGroupField(String[] groupField)
           
 void setNumberOfFields(int number_of_fields)
           
 void setSubjectField(String[] subjectField)
           
 void setValueField(int[] valueField)
           
 
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, 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, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Field Detail

TYPE_FUNCT_LEAD

public static final int TYPE_FUNCT_LEAD
See Also:
Constant Field Values

TYPE_FUNCT_LAG

public static final int TYPE_FUNCT_LAG
See Also:
Constant Field Values

typeGroupCode

public static final String[] typeGroupCode

typeGroupLongDesc

public static final String[] typeGroupLongDesc
Constructor Detail

AnalyticQueryMeta

public AnalyticQueryMeta()
END arrays are one for each configured analytic function

Method Detail

getAggregateField

public String[] getAggregateField()
Returns:
Returns the aggregateField.

setAggregateField

public void setAggregateField(String[] aggregateField)
Parameters:
aggregateField - The aggregateField to set.

getAggregateType

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

setAggregateType

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

getGroupField

public String[] getGroupField()
Returns:
Returns the groupField.

setGroupField

public void setGroupField(String[] groupField)
Parameters:
groupField - The groupField to set.

getSubjectField

public String[] getSubjectField()
Returns:
Returns the subjectField.

setSubjectField

public void setSubjectField(String[] subjectField)
Parameters:
subjectField - The subjectField to set.

getValueField

public int[] getValueField()
Returns:
Returns the valueField.

setValueField

public void setValueField(int[] valueField)
Parameters:
The - valueField 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 sizegroup,
                     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 interface StepMetaInterface
Overrides:
clone in class BaseStepMeta
Returns:
an exact copy of this step

getType

public static final int getType(String desc)

getTypeDesc

public static final String getTypeDesc(int i)

getTypeDescLong

public static final String getTypeDescLong(int i)

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 origin,
                      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:
r - the input row meta
origin - 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.

getNumberOfFields

public int getNumberOfFields()

setNumberOfFields

public void setNumberOfFields(int number_of_fields)

getSupportedTransformationTypes

public TransMeta.TransformationType[] getSupportedTransformationTypes()
Specified by:
getSupportedTransformationTypes in interface StepMetaInterface
Overrides:
getSupportedTransformationTypes in class BaseStepMeta
Returns:
The supported transformation types that this step supports.