|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.autodoc.AutoDocMeta
@Step(id="AutoDoc", name="AutoDoc.Step.Name", description="AutoDoc.Step.Description", i18nPackageName="org.pentaho.di.autodoc", image="org/pentaho/di/autodoc/autodoc.png", categoryDescription="Autodoc.Category.PDI-EE") public class AutoDocMeta
Field Summary |
---|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
AutoDocMeta()
|
Method Summary | |
---|---|
void |
allocate()
|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepinfo,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
Checks the settings of this step and puts the findings in a remarks List. |
Object |
clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc. |
void |
getFields(RowMetaInterface rowMeta,
String origin,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getFilenameField()
|
String |
getFileTypeField()
|
KettleReportBuilder.OutputType |
getOutputType()
|
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 |
getTargetFilename()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
isIncludingCreated()
|
boolean |
isIncludingDescription()
|
boolean |
isIncludingExtendedDescription()
|
boolean |
isIncludingImage()
|
boolean |
isIncludingLastExecutionResult()
|
boolean |
isIncludingLoggingConfiguration()
|
boolean |
isIncludingModified()
|
boolean |
isIncludingName()
|
void |
loadXML(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Load the values for this step from an XML Node |
void |
readRep(Repository rep,
ObjectId id_step,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
ObjectId id_transformation,
ObjectId id_step)
Save the steps data into a Kettle repository |
void |
setDefault()
Set default values |
void |
setFilenameField(String filenameField)
|
void |
setFileTypeField(String fileTypeField)
|
void |
setIncludingCreated(boolean includingCreated)
|
void |
setIncludingDescription(boolean includingDescription)
|
void |
setIncludingExtendedDescription(boolean includingExtendedDescription)
|
void |
setIncludingImage(boolean includingImage)
|
void |
setIncludingLastExecutionResult(boolean includingLastExecutionResult)
|
void |
setIncludingLoggingConfiguration(boolean includingLoggingConfiguration)
|
void |
setIncludingModified(boolean includingModified)
|
void |
setIncludingName(boolean includingName)
|
void |
setOutputType(KettleReportBuilder.OutputType outputType)
|
void |
setTargetFilename(String targetFilename)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AutoDocMeta()
Method Detail |
---|
public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void allocate()
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public void getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
rowMeta
- the input row metaorigin
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exceptionpublic void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepinfo
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettr
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public String getFilenameField()
public void setFilenameField(String filenameField)
filenameField
- the filenameField to setpublic String getTargetFilename()
public void setTargetFilename(String targetFilename)
targetFilename
- the targetFilename to setpublic KettleReportBuilder.OutputType getOutputType()
getOutputType
in interface AutoDocOptionsInterface
public void setOutputType(KettleReportBuilder.OutputType outputType)
outputType
- the outputType to setpublic boolean isIncludingDescription()
isIncludingDescription
in interface AutoDocOptionsInterface
public void setIncludingDescription(boolean includingDescription)
includingDescription
- the includingDescription to setpublic boolean isIncludingCreated()
isIncludingCreated
in interface AutoDocOptionsInterface
public void setIncludingCreated(boolean includingCreated)
includingCreated
- the includingCreated to setpublic boolean isIncludingModified()
isIncludingModified
in interface AutoDocOptionsInterface
public void setIncludingModified(boolean includingModified)
includingModified
- the includingModified to setpublic boolean isIncludingImage()
isIncludingImage
in interface AutoDocOptionsInterface
public void setIncludingImage(boolean includingImage)
includingImage
- the includingImage to setpublic boolean isIncludingLoggingConfiguration()
isIncludingLoggingConfiguration
in interface AutoDocOptionsInterface
public void setIncludingLoggingConfiguration(boolean includingLoggingConfiguration)
includingLoggingConfiguration
- the includingLoggingConfiguration to setpublic boolean isIncludingLastExecutionResult()
isIncludingLastExecutionResult
in interface AutoDocOptionsInterface
public void setIncludingLastExecutionResult(boolean includingLastExecutionResult)
includingLastExecutionResult
- the includingLastExecutionResult to setpublic boolean isIncludingExtendedDescription()
isIncludingExtendedDescription
in interface AutoDocOptionsInterface
public void setIncludingExtendedDescription(boolean includingExtendedDescription)
includingExtendedDescription
- the includingExtendedDescription to setpublic boolean isIncludingName()
isIncludingName
in interface AutoDocOptionsInterface
public void setIncludingName(boolean includingName)
includingName
- the includingName to setpublic String getFileTypeField()
public void setFileTypeField(String fileTypeField)
fileTypeField
- the fileTypeField to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |