Package org.pentaho.di.trans.steps.reservoirsampling

Class ReservoirSamplingMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.reservoirsampling.ReservoirSamplingMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class ReservoirSamplingMeta
extends BaseStepMeta
implements StepMetaInterface

Contains the meta data for the ReservoirSampling step.

Version:

1.0

Author:

Mark Hall (mhall{[at]}pentaho.org)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_randomSeed
protected String	m_sampleSize
static final String	XML_TAG

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

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor	Description
ReservoirSamplingMeta()	Creates a new ReservoirMeta instance.

Method Summary

Modifier and Type	Method	Description
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transmeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)	Checks the settings of this step and puts the findings in a remarks List.
Object	clone()	Clone this step's meta data
boolean	equals(Object obj)	Check for equality
void	getFields(org.pentaho.di.core.row.RowMetaInterface row, String origin, 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	getSampleSize()	Get the sample size to generate.
String	getSeed()	Get the random seed
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	getXML()	Return the XML describing this (configured) step
int	hashCode()
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore)	Loads the meta data for this (configured) step from XML.
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases)	Read this step's configuration from a repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step)	Save this step's meta data to a repository
void	setDefault()	Set the defaults for this step.
void	setSampleSize(String sampleS)	Set the size of the sample to generate
void	setSeed(String seed)	Set the seed value for the random number generator

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

analyseImpact, analyseImpact, cancelQueries, 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, getStepMetaInjectionInterface, 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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Field Details

XML_TAG

public static final String XML_TAG

See Also:

• Constant Field Values

m_sampleSize

protected String m_sampleSize

m_randomSeed

protected String m_randomSeed

Constructor Details

ReservoirSamplingMeta

public ReservoirSamplingMeta()

Creates a new ReservoirMeta instance.

Method Details

getSampleSize

public String getSampleSize()

Get the sample size to generate.

Returns:

the sample size

setSampleSize

public void setSampleSize(String sampleS)

Set the size of the sample to generate

Parameters:

sampleS - the size of the sample

getSeed

public String getSeed()

Get the random seed

Returns:

the random seed

setSeed

public void setSeed(String seed)

Set the seed value for the random number generator

Parameters:

seed - the seed value

getXML

public String getXML()

Return the XML describing this (configured) step

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

a String containing the XML

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class Object

Parameters:

obj - an Object to compare with

Returns:

true if equal to the supplied object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setDefault

public void setDefault()

Set the defaults for this step.

Specified by:

setDefault in interface StepMetaInterface

clone

public Object clone()

Clone this step's meta data

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

the cloned meta data

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

Loads the meta data for this (configured) step from XML.

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the step to load

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

org.pentaho.di.core.exception.KettleXMLException - if an error occurs

readRep

public void readRep(Repository rep,
 org.pentaho.metastore.api.IMetaStore metaStore,
 org.pentaho.di.repository.ObjectId id_step,
 List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException

Read this step's configuration from a repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - the repository to access

metaStore - the MetaStore to read from

id_step - the id for this step

databases - The databases to reference

Throws:

org.pentaho.di.core.exception.KettleException - if an error occurs

saveRep

public void saveRep(Repository rep,
 org.pentaho.metastore.api.IMetaStore metaStore,
 org.pentaho.di.repository.ObjectId id_transformation,
 org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException

Save this step's meta data to a repository

Specified by:

saveRep in interface StepMetaInterface

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - the repository to save to

id_transformation - transformation id

id_step - step id

metaStore - the metaStore to optionally write to

Throws:

org.pentaho.di.core.exception.KettleException - if an error occurs

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface row,
 String origin,
 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 interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

row - the input row meta that is modified in this method to reflect the output row metadata of the step

origin - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

repository - the repository to use to load Kettle metadata objects impacting the output fields

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

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
 TransMeta transmeta,
 StepMeta stepMeta,
 org.pentaho.di.core.row.RowMetaInterface prev,
 String[] input,
 String[] output,
 org.pentaho.di.core.row.RowMetaInterface info,
 org.pentaho.di.core.variables.VariableSpace space,
 Repository repository,
 org.pentaho.metastore.api.IMetaStore metaStore)

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

Overrides:

check in class BaseStepMeta

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

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

getStep

public StepInterface getStep(StepMeta stepMeta,
 StepDataInterface stepDataInterface,
 int cnr,
 TransMeta tr,
 Trans trans)

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 number to get.

tr - the transformation info.

trans - the launching transformation

Returns:

a StepInterface value

getStepData

public StepDataInterface getStepData()

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:

a StepDataInterface value