Package org.pentaho.di.core.row

Class ValueDataUtil

java.lang.Object

org.pentaho.di.core.row.ValueDataUtil

public class ValueDataUtil
extends Object

Constructor Summary

Constructors

Constructor	Description
ValueDataUtil()

Method Summary

Modifier and Type	Method	Description
static Object	abs(ValueMetaInterface metaA, Object dataA)
static Object	addDays(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	addHours(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	addMinutes(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	addMonths(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	addSeconds(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	addTimeToDate(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, ValueMetaInterface metaC, Object dataC)
static String	byteToHexEncode(ValueMetaInterface metaA, Object dataA)	Change a string into its hexadecimal representation.
static Object	ceil(ValueMetaInterface metaA, Object dataA)
static String	charToHexEncode(ValueMetaInterface meta, Object data)	Change a string into its hexadecimal representation.
static Long	checksumAdler32(ValueMetaInterface metaA, Object dataA, boolean failIfNoFile)
static Long	ChecksumAdler32(ValueMetaInterface metaA, Object dataA)	Deprecated. Use checksumAdler32(ValueMetaInterface, Object, boolean) instead
static Long	checksumCRC32(ValueMetaInterface metaA, Object dataA, boolean failIfNoFile)
static Long	ChecksumCRC32(ValueMetaInterface metaA, Object dataA)	Deprecated. Use checksumCRC32(ValueMetaInterface, Object, boolean) instead
static Object	combination1(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, ValueMetaInterface metaC, Object dataC)	A + B * C
static Object	combination2(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	SQRT( A*A + B*B )
static String	createChecksum(ValueMetaInterface metaA, Object dataA, String type)	Deprecated. Use createChecksum(ValueMetaInterface, Object, String, boolean) instead
static String	createChecksum(ValueMetaInterface metaA, Object dataA, String type, boolean failIfNoFile)
static Object	DateDiff(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, String resultType)	Returns the number of days that have elapsed between dataA and dataB.
static Object	DateWorkingDiff(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	dayOfMonth(ValueMetaInterface metaA, Object dataA)
static Object	dayOfWeek(ValueMetaInterface metaA, Object dataA)
static Object	dayOfYear(ValueMetaInterface metaA, Object dataA)
static Object	divide(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Deprecated.
static Object	divide(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, VariableSpace space)
static BigDecimal	divideBigDecimals(BigDecimal a, BigDecimal b, MathContext mc)	Deprecated.
static BigDecimal	divideBigDecimals(BigDecimal a, BigDecimal b, VariableSpace space)
static Double	divideDoubles(Double a, Double b)
static Long	divideLongs(Long a, Long b)
static String	escapeHTML(ValueMetaInterface metaA, Object dataA)
static String	escapeSQL(ValueMetaInterface metaA, Object dataA)
static String	escapeXML(ValueMetaInterface metaA, Object dataA)
static Object	floor(ValueMetaInterface metaA, Object dataA)
static String	get_Double_Metaphone(ValueMetaInterface metaA, Object dataA)
static String	get_Metaphone(ValueMetaInterface metaA, Object dataA)
static String	get_RefinedSoundEx(ValueMetaInterface metaA, Object dataA)
static String	get_SoundEx(ValueMetaInterface metaA, Object dataA)
static Long	getDamerauLevenshtein_Distance(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	DamerauLevenshtein distance is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).
static String	getDigits(ValueMetaInterface metaA, Object dataA)
static String	getFileEncoding(ValueMetaInterface metaA, Object dataA)	Deprecated. Use getFileEncoding(ValueMetaInterface, Object, boolean) instead
static String	getFileEncoding(ValueMetaInterface metaA, Object dataA, boolean failIfNoFile)	Get file encoding.
static Double	getJaro_Similitude(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Jaro similitude is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).
static Double	getJaroWinkler_Similitude(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	JaroWinkler similitude is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).
static Long	getLevenshtein_Distance(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Levenshtein distance (LD) is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).
static Long	getNeedlemanWunsch_Distance(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	NeedlemanWunsch distance is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).
static Object	getZeroForValueMetaType(ValueMetaInterface type)	Default utility method to get exact zero value according to ValueMetaInterface.
static String	hexToByteDecode(ValueMetaInterface meta, Object data)	Change a hexadecimal string into normal ASCII representation.
static String	hexToCharDecode(ValueMetaInterface meta, Object data)	Change a hexadecimal string into normal ASCII representation.
static Object	hourOfDay(ValueMetaInterface metaA, Object dataA)
static String	initCap(ValueMetaInterface metaA, Object dataA)
static boolean	isSpace(char c)	Deprecated. Use Const.isSpace(char) instead
static boolean	isXMLFileWellFormed(ValueMetaInterface metaA, Object dataA)	Deprecated. Use isXMLFileWellFormed(ValueMetaInterface, Object, boolean) instead
static boolean	isXMLFileWellFormed(ValueMetaInterface metaA, Object dataA, boolean failIfNoFile)	Checks an xml file is well formed.
static boolean	isXMLWellFormed(ValueMetaInterface metaA, Object dataA)	Checks an xml string is well formed.
static String	leftTrim(String string)	Deprecated. Use Const.ltrim(String) instead
static Object	loadFileContentInBinary(ValueMetaInterface metaA, Object dataA)	Deprecated. Use loadFileContentInBinary(ValueMetaInterface, Object, boolean) instead
static byte[]	loadFileContentInBinary(ValueMetaInterface metaA, Object dataA, boolean failIfNoFile)
static String	lowerCase(ValueMetaInterface metaA, Object dataA)
static Object	minus(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	minuteOfHour(ValueMetaInterface metaA, Object dataA)
static Object	monthOfDate(ValueMetaInterface metaA, Object dataA)
static Object	multiply(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static BigDecimal	multiplyBigDecimals(BigDecimal a, BigDecimal b, MathContext mc)
static Double	multiplyDoubles(Double a, Double b)
static Long	multiplyLongs(Long a, Long b)
protected static Object	multiplyNumeric(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
protected static Object	multiplyString(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static int	nrSpacesAfter(String field)	Count the number of spaces to the right of a text.
static int	nrSpacesBefore(String field)	Count the number of spaces to the left of a text.
static Object	nvl(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static boolean	onlySpaces(String str)	Checks whether or not a String consists only of spaces.
static Object	percent1(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Deprecated.
static Object	percent1(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, VariableSpace space)
static Object	percent2(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Deprecated.
static Object	percent2(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, VariableSpace space)
static Object	percent3(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Deprecated.
static Object	percent3(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, VariableSpace space)
static Object	plus(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static Object	plus3(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, ValueMetaInterface metaC, Object dataC)
static Object	quarterOfDate(ValueMetaInterface metaA, Object dataA)
static Object	remainder(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Returns the remainder (modulus) of A / B.
static String	removeCR(ValueMetaInterface metaA, Object dataA)
static String	removeCRLF(ValueMetaInterface metaA, Object dataA)
static String	removeDigits(ValueMetaInterface metaA, Object dataA)
static String	removeLF(ValueMetaInterface metaA, Object dataA)
static String	removeTAB(ValueMetaInterface metaA, Object dataA)
static Object	removeTimeFromDate(ValueMetaInterface metaA, Object dataA)
static String	replace(String string, String repl, String with)	Replace value occurances in a String with another value.
static void	replaceBuffer(StringBuffer str, String code, String repl)	Alternate faster version of string replace using a stringbuffer as input.
static String	rightPad(StringBuffer ret, int limit)	Right pad a StringBuffer: adds spaces to a string until a certain length.
static String	rightPad(String ret, int limit)	Right pad a string: adds spaces to a string until a certain length.
static String	rightTrim(String string)	Deprecated. Use Const.rtrim(String) instead
static Object	round(ValueMetaInterface metaA, Object dataA)	Rounding with no decimal places (using default rounding method ROUND_HALF_CEILING)
static Object	round(ValueMetaInterface metaA, Object dataA, int roundingMode)	Rounding with no decimal places with a given rounding method
static Object	round(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)	Rounding with decimal places (using default rounding method ROUND_HALF_EVEN)
static Object	round(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, int roundingMode)	Rounding with decimal places with a given rounding method
static Object	round(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB, ValueMetaInterface metaC, Object dataC)	Rounding with decimal places with a given rounding method
static Object	secondOfMinute(ValueMetaInterface metaA, Object dataA)
static Object	sqrt(ValueMetaInterface metaA, Object dataA)
static long	stringLen(ValueMetaInterface metaA, Object dataA)
static Object	sum(ValueMetaInterface metaA, Object dataA, ValueMetaInterface metaB, Object dataB)
static String	trim(String string)	Deprecated. Use Const.trim(String) instead
static String	unEscapeHTML(ValueMetaInterface metaA, Object dataA)
static String	unEscapeXML(ValueMetaInterface metaA, Object dataA)
static String	upperCase(ValueMetaInterface metaA, Object dataA)
static String	useCDATA(ValueMetaInterface metaA, Object dataA)
static Object	weekOfYear(ValueMetaInterface metaA, Object dataA)
static Object	weekOfYearISO8601(ValueMetaInterface metaA, Object dataA)
static Object	yearOfDate(ValueMetaInterface metaA, Object dataA)
static Object	yearOfDateISO8601(ValueMetaInterface metaA, Object dataA)

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueDataUtil

public ValueDataUtil()

Method Detail

leftTrim

@Deprecated
public static final String leftTrim(String string)

Deprecated.

Use Const.ltrim(String) instead

rightTrim

@Deprecated
public static final String rightTrim(String string)

Deprecated.

Use Const.rtrim(String) instead

isSpace

@Deprecated
public static final boolean isSpace(char c)

Deprecated.

Use Const.isSpace(char) instead

Determines whether or not a character is considered a space. A character is considered a space in Kettle if it is a space, a tab, a newline or a cariage return.

Parameters:

c - The character to verify if it is a space.

Returns:

true if the character is a space. false otherwise.

trim

@Deprecated
public static final String trim(String string)

Deprecated.

Use Const.trim(String) instead

Trims a string: removes the leading and trailing spaces of a String.

Parameters:

string - The string to trim

Returns:

The trimmed string.

getLevenshtein_Distance

public static Long getLevenshtein_Distance(ValueMetaInterface metaA,
                                           Object dataA,
                                           ValueMetaInterface metaB,
                                           Object dataB)

Levenshtein distance (LD) is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t). The distance is the number of deletions, insertions, or substitutions required to transform s into t.

getDamerauLevenshtein_Distance

public static Long getDamerauLevenshtein_Distance(ValueMetaInterface metaA,
                                                  Object dataA,
                                                  ValueMetaInterface metaB,
                                                  Object dataB)

DamerauLevenshtein distance is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t). The distance is the number of deletions, insertions, or substitutions required to transform s into t.

getNeedlemanWunsch_Distance

public static Long getNeedlemanWunsch_Distance(ValueMetaInterface metaA,
                                               Object dataA,
                                               ValueMetaInterface metaB,
                                               Object dataB)

NeedlemanWunsch distance is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t). The distance is the number of deletions, insertions, or substitutions required to transform s into t.

getJaro_Similitude

public static Double getJaro_Similitude(ValueMetaInterface metaA,
                                        Object dataA,
                                        ValueMetaInterface metaB,
                                        Object dataB)

Jaro similitude is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).

getJaroWinkler_Similitude

public static Double getJaroWinkler_Similitude(ValueMetaInterface metaA,
                                               Object dataA,
                                               ValueMetaInterface metaB,
                                               Object dataB)

JaroWinkler similitude is a measure of the similarity between two strings, which we will refer to as the source string (s) and the target string (t).

get_Metaphone

public static String get_Metaphone(ValueMetaInterface metaA,
                                   Object dataA)

get_Double_Metaphone

public static String get_Double_Metaphone(ValueMetaInterface metaA,
                                          Object dataA)

get_SoundEx

public static String get_SoundEx(ValueMetaInterface metaA,
                                 Object dataA)

get_RefinedSoundEx

public static String get_RefinedSoundEx(ValueMetaInterface metaA,
                                        Object dataA)

initCap

public static String initCap(ValueMetaInterface metaA,
                             Object dataA)

upperCase

public static String upperCase(ValueMetaInterface metaA,
                               Object dataA)

lowerCase

public static String lowerCase(ValueMetaInterface metaA,
                               Object dataA)

escapeXML

public static String escapeXML(ValueMetaInterface metaA,
                               Object dataA)

unEscapeXML

public static String unEscapeXML(ValueMetaInterface metaA,
                                 Object dataA)

escapeHTML

public static String escapeHTML(ValueMetaInterface metaA,
                                Object dataA)

unEscapeHTML

public static String unEscapeHTML(ValueMetaInterface metaA,
                                  Object dataA)

escapeSQL

public static String escapeSQL(ValueMetaInterface metaA,
                               Object dataA)

useCDATA

public static String useCDATA(ValueMetaInterface metaA,
                              Object dataA)

removeCR

public static String removeCR(ValueMetaInterface metaA,
                              Object dataA)

removeLF

public static String removeLF(ValueMetaInterface metaA,
                              Object dataA)

removeCRLF

public static String removeCRLF(ValueMetaInterface metaA,
                                Object dataA)

removeTAB

public static String removeTAB(ValueMetaInterface metaA,
                               Object dataA)

getDigits

public static String getDigits(ValueMetaInterface metaA,
                               Object dataA)

removeDigits

public static String removeDigits(ValueMetaInterface metaA,
                                  Object dataA)

stringLen

public static long stringLen(ValueMetaInterface metaA,
                             Object dataA)

createChecksum

@Deprecated
public static String createChecksum(ValueMetaInterface metaA,
                                    Object dataA,
                                    String type)

Deprecated.

Use createChecksum(ValueMetaInterface, Object, String, boolean) instead

createChecksum

public static String createChecksum(ValueMetaInterface metaA,
                                    Object dataA,
                                    String type,
                                    boolean failIfNoFile)
                             throws KettleFileNotFoundException

Parameters:

metaA - The ValueMetaInterface

dataA - Filename

type - Algorithm to be used when computing the checksum (MD5 or SHA-1)

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

File's checksum

Throws:

KettleFileNotFoundException

ChecksumCRC32

@Deprecated
public static Long ChecksumCRC32(ValueMetaInterface metaA,
                                 Object dataA)

Deprecated.

Use checksumCRC32(ValueMetaInterface, Object, boolean) instead

checksumCRC32

public static Long checksumCRC32(ValueMetaInterface metaA,
                                 Object dataA,
                                 boolean failIfNoFile)
                          throws KettleFileNotFoundException

Parameters:

metaA - The ValueMetaInterface

dataA - Filename

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

File's CRC32 checksum

Throws:

KettleFileNotFoundException

ChecksumAdler32

@Deprecated
public static Long ChecksumAdler32(ValueMetaInterface metaA,
                                   Object dataA)

Deprecated.

Use checksumAdler32(ValueMetaInterface, Object, boolean) instead

checksumAdler32

public static Long checksumAdler32(ValueMetaInterface metaA,
                                   Object dataA,
                                   boolean failIfNoFile)
                            throws KettleFileNotFoundException

Parameters:

metaA - The ValueMetaInterface

dataA - Filename

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

File's Adler32 checksum

Throws:

KettleFileNotFoundException

plus

public static Object plus(ValueMetaInterface metaA,
                          Object dataA,
                          ValueMetaInterface metaB,
                          Object dataB)
                   throws KettleValueException

Throws:

KettleValueException

plus3

public static Object plus3(ValueMetaInterface metaA,
                           Object dataA,
                           ValueMetaInterface metaB,
                           Object dataB,
                           ValueMetaInterface metaC,
                           Object dataC)
                    throws KettleValueException

Throws:

KettleValueException

sum

public static Object sum(ValueMetaInterface metaA,
                         Object dataA,
                         ValueMetaInterface metaB,
                         Object dataB)
                  throws KettleValueException

Throws:

KettleValueException

loadFileContentInBinary

@Deprecated
public static Object loadFileContentInBinary(ValueMetaInterface metaA,
                                             Object dataA)
                                      throws KettleValueException

Deprecated.

Use loadFileContentInBinary(ValueMetaInterface, Object, boolean) instead

Throws:

KettleValueException

loadFileContentInBinary

public static byte[] loadFileContentInBinary(ValueMetaInterface metaA,
                                             Object dataA,
                                             boolean failIfNoFile)
                                      throws KettleValueException,
                                             KettleFileNotFoundException

Parameters:

metaA - The ValueMetaInterface

dataA - Filename

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

File's content in binary

Throws:

KettleValueException

KettleFileNotFoundException

minus

public static Object minus(ValueMetaInterface metaA,
                           Object dataA,
                           ValueMetaInterface metaB,
                           Object dataB)
                    throws KettleValueException

Throws:

KettleValueException

multiply

public static Object multiply(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB)
                       throws KettleValueException

Throws:

KettleValueException

multiplyNumeric

protected static Object multiplyNumeric(ValueMetaInterface metaA,
                                        Object dataA,
                                        ValueMetaInterface metaB,
                                        Object dataB)
                                 throws KettleValueException

Throws:

KettleValueException

multiplyDoubles

public static Double multiplyDoubles(Double a,
                                     Double b)

multiplyLongs

public static Long multiplyLongs(Long a,
                                 Long b)

multiplyBigDecimals

public static BigDecimal multiplyBigDecimals(BigDecimal a,
                                             BigDecimal b,
                                             MathContext mc)

multiplyString

protected static Object multiplyString(ValueMetaInterface metaA,
                                       Object dataA,
                                       ValueMetaInterface metaB,
                                       Object dataB)
                                throws KettleValueException

Throws:

KettleValueException

divide

@Deprecated
public static Object divide(ValueMetaInterface metaA,
                            Object dataA,
                            ValueMetaInterface metaB,
                            Object dataB)
                     throws KettleValueException

Deprecated.

Throws:

KettleValueException

divide

public static Object divide(ValueMetaInterface metaA,
                            Object dataA,
                            ValueMetaInterface metaB,
                            Object dataB,
                            VariableSpace space)
                     throws KettleValueException

Throws:

KettleValueException

divideDoubles

public static Double divideDoubles(Double a,
                                   Double b)

divideLongs

public static Long divideLongs(Long a,
                               Long b)

divideBigDecimals

@Deprecated
public static BigDecimal divideBigDecimals(BigDecimal a,
                                           BigDecimal b,
                                           MathContext mc)

Deprecated.

divideBigDecimals

public static BigDecimal divideBigDecimals(BigDecimal a,
                                           BigDecimal b,
                                           VariableSpace space)

sqrt

public static Object sqrt(ValueMetaInterface metaA,
                          Object dataA)
                   throws KettleValueException

Throws:

KettleValueException

percent1

@Deprecated
public static Object percent1(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB)
                       throws KettleValueException

Deprecated.

100 * A / B

Parameters:

metaA -

dataA -

metaB -

dataB -

Returns:

Throws:

KettleValueException

percent1

public static Object percent1(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB,
                              VariableSpace space)
                       throws KettleValueException

Throws:

KettleValueException

percent2

@Deprecated
public static Object percent2(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB)
                       throws KettleValueException

Deprecated.

A - ( A * B / 100 )

Parameters:

metaA -

dataA -

metaB -

dataB -

Returns:

Throws:

KettleValueException

percent2

public static Object percent2(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB,
                              VariableSpace space)
                       throws KettleValueException

Throws:

KettleValueException

percent3

@Deprecated
public static Object percent3(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB)
                       throws KettleValueException

Deprecated.

A + ( A * B / 100 )

Parameters:

metaA -

dataA -

metaB -

dataB -

Returns:

Throws:

KettleValueException

percent3

public static Object percent3(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB,
                              VariableSpace space)
                       throws KettleValueException

Throws:

KettleValueException

combination1

public static Object combination1(ValueMetaInterface metaA,
                                  Object dataA,
                                  ValueMetaInterface metaB,
                                  Object dataB,
                                  ValueMetaInterface metaC,
                                  Object dataC)
                           throws KettleValueException

A + B * C

Parameters:

metaA -

dataA -

metaB -

dataB -

Returns:

Throws:

KettleValueException

combination2

public static Object combination2(ValueMetaInterface metaA,
                                  Object dataA,
                                  ValueMetaInterface metaB,
                                  Object dataB)
                           throws KettleValueException

SQRT( A*A + B*B )

Parameters:

metaA -

dataA -

metaB -

dataB -

Returns:

Throws:

KettleValueException

round

public static Object round(ValueMetaInterface metaA,
                           Object dataA)
                    throws KettleValueException

Rounding with no decimal places (using default rounding method ROUND_HALF_CEILING)

Parameters:

metaA - Metadata of value to round

dataA - Value to round

Returns:

The rounded value

Throws:

KettleValueException

round

public static Object round(ValueMetaInterface metaA,
                           Object dataA,
                           int roundingMode)
                    throws KettleValueException

Rounding with no decimal places with a given rounding method

Parameters:

metaA - Metadata of value to round

dataA - Value to round

roundingMode - The mode for rounding, e.g. java.math.BigDecimal.ROUND_HALF_EVEN

Returns:

The rounded value

Throws:

KettleValueException

round

public static Object round(ValueMetaInterface metaA,
                           Object dataA,
                           ValueMetaInterface metaB,
                           Object dataB)
                    throws KettleValueException

Rounding with decimal places (using default rounding method ROUND_HALF_EVEN)

Parameters:

metaA - Metadata of value to round

dataA - Value to round

metaB - Metadata of decimal places

dataB - decimal places

Returns:

The rounded value

Throws:

KettleValueException

round

public static Object round(ValueMetaInterface metaA,
                           Object dataA,
                           ValueMetaInterface metaB,
                           Object dataB,
                           int roundingMode)
                    throws KettleValueException

Rounding with decimal places with a given rounding method

Parameters:

metaA - Metadata of value to round

dataA - Value to round

metaB - Metadata of decimal places

dataB - decimal places

roundingMode - roundingMode The mode for rounding, e.g. java.math.BigDecimal.ROUND_HALF_EVEN

Returns:

The rounded value

Throws:

KettleValueException

round

public static Object round(ValueMetaInterface metaA,
                           Object dataA,
                           ValueMetaInterface metaB,
                           Object dataB,
                           ValueMetaInterface metaC,
                           Object dataC)
                    throws KettleValueException

Rounding with decimal places with a given rounding method

Parameters:

metaA - Metadata of value to round

dataA - Value to round

metaB - Metadata of decimal places

dataB - decimal places

metaC - Metadata of rounding mode

dataC - rounding mode, e.g. java.math.BigDecimal.ROUND_HALF_EVEN

Returns:

The rounded value

Throws:

KettleValueException

ceil

public static Object ceil(ValueMetaInterface metaA,
                          Object dataA)
                   throws KettleValueException

Throws:

KettleValueException

floor

public static Object floor(ValueMetaInterface metaA,
                           Object dataA)
                    throws KettleValueException

Throws:

KettleValueException

abs

public static Object abs(ValueMetaInterface metaA,
                         Object dataA)
                  throws KettleValueException

Throws:

KettleValueException

remainder

public static Object remainder(ValueMetaInterface metaA,
                               Object dataA,
                               ValueMetaInterface metaB,
                               Object dataB)
                        throws KettleValueException

Returns the remainder (modulus) of A / B.

Parameters:

metaA -

dataA - The dividend

metaB -

dataB - The divisor

Returns:

The remainder

Throws:

KettleValueException

nvl

public static Object nvl(ValueMetaInterface metaA,
                         Object dataA,
                         ValueMetaInterface metaB,
                         Object dataB)
                  throws KettleValueException

Throws:

KettleValueException

removeTimeFromDate

public static Object removeTimeFromDate(ValueMetaInterface metaA,
                                        Object dataA)
                                 throws KettleValueException

Throws:

KettleValueException

addTimeToDate

public static Object addTimeToDate(ValueMetaInterface metaA,
                                   Object dataA,
                                   ValueMetaInterface metaB,
                                   Object dataB,
                                   ValueMetaInterface metaC,
                                   Object dataC)
                            throws KettleValueException

Throws:

KettleValueException

addDays

public static Object addDays(ValueMetaInterface metaA,
                             Object dataA,
                             ValueMetaInterface metaB,
                             Object dataB)
                      throws KettleValueException

Throws:

KettleValueException

addHours

public static Object addHours(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB)
                       throws KettleValueException

Throws:

KettleValueException

addMinutes

public static Object addMinutes(ValueMetaInterface metaA,
                                Object dataA,
                                ValueMetaInterface metaB,
                                Object dataB)
                         throws KettleValueException

Throws:

KettleValueException

addSeconds

public static Object addSeconds(ValueMetaInterface metaA,
                                Object dataA,
                                ValueMetaInterface metaB,
                                Object dataB)
                         throws KettleValueException

Throws:

KettleValueException

addMonths

public static Object addMonths(ValueMetaInterface metaA,
                               Object dataA,
                               ValueMetaInterface metaB,
                               Object dataB)
                        throws KettleValueException

Throws:

KettleValueException

DateDiff

public static Object DateDiff(ValueMetaInterface metaA,
                              Object dataA,
                              ValueMetaInterface metaB,
                              Object dataB,
                              String resultType)
                       throws KettleValueException

Returns the number of days that have elapsed between dataA and dataB.

Parameters:

metaA -

dataA - The "end date"

metaB -

dataB - The "start date"

resultType - The "result type" (ms, s, mn, h, d)

Returns:

Number of days

Throws:

KettleValueException

DateWorkingDiff

public static Object DateWorkingDiff(ValueMetaInterface metaA,
                                     Object dataA,
                                     ValueMetaInterface metaB,
                                     Object dataB)
                              throws KettleValueException

Throws:

KettleValueException

yearOfDate

public static Object yearOfDate(ValueMetaInterface metaA,
                                Object dataA)
                         throws KettleValueException

Throws:

KettleValueException

monthOfDate

public static Object monthOfDate(ValueMetaInterface metaA,
                                 Object dataA)
                          throws KettleValueException

Throws:

KettleValueException

quarterOfDate

public static Object quarterOfDate(ValueMetaInterface metaA,
                                   Object dataA)
                            throws KettleValueException

Throws:

KettleValueException

dayOfYear

public static Object dayOfYear(ValueMetaInterface metaA,
                               Object dataA)
                        throws KettleValueException

Throws:

KettleValueException

dayOfMonth

public static Object dayOfMonth(ValueMetaInterface metaA,
                                Object dataA)
                         throws KettleValueException

Throws:

KettleValueException

hourOfDay

public static Object hourOfDay(ValueMetaInterface metaA,
                               Object dataA)
                        throws KettleValueException

Throws:

KettleValueException

minuteOfHour

public static Object minuteOfHour(ValueMetaInterface metaA,
                                  Object dataA)
                           throws KettleValueException

Throws:

KettleValueException

secondOfMinute

public static Object secondOfMinute(ValueMetaInterface metaA,
                                    Object dataA)
                             throws KettleValueException

Throws:

KettleValueException

dayOfWeek

public static Object dayOfWeek(ValueMetaInterface metaA,
                               Object dataA)
                        throws KettleValueException

Throws:

KettleValueException

weekOfYear

public static Object weekOfYear(ValueMetaInterface metaA,
                                Object dataA)
                         throws KettleValueException

Throws:

KettleValueException

weekOfYearISO8601

public static Object weekOfYearISO8601(ValueMetaInterface metaA,
                                       Object dataA)
                                throws KettleValueException

Throws:

KettleValueException

yearOfDateISO8601

public static Object yearOfDateISO8601(ValueMetaInterface metaA,
                                       Object dataA)
                                throws KettleValueException

Throws:

KettleValueException

hexToByteDecode

public static String hexToByteDecode(ValueMetaInterface meta,
                                     Object data)
                              throws KettleValueException

Change a hexadecimal string into normal ASCII representation. E.g. if Value contains string "61" afterwards it would contain value "a". If the hexadecimal string is of odd length a leading zero will be used. Note that only the low byte of a character will be processed, this is for binary transformations.

Returns:

Value itself

Throws:

KettleValueException

byteToHexEncode

public static String byteToHexEncode(ValueMetaInterface metaA,
                                     Object dataA)
                              throws KettleValueException

Change a string into its hexadecimal representation. E.g. if Value contains string "a" afterwards it would contain value "0061". Note that transformations happen in groups of 4 hex characters, so the value of a characters is always in the range 0-65535.

Returns:

Throws:

KettleValueException

charToHexEncode

public static String charToHexEncode(ValueMetaInterface meta,
                                     Object data)
                              throws KettleValueException

Change a string into its hexadecimal representation. E.g. if Value contains string "a" afterwards it would contain value "0061". Note that transformations happen in groups of 4 hex characters, so the value of a characters is always in the range 0-65535.

Returns:

A string with Hex code

Throws:

KettleValueException - In case of a data conversion problem.

hexToCharDecode

public static String hexToCharDecode(ValueMetaInterface meta,
                                     Object data)
                              throws KettleValueException

Change a hexadecimal string into normal ASCII representation. E.g. if Value contains string "61" afterwards it would contain value "a". If the hexadecimal string is of a wrong length leading zeroes will be used. Note that transformations happen in groups of 4 hex characters, so the value of a characters is always in the range 0-65535.

Returns:

A hex-to-char decoded String

Throws:

KettleValueException

rightPad

public static final String rightPad(String ret,
                                    int limit)

Right pad a string: adds spaces to a string until a certain length. If the length is smaller then the limit specified, the String is truncated.

Parameters:

ret - The string to pad

limit - The desired length of the padded string.

Returns:

The padded String.

rightPad

public static final String rightPad(StringBuffer ret,
                                    int limit)

Right pad a StringBuffer: adds spaces to a string until a certain length. If the length is smaller then the limit specified, the String is truncated.

Parameters:

ret - The StringBuffer to pad

limit - The desired length of the padded string.

Returns:

The padded String.

replace

public static final String replace(String string,
                                   String repl,
                                   String with)

Replace value occurances in a String with another value.

Parameters:

string - The original String.

repl - The text to replace

with - The new text bit

Returns:

The resulting string with the text pieces replaced.

replaceBuffer

public static void replaceBuffer(StringBuffer str,
                                 String code,
                                 String repl)

Alternate faster version of string replace using a stringbuffer as input.

Parameters:

str - The string where we want to replace in

code - The code to search for

repl - The replacement string for code

nrSpacesBefore

public static final int nrSpacesBefore(String field)

Count the number of spaces to the left of a text. (leading)

Parameters:

field - The text to examine

Returns:

The number of leading spaces found.

nrSpacesAfter

public static final int nrSpacesAfter(String field)

Count the number of spaces to the right of a text. (trailing)

Parameters:

field - The text to examine

Returns:

The number of trailing spaces found.

onlySpaces

public static final boolean onlySpaces(String str)

Checks whether or not a String consists only of spaces.

Parameters:

str - The string to check

Returns:

true if the string has nothing but spaces.

isXMLFileWellFormed

@Deprecated
public static boolean isXMLFileWellFormed(ValueMetaInterface metaA,
                                          Object dataA)

Deprecated.

Use isXMLFileWellFormed(ValueMetaInterface, Object, boolean) instead

Checks an xml file is well formed.

Parameters:

metaA - The ValueMetaInterface

dataA - The value (filename)

Returns:

true if the file is well formed.

isXMLFileWellFormed

public static boolean isXMLFileWellFormed(ValueMetaInterface metaA,
                                          Object dataA,
                                          boolean failIfNoFile)
                                   throws KettleFileNotFoundException

Checks an xml file is well formed.

Parameters:

metaA - The ValueMetaInterface

dataA - The value (filename)

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

true if the file is well formed.

Throws:

KettleFileNotFoundException

isXMLWellFormed

public static boolean isXMLWellFormed(ValueMetaInterface metaA,
                                      Object dataA)

Checks an xml string is well formed.

Parameters:

metaA - The ValueMetaInterface

dataA - The value (filename)

Returns:

true if the file is well formed.

getFileEncoding

@Deprecated
public static String getFileEncoding(ValueMetaInterface metaA,
                                     Object dataA)
                              throws KettleValueException

Deprecated.

Use getFileEncoding(ValueMetaInterface, Object, boolean) instead

Get file encoding.

Parameters:

metaA - The ValueMetaInterface

dataA - The value (filename)

Returns:

file encoding.

Throws:

KettleValueException

getFileEncoding

public static String getFileEncoding(ValueMetaInterface metaA,
                                     Object dataA,
                                     boolean failIfNoFile)
                              throws KettleValueException,
                                     KettleFileNotFoundException

Get file encoding.

Parameters:

metaA - The ValueMetaInterface

dataA - The value (filename)

failIfNoFile - Indicates if the transformation should fail if no file is found

Returns:

file encoding.

Throws:

KettleFileNotFoundException

KettleValueException

getZeroForValueMetaType

public static Object getZeroForValueMetaType(ValueMetaInterface type)
                                      throws KettleValueException

Default utility method to get exact zero value according to ValueMetaInterface. Using this utility method saves from ClassCastExceptions later.

Parameters:

type -

Returns:

Throws:

KettleValueException