|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.shared.SharedObjectBase org.pentaho.di.trans.step.StepMeta
public class StepMeta
This class contains everything that is needed to define a step.
Field Summary | |
---|---|
static String |
STRING_ID_ETL_META_INJECT
|
static String |
STRING_ID_MAPPING
|
static String |
STRING_ID_MAPPING_INPUT
|
static String |
STRING_ID_MAPPING_OUTPUT
|
static String |
STRING_ID_SINGLE_THREADER
|
static String |
XML_TAG
|
Constructor Summary | |
---|---|
StepMeta()
|
|
StepMeta(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Read the step data from XML |
|
StepMeta(ObjectId id_step)
|
|
StepMeta(String stepname,
StepMetaInterface stepMetaInterface)
|
|
StepMeta(String stepid,
String stepname,
StepMetaInterface stepMetaInterface)
|
Method Summary | |
---|---|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
|
boolean |
chosesTargetSteps()
|
Object |
clone()
|
int |
compareTo(StepMeta o)
|
void |
drawStep()
|
boolean |
equals(Object obj)
Two steps are equal if their names are equal. |
String |
exportResources(VariableSpace space,
Map<String,ResourceDefinition> definitions,
ResourceNamingInterface resourceNamingInterface,
Repository repository)
Exports the object to a flat-file system, adding content with filename keys to a set of definitions. |
static StepMeta |
findStep(List<StepMeta> steps,
ObjectId id)
Find a step with the ID in a given ArrayList of steps |
static StepMeta |
findStep(List<StepMeta> steps,
String stepname)
Find a step with its name in a given ArrayList of steps |
void |
flipSelected()
|
ClusterSchema |
getClusterSchema()
|
int |
getCopies()
Get the number of copies to start of a step. |
String |
getDescription()
|
String |
getHolderType()
Gets the high-level type of resource holder. |
Point |
getLocation()
|
String |
getName()
|
ObjectId |
getObjectId()
|
TransMeta |
getParentTransMeta()
|
List<RemoteStep> |
getRemoteInputSteps()
|
List<RemoteStep> |
getRemoteOutputSteps()
|
List<ResourceReference> |
getResourceDependencies(TransMeta transMeta)
Get a list of all the resource dependencies that the step is depending on. |
StepErrorMeta |
getStepErrorMeta()
|
String |
getStepID()
|
StepMetaInterface |
getStepMetaInterface()
|
StepPartitioningMeta |
getStepPartitioningMeta()
|
StepPartitioningMeta |
getTargetStepPartitioningMeta()
|
String |
getTypeId()
Support for CheckResultSourceInterface |
String |
getXML()
|
String |
getXML(boolean includeInterface)
|
boolean |
hasChanged()
|
int |
hashCode()
|
boolean |
hasTerminator()
|
void |
hideStep()
|
boolean |
isClustered()
|
boolean |
isDistributes()
|
boolean |
isDoingErrorHandling()
|
boolean |
isDrawn()
See wether or not the step is drawn on the canvas. |
boolean |
isDrawStep()
See wether or not the step is drawn on the canvas. |
boolean |
isEtlMetaInject()
|
boolean |
isMapping()
|
boolean |
isMappingInput()
|
boolean |
isMappingOutput()
|
boolean |
isPartitioned()
|
boolean |
isRepartitioning()
|
boolean |
isSelected()
|
boolean |
isSendingErrorRowsToStep(StepMeta targetStep)
|
boolean |
isSingleThreader()
|
boolean |
isTargetPartitioned()
|
void |
replaceMeta(StepMeta stepMeta)
|
void |
setChanged()
|
void |
setChanged(boolean ch)
|
void |
setClusterSchema(ClusterSchema clusterSchema)
|
void |
setClusterSchemaAfterLoading(List<ClusterSchema> clusterSchemas)
Resolves the name of the cluster loaded from XML/Repository to the correct clusterSchema object |
void |
setClusterSchemaName(String clusterSchemaName)
|
void |
setCopies(int c)
Sets the number of parallel copies that this step will be launched with. |
void |
setDescription(String description)
|
void |
setDistributes(boolean distributes)
|
void |
setDraw(boolean draw)
Sets the draw attribute of the step so that it will be drawn on the canvas. |
void |
setLocation(int x,
int y)
|
void |
setLocation(Point loc)
|
void |
setName(String sname)
|
void |
setObjectId(ObjectId id)
|
void |
setParentTransMeta(TransMeta parentTransMeta)
|
void |
setRemoteInputSteps(List<RemoteStep> remoteInputSteps)
|
void |
setRemoteOutputSteps(List<RemoteStep> remoteOutputSteps)
|
void |
setSelected(boolean sel)
|
void |
setStepErrorMeta(StepErrorMeta stepErrorMeta)
|
void |
setStepID(String stepid)
Set the plugin step id (code) |
void |
setStepMetaInterface(StepMetaInterface stepMetaInterface)
|
void |
setStepPartitioningMeta(StepPartitioningMeta stepPartitioningMeta)
|
void |
setTargetStepPartitioningMeta(StepPartitioningMeta targetStepPartitioningMeta)
|
void |
setTerminator()
|
void |
setTerminator(boolean t)
|
boolean |
supportsErrorHandling()
|
String |
toString()
|
Methods inherited from class org.pentaho.di.shared.SharedObjectBase |
---|
getChangedDate, isShared, setChangedDate, setShared |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.pentaho.di.shared.SharedObjectInterface |
---|
getChangedDate, isShared, setShared |
Field Detail |
---|
public static final String XML_TAG
public static final String STRING_ID_MAPPING
public static final String STRING_ID_SINGLE_THREADER
public static final String STRING_ID_ETL_META_INJECT
public static final String STRING_ID_MAPPING_INPUT
public static final String STRING_ID_MAPPING_OUTPUT
Constructor Detail |
---|
public StepMeta(String stepid, String stepname, StepMetaInterface stepMetaInterface)
stepid
- The ID of the step: this is derived information, you can also use the constructor without stepid.
This constructor will be deprecated soon.stepname
- The name of the new stepstepMetaInterface
- The step metadata interface to use (TextFileInputMeta, etc)public StepMeta(String stepname, StepMetaInterface stepMetaInterface)
stepname
- The name of the new stepstepMetaInterface
- The step metadata interface to use (TextFileInputMeta, etc)public StepMeta()
public StepMeta(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
stepnode
- The XML step node.databases
- A list of databasescounters
- A map with all defined counters.
KettleXMLException
public StepMeta(ObjectId id_step)
Method Detail |
---|
public String getXML() throws KettleException
getXML
in interface SharedObjectInterface
KettleException
public String getXML(boolean includeInterface) throws KettleException
KettleException
public void setClusterSchemaAfterLoading(List<ClusterSchema> clusterSchemas)
clusterSchemas
- The list of clusterSchemas to reference.public ObjectId getObjectId()
getObjectId
in interface CheckResultSourceInterface
getObjectId
in interface ResourceHolderInterface
public void setObjectId(ObjectId id)
public boolean isDrawn()
public boolean isDrawStep()
public void setDraw(boolean draw)
draw
- True if you want the step to show itself on the canvas, False if you don't.public void setCopies(int c)
c
- The number of copies.public int getCopies()
public void drawStep()
public void hideStep()
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int compareTo(StepMeta o)
compareTo
in interface Comparable<StepMeta>
public boolean hasChanged()
public void setChanged(boolean ch)
public void setChanged()
public boolean chosesTargetSteps()
public Object clone()
clone
in class Object
public void replaceMeta(StepMeta stepMeta)
public StepMetaInterface getStepMetaInterface()
public void setStepMetaInterface(StepMetaInterface stepMetaInterface)
public String getStepID()
public String getName()
getName
in interface CheckResultSourceInterface
getName
in interface ResourceHolderInterface
getName
in interface SharedObjectInterface
public void setName(String sname)
public String getDescription()
getDescription
in interface CheckResultSourceInterface
getDescription
in interface ResourceHolderInterface
public void setDescription(String description)
public void setSelected(boolean sel)
setSelected
in interface GUIPositionInterface
public void flipSelected()
public boolean isSelected()
isSelected
in interface GUIPositionInterface
public void setTerminator()
public void setTerminator(boolean t)
public boolean hasTerminator()
public void setLocation(int x, int y)
setLocation
in interface GUIPositionInterface
public void setLocation(Point loc)
setLocation
in interface GUIPositionInterface
public Point getLocation()
getLocation
in interface GUIPositionInterface
public void check(List<CheckResultInterface> remarks, TransMeta transMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
public String toString()
toString
in class Object
public boolean isPartitioned()
public boolean isTargetPartitioned()
public StepPartitioningMeta getStepPartitioningMeta()
public void setStepPartitioningMeta(StepPartitioningMeta stepPartitioningMeta)
stepPartitioningMeta
- the stepPartitioningMeta to setpublic ClusterSchema getClusterSchema()
public void setClusterSchema(ClusterSchema clusterSchema)
clusterSchema
- the clusterSchema to setpublic boolean isDistributes()
public void setDistributes(boolean distributes)
distributes
- the distributes to setpublic StepErrorMeta getStepErrorMeta()
public void setStepErrorMeta(StepErrorMeta stepErrorMeta)
stepErrorMeta
- the error handling metadata for this steppublic static final StepMeta findStep(List<StepMeta> steps, ObjectId id)
steps
- The List of steps to searchid
- The ID of the step
public static final StepMeta findStep(List<StepMeta> steps, String stepname)
steps
- The List of steps to searchstepname
- The name of the step
public boolean supportsErrorHandling()
public boolean isDoingErrorHandling()
public boolean isSendingErrorRowsToStep(StepMeta targetStep)
public String getTypeId()
getTypeId
in interface CheckResultSourceInterface
getTypeId
in interface ResourceHolderInterface
public boolean isMapping()
public boolean isSingleThreader()
public boolean isEtlMetaInject()
public boolean isMappingInput()
public boolean isMappingOutput()
public List<ResourceReference> getResourceDependencies(TransMeta transMeta)
public String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws KettleException
ResourceExportInterface
exportResources
in interface ResourceExportInterface
space
- The variable space to resolve (environment) variables with.definitions
- The map containing the filenames and contentresourceNamingInterface
- The resource naming interface allows the object to name appropriatelyrepository
- the repository object to load from
KettleException
- in case something goes wrong during the exportpublic List<RemoteStep> getRemoteInputSteps()
public void setRemoteInputSteps(List<RemoteStep> remoteInputSteps)
remoteInputSteps
- the remoteInputSteps to setpublic List<RemoteStep> getRemoteOutputSteps()
public void setRemoteOutputSteps(List<RemoteStep> remoteOutputSteps)
remoteOutputSteps
- the remoteOutputSteps to setpublic StepPartitioningMeta getTargetStepPartitioningMeta()
public void setTargetStepPartitioningMeta(StepPartitioningMeta targetStepPartitioningMeta)
targetStepPartitioningMeta
- the targetStepPartitioningMeta to setpublic boolean isRepartitioning()
public String getHolderType()
ResourceHolderInterface
getHolderType
in interface ResourceHolderInterface
public boolean isClustered()
public void setStepID(String stepid)
stepid
- public void setClusterSchemaName(String clusterSchemaName)
public void setParentTransMeta(TransMeta parentTransMeta)
public TransMeta getParentTransMeta()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |