Package org.pentaho.di.core.util

Class AbstractStepMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.core.util.AbstractStepMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public abstract class AbstractStepMeta
extends BaseStepMeta
implements StepMetaInterface

Author:

Michael Gugerell(asc145)

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractStepMeta()	Default constructor.

Method Summary

Modifier and Type	Method	Description
StringPluginProperty	getConnectionName()
org.pentaho.di.core.database.DatabaseMeta	getDbMeta()
KeyValueSet	getProperties()
PluginPropertyFactory	getPropertyFactory()
StepDataInterface	getStepData()	Get a new instance of the appropriate data class.
String	getXML()	Produces the XML string that describes this step's information.
void	loadXML(Node node, List<org.pentaho.di.core.database.DatabaseMeta> databaseMeta, org.pentaho.metastore.api.IMetaStore metaStore)	Load the values for this step from an XML Node
void	readFromPreferences()	Read properties from preferences.
void	readRep(Repository repo, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId stepId, List<org.pentaho.di.core.database.DatabaseMeta> databaseList)	Read the steps information from a Kettle repository
void	saveAsPreferences()	Saves properties to preferences.
void	saveRep(Repository repo, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId transformationId, org.pentaho.di.repository.ObjectId stepId)	Save the steps data into a Kettle repository
void	setConnectionName(StringPluginProperty connectionName)
void	setDbMeta(org.pentaho.di.core.database.DatabaseMeta dbMeta)

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

analyseImpact, analyseImpact, cancelQueries, check, check, check, clone, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, 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

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, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStep, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setDefault, setParentStepMeta, supportsErrorHandling

Constructor Detail

AbstractStepMeta

public AbstractStepMeta()

Default constructor.

Method Detail

getPropertyFactory

public PluginPropertyFactory getPropertyFactory()

Returns:

the propertyFactory

getProperties

public KeyValueSet getProperties()

Returns:

the properties

saveAsPreferences

public void saveAsPreferences()
                       throws BackingStoreException

Saves properties to preferences.

Throws:

BackingStoreException - ...

readFromPreferences

public void readFromPreferences()

Read properties from preferences.

loadXML

public void loadXML(Node node,
                    List<org.pentaho.di.core.database.DatabaseMeta> databaseMeta,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

node - the Node to get the info from

databaseMeta - 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 - When an unexpected XML error occurred. (malformed etc.)

See Also:

StepMetaInterface.loadXML(org.w3c.dom.Node, java.util.List, java.util.Map)

getXML

public String getXML()
              throws org.pentaho.di.core.exception.KettleException

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:

org.pentaho.di.core.exception.KettleException - in case there is an XML conversion or encoding error

See Also:

BaseStepMeta.getXML()

readRep

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

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

repo - The repository to read from

metaStore - The MetaStore to read external information from

stepId - The step ID

databaseList - The databases to reference

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

See Also:

org.pentaho.di.trans.step.StepMetaInterface#readRep(org.pentaho.di.repository.Repository, long, java.util.List, java.util.Map)

saveRep

public void saveRep(Repository repo,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId transformationId,
                    org.pentaho.di.repository.ObjectId stepId)
             throws org.pentaho.di.core.exception.KettleException

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Overrides:

saveRep in class BaseStepMeta

Parameters:

repo - The Kettle repository to save to

metaStore - the metaStore to optionally write to

transformationId - The transformation ID

stepId - The step ID

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

See Also:

org.pentaho.di.trans.step.StepMetaInterface#saveRep(org.pentaho.di.repository.Repository, long, long)

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:

The appropriate StepDataInterface class.

See Also:

StepMetaInterface.getStepData()

getConnectionName

public StringPluginProperty getConnectionName()

Returns:

the connectionName

setConnectionName

public void setConnectionName(StringPluginProperty connectionName)

Parameters:

connectionName - the connectionName to set

getDbMeta

public org.pentaho.di.core.database.DatabaseMeta getDbMeta()

Returns:

the dbMeta

setDbMeta

public void setDbMeta(org.pentaho.di.core.database.DatabaseMeta dbMeta)

Parameters:

dbMeta - the dbMeta to set