org.pentaho.di.trans.steps.googleanalytics
Class GaInputStepMeta

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

public class GaInputStepMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static String DEFAULT_GA_APPLICATION_NAME
           
static String FIELD_DATA_SOURCE_TABLE_ID
           
static String FIELD_DATA_SOURCE_TABLE_NAME
           
static String FIELD_TYPE_CONFIDENCE_INTERVAL
           
static String FIELD_TYPE_DATA_SOURCE_FIELD
           
static String FIELD_TYPE_DATA_SOURCE_PROPERTY
           
static String FIELD_TYPE_DIMENSION
           
static String FIELD_TYPE_METRIC
           
static String GA_DATA_URL
           
static String GA_MANAGEMENT_URL
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
GaInputStepMeta()
           
 
Method Summary
 void allocate(int nrkeys)
           
 void check(List<CheckResultInterface> remarks, TransMeta transmeta, StepMeta stepinfo, 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[] getConversionMask()
           
 String getCustomSegment()
           
 String getDimensions()
           
 String getEndDate()
           
 String[] getFeedField()
           
 String[] getFeedFieldType()
           
 void getFields(RowMetaInterface r, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getFilters()
           
 String getGaApiKey()
           
 String getGaAppName()
           
 String getGaCustomTableId()
           
 String getGaEmail()
           
 String getGaPassword()
           
 String getGaProfileName()
           
 String getGaProfileTableId()
           
 String getMetrics()
           
 String[] getOutputField()
           
 int[] getOutputType()
           
 int getRowLimit()
           
 String getSegmentId()
           
 String getSegmentName()
           
 String getSort()
           
 String getStartDate()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans disp)
          Get the executing step, needed by Trans to launch a step.
 StepDataInterface getStepData()
          Get a new instance of the appropriate data class.
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isUseCustomSegment()
           
 boolean isUseCustomTableId()
           
 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 setCustomSegment(String customSegment)
           
 void setDefault()
          Set default values
 void setDimensions(String dimensions)
           
 void setEndDate(String endDate)
           
 void setFilters(String filters)
           
 void setGaApiKey(String gaApiKey)
           
 void setGaAppName(String gaAppName)
           
 void setGaCustomTableId(String gaCustomTableId)
           
 void setGaEmail(String email)
           
 void setGaPassword(String gaPassword)
           
 void setGaProfileName(String gaProfileName)
           
 void setGaProfileTableId(String gaProfile)
           
 void setMetrics(String metrics)
           
 void setRowLimit(int rowLimit)
           
 void setSegmentId(String segmentId)
           
 void setSegmentName(String segmentName)
           
 void setSort(String sort)
           
 void setStartDate(String startDate)
           
 void setUseCustomSegment(boolean useCustomSegment)
           
 void setUseCustomTableId(boolean useCustomTableId)
           
 
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

GA_MANAGEMENT_URL

public static final String GA_MANAGEMENT_URL
See Also:
Constant Field Values

GA_DATA_URL

public static final String GA_DATA_URL
See Also:
Constant Field Values

FIELD_TYPE_CONFIDENCE_INTERVAL

public static final String FIELD_TYPE_CONFIDENCE_INTERVAL
See Also:
Constant Field Values

FIELD_TYPE_DIMENSION

public static final String FIELD_TYPE_DIMENSION
See Also:
Constant Field Values

FIELD_TYPE_METRIC

public static final String FIELD_TYPE_METRIC
See Also:
Constant Field Values

FIELD_TYPE_DATA_SOURCE_PROPERTY

public static final String FIELD_TYPE_DATA_SOURCE_PROPERTY
See Also:
Constant Field Values

FIELD_TYPE_DATA_SOURCE_FIELD

public static final String FIELD_TYPE_DATA_SOURCE_FIELD
See Also:
Constant Field Values

FIELD_DATA_SOURCE_TABLE_ID

public static final String FIELD_DATA_SOURCE_TABLE_ID
See Also:
Constant Field Values

FIELD_DATA_SOURCE_TABLE_NAME

public static final String FIELD_DATA_SOURCE_TABLE_NAME
See Also:
Constant Field Values

DEFAULT_GA_APPLICATION_NAME

public static final String DEFAULT_GA_APPLICATION_NAME
See Also:
Constant Field Values
Constructor Detail

GaInputStepMeta

public GaInputStepMeta()
Method Detail

getRowLimit

public int getRowLimit()

setRowLimit

public void setRowLimit(int rowLimit)

getConversionMask

public String[] getConversionMask()

getGaAppName

public String getGaAppName()

setGaAppName

public void setGaAppName(String gaAppName)

isUseCustomTableId

public boolean isUseCustomTableId()

setUseCustomTableId

public void setUseCustomTableId(boolean useCustomTableId)

getGaCustomTableId

public String getGaCustomTableId()

setGaCustomTableId

public void setGaCustomTableId(String gaCustomTableId)

getSegmentName

public String getSegmentName()

setSegmentName

public void setSegmentName(String segmentName)

getSegmentId

public String getSegmentId()

setSegmentId

public void setSegmentId(String segmentId)

isUseCustomSegment

public boolean isUseCustomSegment()

setUseCustomSegment

public void setUseCustomSegment(boolean useCustomSegment)

getCustomSegment

public String getCustomSegment()

setCustomSegment

public void setCustomSegment(String customSegment)

getDimensions

public String getDimensions()

setDimensions

public void setDimensions(String dimensions)

getMetrics

public String getMetrics()

setMetrics

public void setMetrics(String metrics)

getFilters

public String getFilters()

setFilters

public void setFilters(String filters)

getSort

public String getSort()

setSort

public void setSort(String sort)

getStartDate

public String getStartDate()

setStartDate

public void setStartDate(String startDate)

getEndDate

public String getEndDate()

setEndDate

public void setEndDate(String endDate)

getGaEmail

public String getGaEmail()

setGaEmail

public void setGaEmail(String email)

getGaPassword

public String getGaPassword()

setGaPassword

public void setGaPassword(String gaPassword)

getGaProfileTableId

public String getGaProfileTableId()

setGaProfileTableId

public void setGaProfileTableId(String gaProfile)

getGaProfileName

public String getGaProfileName()

setGaProfileName

public void setGaProfileName(String gaProfileName)

getFeedFieldType

public String[] getFeedFieldType()

getFeedField

public String[] getFeedField()

getOutputField

public String[] getOutputField()

getOutputType

public int[] getOutputType()

getGaApiKey

public String getGaApiKey()

setGaApiKey

public void setGaApiKey(String gaApiKey)

setDefault

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

Specified by:
setDefault in interface StepMetaInterface

allocate

public void allocate(int nrkeys)

getFields

public void getFields(RowMetaInterface r,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
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

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()
              throws KettleValueException
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.
Throws:
KettleValueException - in case there is an XML conversion or encoding error

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

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 stepinfo,
                  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
stepinfo - 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 disp)
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
disp - 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.