org.pentaho.di.trans.step
Class BaseStepData

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepData
All Implemented Interfaces:
StepDataInterface
Direct Known Subclasses:
AbortData, AccessInputData, AccessOutputData, AddSequenceData, AddXMLData, AggregateRowsData, AnalyticQueryData, AppendData, AutoDocData, BlockingStepData, BlockUntilStepsFinishData, CalculatorData, ChangeFileEncodingData, CheckSumData, CloneRowData, ClosureGeneratorData, ColumnExistsData, CombinationLookupData, ConstantData, CreditCardValidatorData, CsvInputData, CubeInputData, CubeOutputData, DatabaseJoinData, DatabaseLookupData, DataGridData, DBProcData, DelayData, DeleteData, DenormaliserData, DetectEmptyStreamData, DetectLastRowData, DimensionLookupData, DummyTransData, DynamicSQLRowData, Edi2XmlData, ElasticSearchBulkData, ExcelInputData, ExcelOutputData, ExcelWriterStepData, ExecProcessData, ExecSQLData, ExecSQLRowData, FieldsChangeSequenceData, FieldSplitterData, FileExistsData, FileLockedData, FilesFromResultData, FilesToResultData, FilterRowsData, FixedInputData, FlattenerData, FormulaData, FuzzyMatchData, GaInputStepData, GenericStepData, GetFileNamesData, GetFilesRowsCountData, GetPreviousRowFieldData, GetRepositoryNamesData, GetSlaveSequenceData, GetSubFoldersData, GetTableNamesData, GetVariableData, GetXMLDataData, GPBulkLoaderData, GroupByData, HTTPData, HTTPPOSTData, IfNullData, InfobrightLoaderData, IngresVectorwiseLoaderData, InjectorData, InsertUpdateData, JaninoData, JavaFilterData, JoinRowsData, JsonInputData, JsonOutputData, LDAPInputData, LDAPOutputData, LDIFInputData, LoadFileInputData, LucidDBBulkLoaderData, LucidDBStreamingLoaderData, MailData, MailInputData, MailValidatorData, MappingData, MappingInputData, MappingOutputData, MemoryGroupByData, MergeJoinData, MergeRowsData, MetaInjectData, MondrianData, MonetDBBulkLoaderData, MultiMergeJoinData, MySQLBulkLoaderData, NormaliserData, NullIfData, NumberRangeData, OlapData, OraBulkLoaderData, ParGzipCsvInputData, PentahoReportingOutputData, PGBulkLoaderData, PrioritizeStreamsData, ProcessFilesData, PropertyInputData, PropertyOutputData, RandomCCNumberGeneratorData, RandomValueData, RegexEvalData, ReplaceStringData, ReservoirSamplingData, RestData, RowGeneratorData, RowsFromResultData, RowsToResultData, RssInputData, RssOutputData, RulesData, SalesforceDeleteData, SalesforceInputData, SalesforceInsertData, SalesforceUpdateData, SalesforceUpsertData, SampleRowsData, SapInputData, SasInputData, ScriptData, ScriptValuesModData, SecretKeyGeneratorData, SelectValuesData, SetValueConstantData, SetValueFieldData, SetVariableData, SingleThreaderData, SocketReaderData, SocketWriterData, SortedMergeData, SortRowsData, SplitFieldToRowsData, SQLFileOutputData, SSHData, StepMetastructureData, StepsMetricsData, StreamLookupData, StringCutData, StringOperationsData, SwitchCaseData, SymmetricCryptoTransData, SynchronizeAfterMergeData, SyslogMessageData, SystemDataData, TableExistsData, TableInputData, TableOutputData, TextFileInputData, TextFileOutputData, UniqueRowsByHashSetData, UniqueRowsData, UnivariateStatsData, UpdateData, UserDefinedJavaClassData, ValidatorData, ValueMapperData, WebServiceAvailableData, WebServiceData, WriteToLogData, XBaseInputData, XMLInputData, XMLInputSaxData, XMLInputStreamData, XMLJoinData, XMLOutputData, XsdValidatorData, XsltData, YamlInputData

public abstract class BaseStepData
extends Object
implements StepDataInterface

This class is the base class for the StepDataInterface and contains the methods to set and retrieve the status of the step data.

Since:
20-jan-2005
Author:
Matt

Nested Class Summary
static class BaseStepData.StepExecutionStatus
          The Enum StepExecutionStatus.
 
Constructor Summary
BaseStepData()
          Instantiates a new base step data.
 
Method Summary
 BaseStepData.StepExecutionStatus getStatus()
          Get the status of this step data.
 boolean isDisposed()
          Checks if is disposed.
 boolean isEmpty()
          Checks if is empty.
 boolean isFinished()
          Checks if is finished.
 boolean isIdle()
          Checks if is idle.
 boolean isInitialising()
          Checks if is initialising.
 boolean isRunning()
          Checks if is running.
 boolean isStopped()
          Checks if is stopped.
 void setStatus(BaseStepData.StepExecutionStatus status)
          Set the status of the step data.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseStepData

public BaseStepData()
Instantiates a new base step data.

Method Detail

setStatus

public void setStatus(BaseStepData.StepExecutionStatus status)
Set the status of the step data.

Specified by:
setStatus in interface StepDataInterface
Parameters:
status - the new status.

getStatus

public BaseStepData.StepExecutionStatus getStatus()
Get the status of this step data.

Specified by:
getStatus in interface StepDataInterface
Returns:
the status of the step data

isEmpty

public boolean isEmpty()
Checks if is empty.

Specified by:
isEmpty in interface StepDataInterface
Returns:
true, if is empty

isInitialising

public boolean isInitialising()
Checks if is initialising.

Specified by:
isInitialising in interface StepDataInterface
Returns:
true, if is initialising

isRunning

public boolean isRunning()
Checks if is running.

Specified by:
isRunning in interface StepDataInterface
Returns:
true, if is running

isIdle

public boolean isIdle()
Checks if is idle.

Specified by:
isIdle in interface StepDataInterface
Returns:
true, if is idle

isFinished

public boolean isFinished()
Checks if is finished.

Specified by:
isFinished in interface StepDataInterface
Returns:
true, if is finished

isStopped

public boolean isStopped()
Checks if is stopped.

Returns:
true, if is stopped

isDisposed

public boolean isDisposed()
Checks if is disposed.

Specified by:
isDisposed in interface StepDataInterface
Returns:
true, if is disposed