|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.core.Result
public class Result
Describes the result of the execution of a Transformation or a Job. The information available includes the following:
Field Summary | |
---|---|
boolean |
stopped
Whether the job or transformation was stopped. |
static String |
XML_FILE_TAG
A constant specifying the tag value for the XML node for the result file entry |
static String |
XML_FILES_TAG
A constant specifying the tag value for the XML node for result files entry |
static String |
XML_ROWS_TAG
A constant specifying the tag value for the XML node for the result rows entry |
static String |
XML_TAG
A constant specifying the tag value for the XML node of the result object |
Constructor Summary | |
---|---|
Result()
Instantiates a new Result object, setting default values for all members |
|
Result(int nr)
Instantiates a new Result object, setting default values for all members and the entry number |
|
Result(Node node)
Instantiates a new Result object from a DOM node |
Method Summary | |
---|---|
void |
add(Result res)
Add the numbers of lines from a different result to this result |
void |
clear()
Clears the numbers in this result, setting them all to zero. |
Result |
clone()
Clones the Result, including rows and files. |
long |
getEntryNr()
Returns the entry number |
int |
getExitStatus()
Returns the exit status value. |
String |
getLogChannelId()
Returns the log channel id of the object that was executed (trans, job, job entry, etc) |
String |
getLogText()
Returns all the text from any logging performed by the transformation or job |
long |
getNrErrors()
Returns the number of errors that occurred during this transformation or job |
long |
getNrFilesRetrieved()
Returns the number of files retrieved during execution of this transformation or job |
long |
getNrLinesDeleted()
Returns the number of lines deleted during execution of this transformation or job |
long |
getNrLinesInput()
Returns the number of lines input during execution of this transformation or job |
long |
getNrLinesOutput()
Returns the number of lines output during execution of this transformation or job |
long |
getNrLinesRead()
Returns the number of lines read during execution of this transformation or job |
long |
getNrLinesRejected()
Returns the number of lines rejected during execution of this transformation or job |
long |
getNrLinesUpdated()
Returns the number of lines updated during execution of this transformation or job |
long |
getNrLinesWritten()
Returns the number of lines written during execution of this transformation or job |
String |
getReadWriteThroughput(int seconds)
Creates a string containing the read/write throughput. |
boolean |
getResult()
Returns the boolean result of this transformation or job |
Map<String,ResultFile> |
getResultFiles()
Returns the result files as a Map with the filename as key and the ResultFile object as value |
List<ResultFile> |
getResultFilesList()
Returns the result files as a List of type ResultFile |
List<RowMetaAndData> |
getRows()
Returns the resulting rowset from the job or transformation. |
String |
getXML()
Returns a String object with the Result object serialized as XML |
void |
increaseErrors(long incr)
Increases the number of errors by the specified value |
void |
increaseLinesDeleted(long incr)
Increases the number of lines deleted by the specified value |
void |
increaseLinesInput(long incr)
Increases the number of lines input by the specified value |
void |
increaseLinesOutput(long incr)
Increases the number of lines output by the specified value |
void |
increaseLinesRead(long incr)
Increases the number of lines read by the specified value |
void |
increaseLinesRejected(long incr)
Increases the number of lines rejected by the specified value |
void |
increaseLinesUpdated(long incr)
Increases the number of lines updated by the specified value |
void |
increaseLinesWritten(long incr)
Increases the number of lines written by the specified value |
boolean |
isStopped()
Returns whether the transformation or job was stopped before completion |
Result |
lightClone()
Performs a semi-deep copy/clone but does not clone the rows from the Result |
void |
setEntryNr(long entryNr)
Sets the entry number to the specified value |
void |
setExitStatus(int exitStatus)
Sets the exit status value to the specified value |
void |
setLogChannelId(String logChannelId)
Sets the log channel id of the object that was executed (trans, job, job entry, etc) |
void |
setLogText(String logText)
Sets the logging text to the specified String |
void |
setNrErrors(long nrErrors)
Sets the number of errors that occurred during execution of this transformation or job |
void |
setNrFilesRetrieved(long filesRetrieved)
Sets the number of files retrieved to the specified value |
void |
setNrLinesDeleted(long nrLinesDeleted)
Sets the number of lines deleted during execution of this transformation or job |
void |
setNrLinesInput(long nrLinesInput)
Sets the number of lines input during execution of this transformation or job |
void |
setNrLinesOutput(long nrLinesOutput)
Sets the number of lines output during execution of this transformation or job |
void |
setNrLinesRead(long nrLinesRead)
Sets the number of lines read during execution of this transformation or job |
void |
setNrLinesRejected(long nrLinesRejected)
Sets the number of lines rejected during execution of this transformation or job |
void |
setNrLinesUpdated(long nrLinesUpdated)
Sets the number of lines updated during execution of this transformation or job |
void |
setNrLinesWritten(long nrLinesWritten)
Sets the number of lines written during execution of this transformation or job |
void |
setResult(boolean result)
Sets the result of the transformation or job. |
void |
setResultFiles(Map<String,ResultFile> usedFiles)
Sets the result files for this Result to the specified Map of ResultFile objects |
void |
setRows(List<RowMetaAndData> rows)
Sets the resulting rowset from the job or transformation execution |
void |
setStopped(boolean stopped)
Sets whether the transformation or job was stopped before completion |
String |
toString()
Returns a string representation of the Result object |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String XML_TAG
public static final String XML_FILES_TAG
public static final String XML_FILE_TAG
public static final String XML_ROWS_TAG
public boolean stopped
Constructor Detail |
---|
public Result()
public Result(int nr)
nr
- the entry number for the Resultpublic Result(Node node) throws KettleException
node
- the DOM root node representing the desired Result
KettleException
- if any errors occur during instantiationMethod Detail |
---|
public Result lightClone()
public Result clone()
clone
in class Object
Object.clone()
,
lightClone()
public String getReadWriteThroughput(int seconds)
seconds
- the number of seconds with which to determine the read/write throughput
public String toString()
toString
in class Object
Object.toString()
public long getNrFilesRetrieved()
public void setNrFilesRetrieved(long filesRetrieved)
filesRetrieved
- The number of files retrieved to set.public long getEntryNr()
public void setEntryNr(long entryNr)
entryNr
- The entry number to set.public int getExitStatus()
public void setExitStatus(int exitStatus)
exitStatus
- The exit status to set.public long getNrErrors()
public void setNrErrors(long nrErrors)
nrErrors
- The number of errors to setpublic long getNrLinesInput()
public void setNrLinesInput(long nrLinesInput)
nrLinesInput
- The number of lines input to set.public long getNrLinesOutput()
public void setNrLinesOutput(long nrLinesOutput)
nrLinesOutput
- The number of lines output to setpublic long getNrLinesRead()
public void setNrLinesRead(long nrLinesRead)
nrLinesRead
- The number of lines read to set.public long getNrLinesUpdated()
public void setNrLinesUpdated(long nrLinesUpdated)
nrLinesUpdated
- The number of lines updated to set.public long getNrLinesWritten()
public void setNrLinesWritten(long nrLinesWritten)
nrLinesWritten
- The number of lines written to set.public long getNrLinesDeleted()
public void setNrLinesDeleted(long nrLinesDeleted)
nrLinesDeleted
- The number of lines deleted to set.public boolean getResult()
public void setResult(boolean result)
result
- The boolean result to set.public List<RowMetaAndData> getRows()
public void setRows(List<RowMetaAndData> rows)
rows
- The List of rows to set.public boolean isStopped()
public void setStopped(boolean stopped)
stopped
- true if the transformation or job was stopped, false otherwisepublic void clear()
public void add(Result res)
res
- The Result object from which to addpublic String getXML() throws IOException
IOException
- if any errors (encoding errors, e.g.) occur during serializationpublic Map<String,ResultFile> getResultFiles()
ResultFile
public List<ResultFile> getResultFilesList()
ResultFile
public void setResultFiles(Map<String,ResultFile> usedFiles)
usedFiles
- The Map of result files to set. This is a Map with the filename as key and ResultFile object as valueResultFile
public long getNrLinesRejected()
public void setNrLinesRejected(long nrLinesRejected)
nrLinesRejected
- the number of lines rejected to setpublic String getLogChannelId()
public void setLogChannelId(String logChannelId)
logChannelId
- the logChannelId to setpublic void increaseLinesRead(long incr)
incr
- the amount to incrementpublic void increaseLinesWritten(long incr)
incr
- the amount to incrementpublic void increaseLinesInput(long incr)
incr
- the amount to incrementpublic void increaseLinesOutput(long incr)
incr
- the amount to incrementpublic void increaseLinesUpdated(long incr)
incr
- the amount to incrementpublic void increaseLinesDeleted(long incr)
incr
- the amount to incrementpublic void increaseLinesRejected(long incr)
incr
- the amount to incrementpublic void increaseErrors(long incr)
incr
- the amount to incrementpublic String getLogText()
public void setLogText(String logText)
logText
- the logText to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |