Package org.apache.hop.pipeline.transform

Class TransformErrorMeta

java.lang.Object

org.apache.hop.core.changed.ChangedFlag

org.apache.hop.pipeline.transform.TransformErrorMeta

All Implemented Interfaces:

Cloneable, IChanged

public class TransformErrorMeta
extends ChangedFlag
implements Cloneable

This class contains the metadata to handle proper error handling on a transform level.

Field Summary

Fields

Modifier and Type	Field	Description
static String	XML_ERROR_TAG
static String	XML_SOURCE_TRANSFORM_TAG
static String	XML_TARGET_TRANSFORM_TAG

Constructor Summary

Constructors

Constructor	Description
TransformErrorMeta(TransformMeta sourceTransform)	Create a new transform error handling metadata object
TransformErrorMeta(TransformMeta sourceTransform, TransformMeta targetTransform)	Create a new transform error handling metadata object
TransformErrorMeta(TransformMeta sourceTransform, TransformMeta targetTransform, String nrErrorsValuename, String errorDescriptionsValuename, String errorFieldsValuename, String errorCodesValuename)	Create a new transform error handling metadata object
TransformErrorMeta(Node node, List<TransformMeta> transforms)

Method Summary

Modifier and Type	Method	Description
void	addErrorRowData(IVariables variables, Object[] row, int startIndex, long nrErrors, String errorDescriptions, String fieldNames, String errorCodes)
TransformErrorMeta	clone()
String	getErrorCodesValuename()
String	getErrorDescriptionsValuename()
String	getErrorFieldsValuename()
IRowMeta	getErrorRowMeta(IVariables variables)
String	getMaxErrors()
String	getMaxPercentErrors()
String	getMinPercentRows()
String	getNrErrorsValuename()
TransformMeta	getSourceTransform()
TransformMeta	getTargetTransform()
String	getXml()
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setErrorCodesValuename(String errorCodesValuename)
void	setErrorDescriptionsValuename(String errorDescriptionsValuename)
void	setErrorFieldsValuename(String errorFieldsValuename)
void	setMaxErrors(String maxErrors)
void	setMaxPercentErrors(String maxPercentErrors)
void	setMinPercentRows(String minRowsForPercent)
void	setNrErrorsValuename(String nrErrorsValuename)
void	setSourceTransform(TransformMeta sourceTransform)
void	setTargetTransform(TransformMeta targetTransform)

Methods inherited from class org.apache.hop.core.changed.ChangedFlag

addObserver, clearChanged, deleteObserver, hasChanged, notifyObservers, setChanged, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_ERROR_TAG

public static final String XML_ERROR_TAG

See Also:

Constant Field Values

XML_SOURCE_TRANSFORM_TAG

public static final String XML_SOURCE_TRANSFORM_TAG

See Also:

Constant Field Values

XML_TARGET_TRANSFORM_TAG

public static final String XML_TARGET_TRANSFORM_TAG

See Also:

Constant Field Values

Constructor Detail

TransformErrorMeta

public TransformErrorMeta(TransformMeta sourceTransform)

Create a new transform error handling metadata object

Parameters:

sourceTransform - The source transform that can send the error rows

TransformErrorMeta

public TransformErrorMeta(TransformMeta sourceTransform,
                          TransformMeta targetTransform)

Create a new transform error handling metadata object

Parameters:

sourceTransform - The source transform that can send the error rows

targetTransform - The target transform to send the error rows to

TransformErrorMeta

public TransformErrorMeta(TransformMeta sourceTransform,
                          TransformMeta targetTransform,
                          String nrErrorsValuename,
                          String errorDescriptionsValuename,
                          String errorFieldsValuename,
                          String errorCodesValuename)

Create a new transform error handling metadata object

Parameters:

sourceTransform - The source transform that can send the error rows

targetTransform - The target transform to send the error rows to

nrErrorsValuename - the name of the field value to contain the number of errors (null or empty means it's not needed)

errorDescriptionsValuename - the name of the field value to contain the error description(s) (null or empty means it's not needed)

errorFieldsValuename - the name of the field value to contain the fields for which the error(s) occured (null or empty means it's not needed)

errorCodesValuename - the name of the field value to contain the error code(s) (null or empty means it's not needed)

TransformErrorMeta

public TransformErrorMeta(Node node,
                          List<TransformMeta> transforms)

Method Detail

clone

public TransformErrorMeta clone()

Overrides:

clone in class Object

getXml

public String getXml()

getErrorCodesValuename

public String getErrorCodesValuename()

Returns:

the error codes valuename

setErrorCodesValuename

public void setErrorCodesValuename(String errorCodesValuename)

Parameters:

errorCodesValuename - the error codes valuename to set

getErrorDescriptionsValuename

public String getErrorDescriptionsValuename()

Returns:

the error descriptions valuename

setErrorDescriptionsValuename

public void setErrorDescriptionsValuename(String errorDescriptionsValuename)

Parameters:

errorDescriptionsValuename - the error descriptions valuename to set

getErrorFieldsValuename

public String getErrorFieldsValuename()

Returns:

the error fields valuename

setErrorFieldsValuename

public void setErrorFieldsValuename(String errorFieldsValuename)

Parameters:

errorFieldsValuename - the error fields valuename to set

getNrErrorsValuename

public String getNrErrorsValuename()

Returns:

the nr errors valuename

setNrErrorsValuename

public void setNrErrorsValuename(String nrErrorsValuename)

Parameters:

nrErrorsValuename - the nr errors valuename to set

getTargetTransform

public TransformMeta getTargetTransform()

Returns:

the target transform

setTargetTransform

public void setTargetTransform(TransformMeta targetTransform)

Parameters:

targetTransform - the target transform to set

getSourceTransform

public TransformMeta getSourceTransform()

Returns:

The source transform can send the error rows

setSourceTransform

public void setSourceTransform(TransformMeta sourceTransform)

Parameters:

sourceTransform - The source transform can send the error rows

isEnabled

public boolean isEnabled()

Returns:

the enabled flag: Is the error handling enabled?

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - the enabled flag to set: Is the error handling enabled?

getErrorRowMeta

public IRowMeta getErrorRowMeta(IVariables variables)

addErrorRowData

public void addErrorRowData(IVariables variables,
                            Object[] row,
                            int startIndex,
                            long nrErrors,
                            String errorDescriptions,
                            String fieldNames,
                            String errorCodes)

getMaxErrors

public String getMaxErrors()

Returns:

the maxErrors

setMaxErrors

public void setMaxErrors(String maxErrors)

Parameters:

maxErrors - the maxErrors to set

getMaxPercentErrors

public String getMaxPercentErrors()

Returns:

the maxPercentErrors

setMaxPercentErrors

public void setMaxPercentErrors(String maxPercentErrors)

Parameters:

maxPercentErrors - the maxPercentErrors to set

getMinPercentRows

public String getMinPercentRows()

Returns:

the minRowsForPercent

setMinPercentRows

public void setMinPercentRows(String minRowsForPercent)

Parameters:

minRowsForPercent - the minRowsForPercent to set