org.pentaho.di.core.util
Class AbstractStepMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.core.util.AbstractStepMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface
Direct Known Subclasses:
TeraFastMeta

public abstract class AbstractStepMeta
extends BaseStepMeta
implements StepMetaInterface

Author:
Michael Gugerell(asc145)

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
AbstractStepMeta()
          Default constructor.
 
Method Summary
 StringPluginProperty getConnectionName()
           
 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<DatabaseMeta> databaseMeta, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 void readFromPreferences()
          Read properties from preferences.
 void readRep(Repository repo, ObjectId stepId, List<DatabaseMeta> databaseList, Map<String,Counter> counters)
          Read the steps information from a Kettle repository
 void saveAsPreferences()
          Saves properties to preferences.
 void saveRep(Repository repo, ObjectId transformationId, ObjectId stepId)
          Save the steps data into a Kettle repository
 void setConnectionName(StringPluginProperty connectionName)
           
 void setDbMeta(DatabaseMeta dbMeta)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getFields, 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, check, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStep, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, 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<DatabaseMeta> databaseMeta,
                    Map<String,Counter> counters)
             throws KettleXMLException
Load the values for this step from an XML Node

Specified by:
loadXML in interface StepMetaInterface
Parameters:
node - the Node to get the info from
databaseMeta - The available list of databases to reference to
counters - Counters to reference.
Throws:
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 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:
KettleException - in case there is a conversion or XML encoding error
See Also:
BaseStepMeta.getXML()

readRep

public void readRep(Repository repo,
                    ObjectId stepId,
                    List<DatabaseMeta> databaseList,
                    Map<String,Counter> counters)
             throws KettleException
Read the steps information from a Kettle repository

Specified by:
readRep in interface StepMetaInterface
Parameters:
repo - The repository to read from
stepId - The step ID
databaseList - The databases to reference
counters - The counters to reference
Throws:
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,
                    ObjectId transformationId,
                    ObjectId stepId)
             throws KettleException
Save the steps data into a Kettle repository

Specified by:
saveRep in interface StepMetaInterface
Parameters:
repo - The Kettle repository to save to
transformationId - The transformation ID
stepId - The step ID
Throws:
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 DatabaseMeta getDbMeta()
Returns:
the dbMeta

setDbMeta

public void setDbMeta(DatabaseMeta dbMeta)
Parameters:
dbMeta - the dbMeta to set