ValueMetaBase

java.lang.Object
- org.pentaho.di.core.row.value.ValueMetaBase

All Implemented Interfaces:

Cloneable, ValueMetaInterface

Direct Known Subclasses:

ValueMeta, ValueMetaBigNumber, ValueMetaBinary, ValueMetaBoolean, ValueMetaDate, ValueMetaInteger, ValueMetaNone, ValueMetaNumber, ValueMetaSerializable, ValueMetaString
```
public class ValueMetaBase
extends Object
implements ValueMetaInterface
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPATIBLE_DATE_FORMAT_PATTERN`
`static String`	`DEFAULT_BIG_NUMBER_FORMAT_MASK`
`static String`	`DEFAULT_BIGNUMBER_PARSE_MASK`
`static String`	`DEFAULT_DATE_FORMAT_MASK`
`static String`	`DEFAULT_DATE_PARSE_MASK`
`static String`	`DEFAULT_INTEGER_FORMAT_MASK`
`static String`	`DEFAULT_INTEGER_PARSE_MASK`
`static String`	`DEFAULT_NUMBER_FORMAT_MASK`
`static String`	`DEFAULT_NUMBER_PARSE_MASK`
`static String`	`DEFAULT_TIMESTAMP_FORMAT_MASK`
`static String`	`DEFAULT_TIMESTAMP_PARSE_MASK`
`static boolean`	`EMPTY_STRING_AND_NULL_ARE_DIFFERENT`
`static String[]`	`SINGLE_BYTE_ENCODINGS`
`static String[]`	`trimTypeCode` The trim type codes
`static String[]`	`trimTypeDesc` The trim description
`static String`	`XML_DATA_TAG`
`static String`	`XML_META_TAG`

Fields inherited from interface org.pentaho.di.core.row.ValueMetaInterface
DEFAULT_INTEGER_LENGTH, SORT_TYPE_ASCENDING, SORT_TYPE_DESCENDING, SORT_TYPE_NOT_SORTED, sortTypeCodes, STORAGE_TYPE_BINARY_STRING, STORAGE_TYPE_INDEXED, STORAGE_TYPE_NORMAL, storageTypeCodes, TRIM_TYPE_BOTH, TRIM_TYPE_LEFT, TRIM_TYPE_NONE, TRIM_TYPE_RIGHT, TYPE_BIGNUMBER, TYPE_BINARY, TYPE_BOOLEAN, TYPE_DATE, TYPE_INET, TYPE_INTEGER, TYPE_NONE, TYPE_NUMBER, TYPE_SERIALIZABLE, TYPE_STRING, TYPE_TIMESTAMP, typeCodes

Constructor Summary

Constructors
Constructor and Description
`ValueMetaBase()`
`ValueMetaBase(DataInputStream inputStream)` Deprecated. in favor of a combination of `ValueMetaFactory`.createValueMeta() and the loadMetaData() method.
`ValueMetaBase(Node node)`
`ValueMetaBase(String name)`
`ValueMetaBase(String name, int type)`
`ValueMetaBase(String name, int type, int storageType)` Deprecated. use `ValueMetaBase(String, int)` and `setStorageType(int)` instead
`ValueMetaBase(String name, int type, int length, int precision)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ValueMetaBase`	`clone()`
`Object`	`cloneValueData(Object object)` Clones the data.
`int`	`compare(Object data1, Object data2)` Compare 2 values of the same data type
`int`	`compare(Object data1, ValueMetaInterface meta2, Object data2)` Compare 2 values of the same data type
`Object`	`convertBinaryStringToNativeType(byte[] binary)` Convert the binary data to the actual data type. - byte[] --> Long (Integer) - byte[] --> Double (Number) - byte[] --> BigDecimal (BigNumber) - byte[] --> Date (Date) - byte[] --> Boolean (Boolean) - byte[] --> byte[] (Binary)
`Object`	`convertData(ValueMetaInterface meta2, Object data2)` Convert the specified data to the data type specified in this object.
`Object`	`convertDataCompatible(ValueMetaInterface meta2, Object data2)` Convert the specified data to the data type specified in this object.
`Object`	`convertDataFromString(String pol, ValueMetaInterface convertMeta, String nullIf, String ifNull, int trim_type)` Convert the specified string to the data type specified in this object.
`Object`	`convertDataUsingConversionMetaData(Object data)` Convert an object to the data type specified in the conversion metadata
`Object`	`convertNormalStorageTypeToBinaryString(Object object)` Convert a normal storage type to a binary string object.
`static Boolean`	`convertStringToBoolean(String string)`
`Object`	`convertToBinaryStringStorageType(Object object)` Converts the specified data object to the binary string storage type.
`Object`	`convertToNormalStorageType(Object object)` Converts the specified data object to the normal storage type.
`Value`	`createOriginalValue(Object data)` Create an old-style value for backward compatibility reasons
`void`	`drawValue(PrimitiveGCInterface gc, Object value)` This method draws the value using the supplied graphical context.
`static String[]`	`getAllTypes()` Get an array of String describing the possible types a Value can have.
`BigDecimal`	`getBigNumber(Object object)` Convert the supplied data to a BigNumber
`byte[]`	`getBinary(Object object)` Convert the supplied data to binary data
`byte[]`	`getBinaryString(Object object)` convert the supplied data to a binary string representation (for writing text)
`Boolean`	`getBoolean(Object object)` Convert the supplied data to a Boolean
`Locale`	`getCollatorLocale()` Get the current Locale of the collator
`int`	`getCollatorStrength()` Returns the strength of the collator.
`String`	`getComments()` Gets the comments.
`String`	`getCompatibleString(Object object)` Convert the supplied data to a String compatible with version 2.5.
`String`	`getConversionMask()` Deprecated.
`ValueMetaInterface`	`getConversionMetadata()` This conversion metadata can be attached to a String object to see where it came from and with which mask it was generated, the encoding, the local languages used, padding, etc.
`String`	`getCurrencySymbol()` Gets the currency symbol.
`String`	`getDatabaseColumnTypeDefinition(DatabaseInterface databaseInterface, String tk, String pk, boolean use_autoinc, boolean add_fieldname, boolean add_cr)` Ask for suggestions as to how this plugin data type should be represented in the specified database interface
`String`	`getDataXML(Object object)` Returns an XML representation of the row data.
`Date`	`getDate(Object object)` Convert the supplied data to a Date
`SimpleDateFormat`	`getDateFormat()` Gets the date format.
`Locale`	`getDateFormatLocale()` Returns the locale from the date format.
`TimeZone`	`getDateFormatTimeZone()`
`DecimalFormat`	`getDecimalFormat()` Gets the decimal format.
`DecimalFormat`	`getDecimalFormat(boolean useBigDecimal)` Gets the decimal format.
`String`	`getDecimalSymbol()` Gets the decimal symbol.
`String`	`getFormatMask()` Gets a formatting mask using this value's meta information.
`String`	`getGroupingSymbol()` Gets the grouping symbol.
`Object[]`	`getIndex()` Gets the index.
`Long`	`getInteger(Object object)` Convert the supplied data to an Integer
`int`	`getLength()` Gets the length.
`String`	`getMetaXML()` Returns an XML representation of the row metadata.
`String`	`getName()` Gets the name.
`Object`	`getNativeDataType(Object object)` This method gives you the native Java data type corresponding to the value meta-data.
`Class<?>`	`getNativeDataTypeClass()` Return the Java class that represents the "native" storage type of this ValueMeta
`Double`	`getNumber(Object object)` Convert the supplied data to a Number
`long`	`getNumberOfBinaryStringConversions()` Returns the number of binary string to native data type conversions done with this object conversions
`String`	`getOrigin()` Gets the origin.
`int`	`getOriginalColumnType()` store original JDBC RecordSetMetaData for later use
`String`	`getOriginalColumnTypeName()` Gets the original column type name.
`int`	`getOriginalPrecision()` Gets the original precision.
`int`	`getOriginalScale()` Gets the original scale.
`int`	`getPrecision()` Gets the precision.
`ValueMetaInterface`	`getStorageMetadata()` Returns the storage Meta data that is needed for internal conversion from BinaryString or String to the specified type.
`int`	`getStorageType()` Gets the storage type.
`static int`	`getStorageType(String desc)` Convert the String description of a storage type to an integer type.
`static String`	`getStorageTypeCode(int storageType)`
`String`	`getStorageTypeDesc()` Return the storage type of a value in a textual form: "normal", "binary-string", "indexes"
`String`	`getString(Object object)` Convert the supplied data to a String
`String`	`getStringEncoding()` Gets the string encoding.
`int`	`getTrimType()` Gets the trim type.
`static int`	`getTrimTypeByCode(String tt)`
`static int`	`getTrimTypeByDesc(String tt)`
`static String`	`getTrimTypeCode(int i)`
`static String[]`	`getTrimTypeCodes()`
`static String`	`getTrimTypeDesc(int i)`
`static String[]`	`getTrimTypeDescriptions()`
`int`	`getType()` Gets the type.
`static int`	`getType(String desc)` Convert the String description of a type to an integer type.
`String`	`getTypeDesc()` Return the type of a value in a textual form: "String", "Number", "Integer", "Boolean", "Date", ...
`static String`	`getTypeDesc(int type)` TODO: change Desc to Code all over the place.
`static String[]`	`getTypes()` get an array of String describing the possible types a Value can have.
`Object`	`getValue(Node node)` Convert a data XML node to an Object that corresponds to the metadata.
`Object`	`getValueData(Value value)` Extracts the primitive data from an old style Value object
`Object`	`getValueFromResultSet(DatabaseInterface databaseInterface, ResultSet resultSet, int index)` Get a value from a result set column based on the current value metadata
`ValueMetaInterface`	`getValueFromSQLType(DatabaseMeta databaseMeta, String name, ResultSetMetaData rm, int index, boolean ignoreLength, boolean lazyConversion)` Investigate JDBC result set metadata at the specified index.
`int`	`hashCode(Object object)` Calculate the hashcode of the specified data object
`boolean`	`isBigNumber()` Checks whether or not the value is a Big Number
`boolean`	`isBigNumberFormatting()`
`boolean`	`isBinary()` Checks whether or not this value is of type Binary
`boolean`	`isBoolean()` Checks whether or not this value is a boolean
`boolean`	`isCaseInsensitive()` Returns a true of the value object is case insensitive, false if it is case sensitive,
`boolean`	`isCollatorDisabled()` Returns a true of the value object is case insensitive, false if it is case sensitive,
`boolean`	`isDate()` Checks whether or not this value is a Date
`boolean`	`isDateFormatLenient()` Returns true of the date format is leniant, false if it is strict.
`boolean`	`isInteger()` Checks whether or not this value is an Integer
`boolean`	`isLargeTextField()` Returns true if this is a large text field (CLOB, TEXT) with arbitrary length.
`boolean`	`isLenientStringToNumber()`
`boolean`	`isNull(Object data)` Determine if an object is null.
`boolean`	`isNumber()` Checks whether or not the value is a Number
`boolean`	`isNumeric()` Checks whether or not this Value is Numeric A Value is numeric if it is either of type Number or Integer
`static boolean`	`isNumeric(int t)` Checks whether or not the specified type is either Integer or Number
`boolean`	`isOriginalAutoIncrement()` Checks if is original auto increment.
`int`	`isOriginalNullable()` Checks if is original nullable.
`boolean`	`isOriginalSigned()` Checks if is original signed.
`boolean`	`isOutputPaddingEnabled()` Returns true if output padding is enabled (padding to specified length).
`boolean`	`isSerializableType()` Checks whether or not this value is of type Serializable
`boolean`	`isSingleByteEncoding()`
`boolean`	`isSortedAscending()`
`boolean`	`isSortedDescending()` Returns whether or not the value should be sorted in descending order.
`boolean`	`isStorageBinaryString()` Checks if is storage binary string.
`boolean`	`isStorageIndexed()` Checks if is storage indexed.
`boolean`	`isStorageNormal()` Checks if is storage normal.
`boolean`	`isString()` Checks whether or not the value is a String.
`Object`	`readData(DataInputStream inputStream)` De-serialize data from an inputstream.
`void`	`readMetaData(DataInputStream inputStream)` Load the attributes of this particular value meta object from the input stream.
`boolean`	`requiresRealClone()` Returns true if the data type requires a real copy.
`void`	`setBigNumberFormatting(boolean bigNumberFormatting)`
`void`	`setCaseInsensitive(boolean caseInsensitive)` Sets whether or not the value object is case sensitive.
`void`	`setCollatorDisabled(boolean collatorDisabled)` Sets whether or not the value object should be sorted according to a locale using a collator
`void`	`setCollatorLocale(Locale locale)` Sets the Locale of the collator
`void`	`setCollatorStrength(int collatorStrength)` Sets the strength of the collator.
`void`	`setComments(String comments)` Sets the comments for the object implementing the interface.
`void`	`setConversionMask(String conversionMask)` Sets the conversion mask.
`void`	`setConversionMetadata(ValueMetaInterface conversionMetadata)` Attach conversion metadata to a String object to see where it came from and with which mask it was generated, the encoding, the local languages used, padding, etc.
`void`	`setCurrencySymbol(String currencySymbol)` Sets the currency symbol.
`void`	`setDateFormatLenient(boolean dateFormatLenient)` Set to true if the date formatting (parsing) is to be set to lenient.
`void`	`setDateFormatLocale(Locale dateFormatLocale)` Sets the locale of the date format.
`void`	`setDateFormatTimeZone(TimeZone dateFormatTimeZone)`
`void`	`setDecimalSymbol(String decimalSymbol)` Sets the decimal symbol.
`void`	`setGroupingSymbol(String groupingSymbol)` Sets the grouping symbol.
`void`	`setIndex(Object[] index)` Sets the index.
`void`	`setLargeTextField(boolean largeTextField)` Set to true if the this is to be a large text field (CLOB, TEXT) with arbitrary length.
`void`	`setLength(int length)` Sets the length.
`void`	`setLength(int length, int precision)` Sets the length.
`void`	`setLenientStringToNumber(boolean lenientStringToNumber)`
`void`	`setName(String name)` Sets the name.
`void`	`setNumberOfBinaryStringConversions(long numberOfBinaryStringConversions)` Returns the number of binary string to native data type done with this object conversions to set.
`void`	`setOrigin(String origin)` Sets the origin.
`void`	`setOriginalAutoIncrement(boolean originalAutoIncrement)` Sets the original auto increment.
`void`	`setOriginalColumnType(int originalColumnType)` Sets the original column type.
`void`	`setOriginalColumnTypeName(String originalColumnTypeName)` Sets the original column type name.
`void`	`setOriginalNullable(int originalNullable)` Sets the original nullable.
`void`	`setOriginalPrecision(int originalPrecision)` Sets the original precision.
`void`	`setOriginalScale(int originalScale)` Sets the original scale.
`void`	`setOriginalSigned(boolean originalSigned)` Sets the original signed.
`void`	`setOutputPaddingEnabled(boolean outputPaddingEnabled)` Set to true if output padding is to be enabled (padding to specified length).
`void`	`setPrecision(int precision)` Sets the precision.
`void`	`setPreparedStatementValue(DatabaseMeta databaseMeta, PreparedStatement preparedStatement, int index, Object data)` Set a value on a JDBC prepared statement on the specified position
`void`	`setSortedDescending(boolean sortedDescending)` Sets whether or not the value should be set in a descending order.
`void`	`setStorageMetadata(ValueMetaInterface storageMetadata)` Sets the storage meta data.
`void`	`setStorageType(int storageType)` Sets the storage type.
`void`	`setStringEncoding(String encoding)` Sets the string encoding.
`void`	`setTrimType(int trimType)` Sets the trim type.
`void`	`setType(int type)` Deprecated.
`String`	`toString()`
`String`	`toStringMeta()` a String text representation of this Value, optionally padded to the specified length
`void`	`writeData(DataOutputStream outputStream, Object object)` Serialize the content of the specified data object to the outputStream.
`void`	`writeMeta(DataOutputStream outputStream)` Write the content of this class (metadata) to the specified output stream.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_INTEGER_PARSE_MASK
```
public static final String DEFAULT_INTEGER_PARSE_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NUMBER_PARSE_MASK
```
public static final String DEFAULT_NUMBER_PARSE_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BIGNUMBER_PARSE_MASK
```
public static final String DEFAULT_BIGNUMBER_PARSE_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATE_PARSE_MASK
```
public static final String DEFAULT_DATE_PARSE_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMESTAMP_PARSE_MASK
```
public static final String DEFAULT_TIMESTAMP_PARSE_MASK
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INTEGER_FORMAT_MASK
```
public static final String DEFAULT_INTEGER_FORMAT_MASK
```
  - DEFAULT_NUMBER_FORMAT_MASK
```
public static final String DEFAULT_NUMBER_FORMAT_MASK
```
  - DEFAULT_BIG_NUMBER_FORMAT_MASK
```
public static final String DEFAULT_BIG_NUMBER_FORMAT_MASK
```
  - DEFAULT_DATE_FORMAT_MASK
```
public static final String DEFAULT_DATE_FORMAT_MASK
```
  - DEFAULT_TIMESTAMP_FORMAT_MASK
```
public static final String DEFAULT_TIMESTAMP_FORMAT_MASK
```
  - XML_META_TAG
```
public static final String XML_META_TAG
```
    See Also:
    
    Constant Field Values
  - XML_DATA_TAG
```
public static final String XML_DATA_TAG
```
    See Also:
    
    Constant Field Values
  - COMPATIBLE_DATE_FORMAT_PATTERN
```
public static final String COMPATIBLE_DATE_FORMAT_PATTERN
```
    See Also:
    
    Constant Field Values
  - EMPTY_STRING_AND_NULL_ARE_DIFFERENT
```
public static final boolean EMPTY_STRING_AND_NULL_ARE_DIFFERENT
```
  - trimTypeCode
```
public static final String[] trimTypeCode
```
    The trim type codes
  - trimTypeDesc
```
public static final String[] trimTypeDesc
```
    The trim description
  - SINGLE_BYTE_ENCODINGS
```
public static final String[] SINGLE_BYTE_ENCODINGS
```
- Constructor Detail
  - ValueMetaBase
```
public ValueMetaBase()
```
  - ValueMetaBase
```
public ValueMetaBase(String name)
```
  - ValueMetaBase
```
public ValueMetaBase(String name,
                     int type)
```
  - ValueMetaBase
```
public ValueMetaBase(String name,
                     int type,
                     int length,
                     int precision)
```
  - ValueMetaBase
```
public ValueMetaBase(Node node)
              throws KettleException
```
    Throws:
    
    KettleException
  - ValueMetaBase
```
@Deprecated
public ValueMetaBase(DataInputStream inputStream)
                          throws KettleFileException,
                                 KettleEOFException
```
    Deprecated. in favor of a combination of ValueMetaFactory.createValueMeta() and the loadMetaData() method.
    
    Create a new Value meta object.
    
    Parameters:
    
    inputStream -
    
    Throws:
    
    KettleFileException
    
    KettleEOFException
  - ValueMetaBase
```
@Deprecated
public ValueMetaBase(String name,
                                 int type,
                                 int storageType)
```
    Deprecated. use ValueMetaBase(String, int) and setStorageType(int) instead
    
    Parameters:
    
    name -
    
    type -
    
    storageType -
- Method Detail
  - clone
```
public ValueMetaBase clone()
```
    Specified by:
    
    clone in interface ValueMetaInterface
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a copy of this value meta object
  - getComments
```
public String getComments()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the comments.
    
    Specified by:
    
    getComments in interface ValueMetaInterface
    
    Returns:
    
    the comments
  - setComments
```
public void setComments(String comments)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the comments for the object implementing the interface.
    
    Specified by:
    
    setComments in interface ValueMetaInterface
    
    Parameters:
    
    comments - the comments to set
  - getIndex
```
public Object[] getIndex()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the index.
    
    Specified by:
    
    getIndex in interface ValueMetaInterface
    
    Returns:
    
    the index
  - setIndex
```
public void setIndex(Object[] index)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the index.
    
    Specified by:
    
    setIndex in interface ValueMetaInterface
    
    Parameters:
    
    index - the index to set
  - getLength
```
public int getLength()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the length.
    
    Specified by:
    
    getLength in interface ValueMetaInterface
    
    Returns:
    
    the length
  - setLength
```
public void setLength(int length)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the length.
    
    Specified by:
    
    setLength in interface ValueMetaInterface
    
    Parameters:
    
    length - the length to set
  - setLength
```
public void setLength(int length,
                      int precision)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the length.
    
    Specified by:
    
    setLength in interface ValueMetaInterface
    
    Parameters:
    
    length - the length to set
    
    precision - the precision
  - getName
```
public String getName()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the name.
    
    Specified by:
    
    getName in interface ValueMetaInterface
    
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the name.
    
    Specified by:
    
    setName in interface ValueMetaInterface
    
    Parameters:
    
    name - the name to set
  - getOrigin
```
public String getOrigin()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the origin.
    
    Specified by:
    
    getOrigin in interface ValueMetaInterface
    
    Returns:
    
    the origin
  - setOrigin
```
public void setOrigin(String origin)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the origin.
    
    Specified by:
    
    setOrigin in interface ValueMetaInterface
    
    Parameters:
    
    origin - the origin to set
  - getPrecision
```
public int getPrecision()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the precision.
    
    Specified by:
    
    getPrecision in interface ValueMetaInterface
    
    Returns:
    
    the precision
  - setPrecision
```
public void setPrecision(int precision)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the precision.
    
    Specified by:
    
    setPrecision in interface ValueMetaInterface
    
    Parameters:
    
    precision - the precision to set
  - getStorageType
```
public int getStorageType()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the storage type.
    
    Specified by:
    
    getStorageType in interface ValueMetaInterface
    
    Returns:
    
    the storageType
  - setStorageType
```
public void setStorageType(int storageType)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the storage type.
    
    Specified by:
    
    setStorageType in interface ValueMetaInterface
    
    Parameters:
    
    storageType - the storageType to set
  - isStorageNormal
```
public boolean isStorageNormal()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is storage normal.
    
    Specified by:
    
    isStorageNormal in interface ValueMetaInterface
    
    Returns:
    
    true, if is storage normal
  - isStorageIndexed
```
public boolean isStorageIndexed()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is storage indexed.
    
    Specified by:
    
    isStorageIndexed in interface ValueMetaInterface
    
    Returns:
    
    true, if is storage indexed
  - isStorageBinaryString
```
public boolean isStorageBinaryString()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is storage binary string.
    
    Specified by:
    
    isStorageBinaryString in interface ValueMetaInterface
    
    Returns:
    
    true, if is storage binary string
  - getType
```
public int getType()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the type.
    
    Specified by:
    
    getType in interface ValueMetaInterface
    
    Returns:
    
    the type
  - setType
```
@Deprecated
public void setType(int type)
```
    Deprecated.
    
    Description copied from interface: ValueMetaInterface
    
    Sets the type.
    
    Specified by:
    
    setType in interface ValueMetaInterface
    
    Parameters:
    
    type - the type to set
  - getConversionMask
```
@Deprecated
public String getConversionMask()
```
    Deprecated.
    
    Description copied from interface: ValueMetaInterface
    
    Gets the conversion mask.
    
    Specified by:
    
    getConversionMask in interface ValueMetaInterface
    
    Returns:
    
    the conversionMask
  - setConversionMask
```
public void setConversionMask(String conversionMask)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the conversion mask.
    
    Specified by:
    
    setConversionMask in interface ValueMetaInterface
    
    Parameters:
    
    conversionMask - the conversionMask to set
  - getStringEncoding
```
public String getStringEncoding()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the string encoding.
    
    Specified by:
    
    getStringEncoding in interface ValueMetaInterface
    
    Returns:
    
    the encoding
  - setStringEncoding
```
public void setStringEncoding(String encoding)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the string encoding.
    
    Specified by:
    
    setStringEncoding in interface ValueMetaInterface
    
    Parameters:
    
    encoding - the encoding to set
  - getDecimalSymbol
```
public String getDecimalSymbol()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the decimal symbol.
    
    Specified by:
    
    getDecimalSymbol in interface ValueMetaInterface
    
    Returns:
    
    the decimalSymbol
  - setDecimalSymbol
```
public void setDecimalSymbol(String decimalSymbol)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the decimal symbol.
    
    Specified by:
    
    setDecimalSymbol in interface ValueMetaInterface
    
    Parameters:
    
    decimalSymbol - the decimalSymbol to set
  - getGroupingSymbol
```
public String getGroupingSymbol()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the grouping symbol.
    
    Specified by:
    
    getGroupingSymbol in interface ValueMetaInterface
    
    Returns:
    
    the groupingSymbol
  - setGroupingSymbol
```
public void setGroupingSymbol(String groupingSymbol)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the grouping symbol.
    
    Specified by:
    
    setGroupingSymbol in interface ValueMetaInterface
    
    Parameters:
    
    groupingSymbol - the groupingSymbol to set
  - getCurrencySymbol
```
public String getCurrencySymbol()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the currency symbol.
    
    Specified by:
    
    getCurrencySymbol in interface ValueMetaInterface
    
    Returns:
    
    the currencySymbol
  - setCurrencySymbol
```
public void setCurrencySymbol(String currencySymbol)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the currency symbol.
    
    Specified by:
    
    setCurrencySymbol in interface ValueMetaInterface
    
    Parameters:
    
    currencySymbol - the currencySymbol to set
  - isCaseInsensitive
```
public boolean isCaseInsensitive()
```
    Description copied from interface: ValueMetaInterface
    
    Returns a true of the value object is case insensitive, false if it is case sensitive,
    
    Specified by:
    
    isCaseInsensitive in interface ValueMetaInterface
    
    Returns:
    
    the caseInsensitive
  - setCaseInsensitive
```
public void setCaseInsensitive(boolean caseInsensitive)
```
    Description copied from interface: ValueMetaInterface
    
    Sets whether or not the value object is case sensitive. This information is useful if the value is involved in string comparisons.
    
    Specified by:
    
    setCaseInsensitive in interface ValueMetaInterface
    
    Parameters:
    
    caseInsensitive - the caseInsensitive to set
  - isCollatorDisabled
```
public boolean isCollatorDisabled()
```
    Description copied from interface: ValueMetaInterface
    
    Returns a true of the value object is case insensitive, false if it is case sensitive,
    
    Specified by:
    
    isCollatorDisabled in interface ValueMetaInterface
    
    Returns:
    
    the collatorDisabled
  - setCollatorDisabled
```
public void setCollatorDisabled(boolean collatorDisabled)
```
    Description copied from interface: ValueMetaInterface
    
    Sets whether or not the value object should be sorted according to a locale using a collator
    
    Specified by:
    
    setCollatorDisabled in interface ValueMetaInterface
    
    Parameters:
    
    collatorDisabled - the collatorDisabled to set
  - getCollatorLocale
```
public Locale getCollatorLocale()
```
    Description copied from interface: ValueMetaInterface
    
    Get the current Locale of the collator
    
    Specified by:
    
    getCollatorLocale in interface ValueMetaInterface
    
    Returns:
    
    the current Collator Locale
  - setCollatorLocale
```
public void setCollatorLocale(Locale locale)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the Locale of the collator
    
    Specified by:
    
    setCollatorLocale in interface ValueMetaInterface
  - getCollatorStrength
```
public int getCollatorStrength()
```
    Description copied from interface: ValueMetaInterface
    
    Returns the strength of the collator.
    
    Specified by:
    
    getCollatorStrength in interface ValueMetaInterface
    
    Returns:
    
    the collatorStrength
  - setCollatorStrength
```
public void setCollatorStrength(int collatorStrength)
                         throws IllegalArgumentException
```
    Description copied from interface: ValueMetaInterface
    
    Sets the strength of the collator.
    
    Specified by:
    
    setCollatorStrength in interface ValueMetaInterface
    
    Parameters:
    
    collatorStrength - the collatorStrength to set
    
    Throws:
    
    IllegalArgumentException
  - isSortedDescending
```
public boolean isSortedDescending()
```
    Description copied from interface: ValueMetaInterface
    
    Returns whether or not the value should be sorted in descending order.
    
    Specified by:
    
    isSortedDescending in interface ValueMetaInterface
    
    Returns:
    
    the sortedDescending
  - setSortedDescending
```
public void setSortedDescending(boolean sortedDescending)
```
    Description copied from interface: ValueMetaInterface
    
    Sets whether or not the value should be set in a descending order.
    
    Specified by:
    
    setSortedDescending in interface ValueMetaInterface
    
    Parameters:
    
    sortedDescending - the sortedDescending to set
  - isOutputPaddingEnabled
```
public boolean isOutputPaddingEnabled()
```
    Description copied from interface: ValueMetaInterface
    
    Returns true if output padding is enabled (padding to specified length).
    
    Specified by:
    
    isOutputPaddingEnabled in interface ValueMetaInterface
    
    Returns:
    
    true if output padding is enabled (padding to specified length)
  - setOutputPaddingEnabled
```
public void setOutputPaddingEnabled(boolean outputPaddingEnabled)
```
    Description copied from interface: ValueMetaInterface
    
    Set to true if output padding is to be enabled (padding to specified length).
    
    Specified by:
    
    setOutputPaddingEnabled in interface ValueMetaInterface
    
    Parameters:
    
    outputPaddingEnabled - Set to true if output padding is to be enabled (padding to specified length)
  - isLargeTextField
```
public boolean isLargeTextField()
```
    Description copied from interface: ValueMetaInterface
    
    Returns true if this is a large text field (CLOB, TEXT) with arbitrary length.
    
    Specified by:
    
    isLargeTextField in interface ValueMetaInterface
    
    Returns:
    
    true if this is a large text field (CLOB, TEXT) with arbitrary length.
  - setLargeTextField
```
public void setLargeTextField(boolean largeTextField)
```
    Description copied from interface: ValueMetaInterface
    
    Set to true if the this is to be a large text field (CLOB, TEXT) with arbitrary length.
    
    Specified by:
    
    setLargeTextField in interface ValueMetaInterface
    
    Parameters:
    
    largeTextField - Set to true if this is to be a large text field (CLOB, TEXT) with arbitrary length.
  - isDateFormatLenient
```
public boolean isDateFormatLenient()
```
    Description copied from interface: ValueMetaInterface
    
    Returns true of the date format is leniant, false if it is strict.
    See also ValueMetaInterface.setDateFormatLenient(boolean)
    
    Specified by:
    
    isDateFormatLenient in interface ValueMetaInterface
    
    Returns:
    
    the dateFormatLenient
  - setDateFormatLenient
```
public void setDateFormatLenient(boolean dateFormatLenient)
```
    Description copied from interface: ValueMetaInterface
    Set to true if the date formatting (parsing) is to be set to lenient. Being lenient means that the "date format" is tolerant to some formatting errors. For example, a month specified as "15" will be interpreted as "March":
```
 15 - (December = 12) = 3 = March.
 
```
    Set to false for stricter formatting validation.
    Specified by:
    
    setDateFormatLenient in interface ValueMetaInterface
    
    Parameters:
    
    dateFormatLenient - the dateFormatLenient to set
  - getDateFormatLocale
```
public Locale getDateFormatLocale()
```
    Description copied from interface: ValueMetaInterface
    
    Returns the locale from the date format.
    
    Specified by:
    
    getDateFormatLocale in interface ValueMetaInterface
    
    Returns:
    
    the dateFormatLocale
  - setDateFormatLocale
```
public void setDateFormatLocale(Locale dateFormatLocale)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the locale of the date format.
    
    Specified by:
    
    setDateFormatLocale in interface ValueMetaInterface
    
    Parameters:
    
    dateFormatLocale - the dateFormatLocale to set
  - getDateFormat
```
public SimpleDateFormat getDateFormat()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the date format.
    
    Specified by:
    
    getDateFormat in interface ValueMetaInterface
    
    Returns:
    
    the date format
  - getDecimalFormat
```
public DecimalFormat getDecimalFormat()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the decimal format.
    
    Specified by:
    
    getDecimalFormat in interface ValueMetaInterface
    
    Returns:
    
    the decimal format
  - getDecimalFormat
```
public DecimalFormat getDecimalFormat(boolean useBigDecimal)
```
    Description copied from interface: ValueMetaInterface
    
    Gets the decimal format.
    
    Specified by:
    
    getDecimalFormat in interface ValueMetaInterface
    
    Parameters:
    
    useBigDecimal - the use big decimal
    
    Returns:
    
    the decimal format
  - getFormatMask
```
public String getFormatMask()
```
    Description copied from interface: ValueMetaInterface
    
    Gets a formatting mask using this value's meta information.
    
    Specified by:
    
    getFormatMask in interface ValueMetaInterface
    
    Returns:
    
    the format mask.
  - convertStringToBoolean
```
public static Boolean convertStringToBoolean(String string)
```
  - convertToNormalStorageType
```
public Object convertToNormalStorageType(Object object)
                                  throws KettleValueException
```
    Converts the specified data object to the normal storage type.
    
    Specified by:
    
    convertToNormalStorageType in interface ValueMetaInterface
    
    Parameters:
    
    object - the data object to convert
    
    Returns:
    
    the data in a normal storage type
    
    Throws:
    
    KettleValueException - In case there is a data conversion error.
  - convertToBinaryStringStorageType
```
public Object convertToBinaryStringStorageType(Object object)
                                        throws KettleValueException
```
    Converts the specified data object to the binary string storage type.
    
    Specified by:
    
    convertToBinaryStringStorageType in interface ValueMetaInterface
    
    Parameters:
    
    object - the data object to convert
    
    Returns:
    
    the data in a binary string storage type
    
    Throws:
    
    KettleValueException - In case there is a data conversion error.
  - convertBinaryStringToNativeType
```
public Object convertBinaryStringToNativeType(byte[] binary)
                                       throws KettleValueException
```
    Convert the binary data to the actual data type.
    - byte[] --> Long (Integer) - byte[] --> Double (Number) - byte[] --> BigDecimal (BigNumber) - byte[] --> Date (Date) - byte[] --> Boolean (Boolean) - byte[] --> byte[] (Binary)
    
    Specified by:
    
    convertBinaryStringToNativeType in interface ValueMetaInterface
    
    Parameters:
    
    binary -
    
    Returns:
    
    Throws:
    
    KettleValueException
  - convertNormalStorageTypeToBinaryString
```
public Object convertNormalStorageTypeToBinaryString(Object object)
                                              throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert a normal storage type to a binary string object. (for comparison reasons)
    
    Specified by:
    
    convertNormalStorageTypeToBinaryString in interface ValueMetaInterface
    
    Parameters:
    
    object - The object expressed in a normal storage type
    
    Returns:
    
    a binary string
    
    Throws:
    
    KettleValueException - in case there is a data conversion error
  - cloneValueData
```
public Object cloneValueData(Object object)
                      throws KettleValueException
```
    Clones the data. Normally, we don't have to do anything here, but just for arguments and safety, we do a little extra work in case of binary blobs and Date objects. We should write a programmers manual later on to specify in all clarity that "we always overwrite/replace values in the Object[] data rows, we never modify them" .
    
    Specified by:
    
    cloneValueData in interface ValueMetaInterface
    
    Parameters:
    
    object - the object
    
    Returns:
    
    a cloned data object if needed
    
    Throws:
    
    KettleValueException - the kettle value exception
  - getCompatibleString
```
public String getCompatibleString(Object object)
                           throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a String compatible with version 2.5.
    
    Specified by:
    
    getCompatibleString in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getString
```
public String getString(Object object)
                 throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a String
    
    Specified by:
    
    getString in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getNumber
```
public Double getNumber(Object object)
                 throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a Number
    
    Specified by:
    
    getNumber in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getInteger
```
public Long getInteger(Object object)
                throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to an Integer
    
    Specified by:
    
    getInteger in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getBigNumber
```
public BigDecimal getBigNumber(Object object)
                        throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a BigNumber
    
    Specified by:
    
    getBigNumber in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getBoolean
```
public Boolean getBoolean(Object object)
                   throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a Boolean
    
    Specified by:
    
    getBoolean in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getDate
```
public Date getDate(Object object)
             throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to a Date
    
    Specified by:
    
    getDate in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getBinary
```
public byte[] getBinary(Object object)
                 throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Convert the supplied data to binary data
    
    Specified by:
    
    getBinary in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - getBinaryString
```
public byte[] getBinaryString(Object object)
                       throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    convert the supplied data to a binary string representation (for writing text)
    
    Specified by:
    
    getBinaryString in interface ValueMetaInterface
    
    Throws:
    
    KettleValueException
  - isString
```
public boolean isString()
```
    Checks whether or not the value is a String.
    
    Specified by:
    
    isString in interface ValueMetaInterface
    
    Returns:
    
    true if the value is a String.
  - isDate
```
public boolean isDate()
```
    Checks whether or not this value is a Date
    
    Specified by:
    
    isDate in interface ValueMetaInterface
    
    Returns:
    
    true if the value is a Date
  - isBigNumber
```
public boolean isBigNumber()
```
    Checks whether or not the value is a Big Number
    
    Specified by:
    
    isBigNumber in interface ValueMetaInterface
    
    Returns:
    
    true is this value is a big number
  - isNumber
```
public boolean isNumber()
```
    Checks whether or not the value is a Number
    
    Specified by:
    
    isNumber in interface ValueMetaInterface
    
    Returns:
    
    true is this value is a number
  - isBoolean
```
public boolean isBoolean()
```
    Checks whether or not this value is a boolean
    
    Specified by:
    
    isBoolean in interface ValueMetaInterface
    
    Returns:
    
    true if this value has type boolean.
  - isSerializableType
```
public boolean isSerializableType()
```
    Checks whether or not this value is of type Serializable
    
    Specified by:
    
    isSerializableType in interface ValueMetaInterface
    
    Returns:
    
    true if this value has type Serializable
  - isBinary
```
public boolean isBinary()
```
    Checks whether or not this value is of type Binary
    
    Specified by:
    
    isBinary in interface ValueMetaInterface
    
    Returns:
    
    true if this value has type Binary
  - isInteger
```
public boolean isInteger()
```
    Checks whether or not this value is an Integer
    
    Specified by:
    
    isInteger in interface ValueMetaInterface
    
    Returns:
    
    true if this value is an integer
  - isNumeric
```
public boolean isNumeric()
```
    Checks whether or not this Value is Numeric A Value is numeric if it is either of type Number or Integer
    
    Specified by:
    
    isNumeric in interface ValueMetaInterface
    
    Returns:
    
    true if the value is either of type Number or Integer
  - isNumeric
```
public static final boolean isNumeric(int t)
```
    Checks whether or not the specified type is either Integer or Number
    
    Parameters:
    
    t - the type to check
    
    Returns:
    
    true if the type is Integer or Number
  - isSortedAscending
```
public boolean isSortedAscending()
```
  - getTypeDesc
```
public String getTypeDesc()
```
    Return the type of a value in a textual form: "String", "Number", "Integer", "Boolean", "Date", ...
    
    Specified by:
    
    getTypeDesc in interface ValueMetaInterface
    
    Returns:
    
    A String describing the type of value.
  - getStorageTypeDesc
```
public String getStorageTypeDesc()
```
    Return the storage type of a value in a textual form: "normal", "binary-string", "indexes"
    
    Returns:
    
    A String describing the storage type of the value metadata
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringMeta
```
public String toStringMeta()
```
    a String text representation of this Value, optionally padded to the specified length
    
    Specified by:
    
    toStringMeta in interface ValueMetaInterface
    
    Returns:
    
    a String text representation of this Value, optionally padded to the specified length
  - writeData
```
public void writeData(DataOutputStream outputStream,
                      Object object)
               throws KettleFileException
```
    Description copied from interface: ValueMetaInterface
    
    Serialize the content of the specified data object to the outputStream. No metadata is written.
    
    Specified by:
    
    writeData in interface ValueMetaInterface
    
    Parameters:
    
    outputStream - the outputstream to write to
    
    object - the data object to serialize
    
    Throws:
    
    KettleFileException - in case a I/O error occurs
  - readData
```
public Object readData(DataInputStream inputStream)
                throws KettleFileException,
                       KettleEOFException,
                       SocketTimeoutException
```
    Description copied from interface: ValueMetaInterface
    
    De-serialize data from an inputstream. No metadata is read or changed.
    
    Specified by:
    
    readData in interface ValueMetaInterface
    
    Parameters:
    
    inputStream - the input stream to read from
    
    Returns:
    
    a new data object
    
    Throws:
    
    KettleFileException - in case a I/O error occurs
    
    KettleEOFException - When we have read all the data there is to read
    
    SocketTimeoutException - In case there is a timeout (when set on a socket) during reading
  - writeMeta
```
public void writeMeta(DataOutputStream outputStream)
               throws KettleFileException
```
    Description copied from interface: ValueMetaInterface
    
    Write the content of this class (metadata) to the specified output stream.
    
    Specified by:
    
    writeMeta in interface ValueMetaInterface
    
    Parameters:
    
    outputStream - the outputstream to write to
    
    Throws:
    
    KettleFileException - in case a I/O error occurs
  - readMetaData
```
public void readMetaData(DataInputStream inputStream)
                  throws KettleFileException,
                         KettleEOFException
```
    Load the attributes of this particular value meta object from the input stream. Loading the type is not handled here, this should be read from the stream previously!
    
    Specified by:
    
    readMetaData in interface ValueMetaInterface
    
    Parameters:
    
    inputStream - the input stream to read from
    
    Throws:
    
    KettleFileException - In case there was a IO problem
    
    KettleEOFException - If we reached the end of the stream
  - getMetaXML
```
public String getMetaXML()
                  throws IOException
```
    Description copied from interface: ValueMetaInterface
    
    Returns an XML representation of the row metadata.
    
    Specified by:
    
    getMetaXML in interface ValueMetaInterface
    
    Returns:
    
    an XML representation of the row metadata
    
    Throws:
    
    IOException - Thrown in case there is an (Base64/GZip) decoding problem
  - getDataXML
```
public String getDataXML(Object object)
                  throws IOException
```
    Description copied from interface: ValueMetaInterface
    
    Returns an XML representation of the row data.
    
    Specified by:
    
    getDataXML in interface ValueMetaInterface
    
    Parameters:
    
    object - The data to serialize as XML
    
    Returns:
    
    an XML representation of the row data
    
    Throws:
    
    IOException - Thrown in case there is an (Base64/GZip) decoding problem
  - getValue
```
public Object getValue(Node node)
                throws KettleException
```
    Convert a data XML node to an Object that corresponds to the metadata. This is basically String to Object conversion that is being done.
    
    Specified by:
    
    getValue in interface ValueMetaInterface
    
    Parameters:
    
    node - the node to retrieve the data value from
    
    Returns:
    
    the converted data value
    
    Throws:
    
    IOException - thrown in case there is a problem with the XML to object conversion
    
    KettleException - thrown in case there is a problem with the XML to object conversion
  - getTypes
```
public static final String[] getTypes()
```
    get an array of String describing the possible types a Value can have.
    
    Returns:
    
    an array of String describing the possible types a Value can have.
  - getAllTypes
```
public static final String[] getAllTypes()
```
    Get an array of String describing the possible types a Value can have.
    
    Returns:
    
    an array of String describing the possible types a Value can have.
  - getTypeDesc
```
public static final String getTypeDesc(int type)
```
    TODO: change Desc to Code all over the place. Make sure we can localise this stuff later on.
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the description (code) of the type
  - getType
```
public static final int getType(String desc)
```
    Convert the String description of a type to an integer type.
    
    Parameters:
    
    desc - The description of the type to convert
    
    Returns:
    
    The integer type of the given String. (ValueMetaInterface.TYPE_...)
  - getStorageType
```
public static final int getStorageType(String desc)
```
    Convert the String description of a storage type to an integer type.
    
    Parameters:
    
    desc - The description of the storage type to convert
    
    Returns:
    
    The integer storage type of the given String. (ValueMetaInterface.STORAGE_TYPE_...) or -1 if the storage type code not be found.
  - getStorageTypeCode
```
public static final String getStorageTypeCode(int storageType)
```
  - isNull
```
public boolean isNull(Object data)
               throws KettleValueException
```
    Determine if an object is null. This is the case if data==null or if it's an empty string.
    
    Specified by:
    
    isNull in interface ValueMetaInterface
    
    Parameters:
    
    data - the object to test
    
    Returns:
    
    true if the object is considered null.
    
    Throws:
    
    KettleValueException - in case there is a conversion error (only thrown in case of lazy conversion)
  - compare
```
public int compare(Object data1,
                   Object data2)
            throws KettleValueException
```
    Compare 2 values of the same data type
    
    Specified by:
    
    compare in interface ValueMetaInterface
    
    Parameters:
    
    data1 - the first value
    
    data2 - the second value
    
    Returns:
    
    0 if the values are equal, -1 if data1 is smaller than data2 and +1 if it's larger.
    
    Throws:
    
    KettleValueException - In case we get conversion errors
  - compare
```
public int compare(Object data1,
                   ValueMetaInterface meta2,
                   Object data2)
            throws KettleValueException
```
    Compare 2 values of the same data type
    
    Specified by:
    
    compare in interface ValueMetaInterface
    
    Parameters:
    
    data1 - the first value
    
    meta2 - the second value's metadata
    
    data2 - the second value
    
    Returns:
    
    0 if the values are equal, -1 if data1 is smaller than data2 and +1 if it's larger.
    
    Throws:
    
    KettleValueException - In case we get conversion errors
  - convertData
```
public Object convertData(ValueMetaInterface meta2,
                          Object data2)
                   throws KettleValueException
```
    Convert the specified data to the data type specified in this object.
    
    Specified by:
    
    convertData in interface ValueMetaInterface
    
    Parameters:
    
    meta2 - the metadata of the object to be converted
    
    data2 - the data of the object to be converted
    
    Returns:
    
    the object in the data type of this value metadata object
    
    Throws:
    
    KettleValueException - in case there is a data conversion error
  - convertDataCompatible
```
public Object convertDataCompatible(ValueMetaInterface meta2,
                                    Object data2)
                             throws KettleValueException
```
    Convert the specified data to the data type specified in this object. For String conversion, be compatible with version 2.5.2.
    
    Specified by:
    
    convertDataCompatible in interface ValueMetaInterface
    
    Parameters:
    
    meta2 - the metadata of the object to be converted
    
    data2 - the data of the object to be converted
    
    Returns:
    
    the object in the data type of this value metadata object
    
    Throws:
    
    KettleValueException - in case there is a data conversion error
  - convertDataUsingConversionMetaData
```
public Object convertDataUsingConversionMetaData(Object data)
                                          throws KettleValueException
```
    Convert an object to the data type specified in the conversion metadata
    
    Specified by:
    
    convertDataUsingConversionMetaData in interface ValueMetaInterface
    
    Parameters:
    
    data - The data
    
    Returns:
    
    The data converted to the storage data type
    
    Throws:
    
    KettleValueException - in case there is a conversion error.
  - convertDataFromString
```
public Object convertDataFromString(String pol,
                                    ValueMetaInterface convertMeta,
                                    String nullIf,
                                    String ifNull,
                                    int trim_type)
                             throws KettleValueException
```
    Convert the specified string to the data type specified in this object.
    
    Specified by:
    
    convertDataFromString in interface ValueMetaInterface
    
    Parameters:
    
    pol - the string to be converted
    
    convertMeta - the metadata of the object (only string type) to be converted
    
    nullIf - set the object to null if pos equals nullif (IgnoreCase)
    
    ifNull - set the object to ifNull when pol is empty or null
    
    trim_type - the trim type to be used (ValueMetaInterface.TRIM_TYPE_XXX)
    
    Returns:
    
    the object in the data type of this value metadata object
    
    Throws:
    
    KettleValueException - in case there is a data conversion error
  - hashCode
```
public int hashCode(Object object)
             throws KettleValueException
```
    Calculate the hashcode of the specified data object
    
    Specified by:
    
    hashCode in interface ValueMetaInterface
    
    Parameters:
    
    object - the data value to calculate a hashcode for
    
    Returns:
    
    the calculated hashcode
    
    Throws:
    
    KettleValueException
  - createOriginalValue
```
public Value createOriginalValue(Object data)
                          throws KettleValueException
```
    Create an old-style value for backward compatibility reasons
    
    Specified by:
    
    createOriginalValue in interface ValueMetaInterface
    
    Parameters:
    
    data - the data to store in the value
    
    Returns:
    
    a newly created Value object
    
    Throws:
    
    KettleValueException - case there is a data conversion problem
  - getValueData
```
public Object getValueData(Value value)
                    throws KettleValueException
```
    Extracts the primitive data from an old style Value object
    
    Specified by:
    
    getValueData in interface ValueMetaInterface
    
    Parameters:
    
    value - the old style Value object
    
    Returns:
    
    the value's data, NOT the meta data.
    
    Throws:
    
    KettleValueException - case there is a data conversion problem
  - getStorageMetadata
```
public ValueMetaInterface getStorageMetadata()
```
    Description copied from interface: ValueMetaInterface
    
    Returns the storage Meta data that is needed for internal conversion from BinaryString or String to the specified type. This storage Meta data object survives cloning and should travel through the transformation unchanged as long as the data type remains the same.
    
    Specified by:
    
    getStorageMetadata in interface ValueMetaInterface
    
    Returns:
    
    the storageMetadata
  - setStorageMetadata
```
public void setStorageMetadata(ValueMetaInterface storageMetadata)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the storage meta data.
    
    Specified by:
    
    setStorageMetadata in interface ValueMetaInterface
    
    Parameters:
    
    storageMetadata - the storageMetadata to set
  - getTrimType
```
public int getTrimType()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the trim type.
    
    Specified by:
    
    getTrimType in interface ValueMetaInterface
    
    Returns:
    
    the trimType
  - setTrimType
```
public void setTrimType(int trimType)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the trim type.
    
    Specified by:
    
    setTrimType in interface ValueMetaInterface
    
    Parameters:
    
    trimType - the trimType to set
  - getTrimTypeByCode
```
public static final int getTrimTypeByCode(String tt)
```
  - getTrimTypeByDesc
```
public static final int getTrimTypeByDesc(String tt)
```
  - getTrimTypeCode
```
public static final String getTrimTypeCode(int i)
```
  - getTrimTypeDesc
```
public static final String getTrimTypeDesc(int i)
```
  - getConversionMetadata
```
public ValueMetaInterface getConversionMetadata()
```
    Description copied from interface: ValueMetaInterface
    
    This conversion metadata can be attached to a String object to see where it came from and with which mask it was generated, the encoding, the local languages used, padding, etc.
    
    Specified by:
    
    getConversionMetadata in interface ValueMetaInterface
    
    Returns:
    
    the conversionMetadata
  - setConversionMetadata
```
public void setConversionMetadata(ValueMetaInterface conversionMetadata)
```
    Description copied from interface: ValueMetaInterface
    
    Attach conversion metadata to a String object to see where it came from and with which mask it was generated, the encoding, the local languages used, padding, etc.
    
    Specified by:
    
    setConversionMetadata in interface ValueMetaInterface
    
    Parameters:
    
    conversionMetadata - the conversionMetadata to set
  - isSingleByteEncoding
```
public boolean isSingleByteEncoding()
```
    Specified by:
    
    isSingleByteEncoding in interface ValueMetaInterface
    
    Returns:
    
    true if the String encoding used (storage) is single byte encoded.
  - getNumberOfBinaryStringConversions
```
public long getNumberOfBinaryStringConversions()
```
    Description copied from interface: ValueMetaInterface
    
    Returns the number of binary string to native data type conversions done with this object conversions
    
    Specified by:
    
    getNumberOfBinaryStringConversions in interface ValueMetaInterface
    
    Returns:
    
    the number of binary string to native data type conversions done with this object conversions
  - setNumberOfBinaryStringConversions
```
public void setNumberOfBinaryStringConversions(long numberOfBinaryStringConversions)
```
    Description copied from interface: ValueMetaInterface
    
    Returns the number of binary string to native data type done with this object conversions to set.
    
    Specified by:
    
    setNumberOfBinaryStringConversions in interface ValueMetaInterface
    
    Parameters:
    
    numberOfBinaryStringConversions - the number of binary string to native data type done with this object conversions to set
  - isOriginalAutoIncrement
```
public boolean isOriginalAutoIncrement()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is original auto increment.
    
    Specified by:
    
    isOriginalAutoIncrement in interface ValueMetaInterface
    
    Returns:
    
    true, if is original auto increment
  - setOriginalAutoIncrement
```
public void setOriginalAutoIncrement(boolean originalAutoIncrement)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original auto increment.
    
    Specified by:
    
    setOriginalAutoIncrement in interface ValueMetaInterface
    
    Parameters:
    
    originalAutoIncrement - the new original auto increment
  - getOriginalColumnType
```
public int getOriginalColumnType()
```
    Description copied from interface: ValueMetaInterface
    
    store original JDBC RecordSetMetaData for later use
    
    Specified by:
    
    getOriginalColumnType in interface ValueMetaInterface
    
    See Also:
    
    ResultSetMetaData
  - setOriginalColumnType
```
public void setOriginalColumnType(int originalColumnType)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original column type.
    
    Specified by:
    
    setOriginalColumnType in interface ValueMetaInterface
    
    Parameters:
    
    originalColumnType - the new original column type
  - getOriginalColumnTypeName
```
public String getOriginalColumnTypeName()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the original column type name.
    
    Specified by:
    
    getOriginalColumnTypeName in interface ValueMetaInterface
    
    Returns:
    
    the original column type name
  - setOriginalColumnTypeName
```
public void setOriginalColumnTypeName(String originalColumnTypeName)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original column type name.
    
    Specified by:
    
    setOriginalColumnTypeName in interface ValueMetaInterface
    
    Parameters:
    
    originalColumnTypeName - the new original column type name
  - isOriginalNullable
```
public int isOriginalNullable()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is original nullable.
    
    Specified by:
    
    isOriginalNullable in interface ValueMetaInterface
    
    Returns:
    
    the int
  - setOriginalNullable
```
public void setOriginalNullable(int originalNullable)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original nullable.
    
    Specified by:
    
    setOriginalNullable in interface ValueMetaInterface
    
    Parameters:
    
    originalNullable - the new original nullable
  - getOriginalPrecision
```
public int getOriginalPrecision()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the original precision.
    
    Specified by:
    
    getOriginalPrecision in interface ValueMetaInterface
    
    Returns:
    
    the original precision
  - setOriginalPrecision
```
public void setOriginalPrecision(int originalPrecision)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original precision.
    
    Specified by:
    
    setOriginalPrecision in interface ValueMetaInterface
    
    Parameters:
    
    originalPrecision - the new original precision
  - getOriginalScale
```
public int getOriginalScale()
```
    Description copied from interface: ValueMetaInterface
    
    Gets the original scale.
    
    Specified by:
    
    getOriginalScale in interface ValueMetaInterface
    
    Returns:
    
    the original scale
  - setOriginalScale
```
public void setOriginalScale(int originalScale)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original scale.
    
    Specified by:
    
    setOriginalScale in interface ValueMetaInterface
    
    Parameters:
    
    originalScale - the new original scale
  - isOriginalSigned
```
public boolean isOriginalSigned()
```
    Description copied from interface: ValueMetaInterface
    
    Checks if is original signed.
    
    Specified by:
    
    isOriginalSigned in interface ValueMetaInterface
    
    Returns:
    
    true, if is original signed
  - setOriginalSigned
```
public void setOriginalSigned(boolean originalSigned)
```
    Description copied from interface: ValueMetaInterface
    
    Sets the original signed.
    
    Specified by:
    
    setOriginalSigned in interface ValueMetaInterface
    
    Parameters:
    
    originalSigned - the new original signed
  - isBigNumberFormatting
```
public boolean isBigNumberFormatting()
```
    Returns:
    
    the bigNumberFormatting flag : true if BigNumbers of formatted as well
  - setBigNumberFormatting
```
public void setBigNumberFormatting(boolean bigNumberFormatting)
```
    Parameters:
    
    bigNumberFormatting - the bigNumberFormatting flag to set : true if BigNumbers of formatted as well
  - getTrimTypeCodes
```
public static String[] getTrimTypeCodes()
```
    Returns:
    
    The available trim type codes (NOT localized, use for persistence)
  - getTrimTypeDescriptions
```
public static String[] getTrimTypeDescriptions()
```
    Returns:
    
    The available trim type descriptions (localized)
  - requiresRealClone
```
public boolean requiresRealClone()
```
    Description copied from interface: ValueMetaInterface
    
    Returns true if the data type requires a real copy. Usually a binary or Serializable object.
    
    Specified by:
    
    requiresRealClone in interface ValueMetaInterface
    
    Returns:
    
    boolean
  - isLenientStringToNumber
```
public boolean isLenientStringToNumber()
```
    Specified by:
    
    isLenientStringToNumber in interface ValueMetaInterface
    
    Returns:
    
    the lenientStringToNumber
  - setLenientStringToNumber
```
public void setLenientStringToNumber(boolean lenientStringToNumber)
```
    Specified by:
    
    setLenientStringToNumber in interface ValueMetaInterface
    
    Parameters:
    
    lenientStringToNumber - the lenientStringToNumber to set
  - getDateFormatTimeZone
```
public TimeZone getDateFormatTimeZone()
```
    Specified by:
    
    getDateFormatTimeZone in interface ValueMetaInterface
    
    Returns:
    
    the date format time zone
  - setDateFormatTimeZone
```
public void setDateFormatTimeZone(TimeZone dateFormatTimeZone)
```
    Specified by:
    
    setDateFormatTimeZone in interface ValueMetaInterface
    
    Parameters:
    
    dateFormatTimeZone - the date format time zone to set
  - drawValue
```
public void drawValue(PrimitiveGCInterface gc,
                      Object value)
               throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    This method draws the value using the supplied graphical context.
    
    Specified by:
    
    drawValue in interface ValueMetaInterface
    
    Parameters:
    
    gc - The graphical context to draw on.
    
    Throws:
    
    KettleValueException
  - getValueFromSQLType
```
public ValueMetaInterface getValueFromSQLType(DatabaseMeta databaseMeta,
                                              String name,
                                              ResultSetMetaData rm,
                                              int index,
                                              boolean ignoreLength,
                                              boolean lazyConversion)
                                       throws KettleDatabaseException
```
    Description copied from interface: ValueMetaInterface
    
    Investigate JDBC result set metadata at the specified index. If this value metadata is interested in handling this SQL type, it should return the value meta. Otherwise it should return null.
    
    Specified by:
    
    getValueFromSQLType in interface ValueMetaInterface
    
    Parameters:
    
    databaseMeta - the database metadata to reference capabilities and so on.
    
    name - The name of the new value
    
    rm - The result metadata to investigate
    
    index - The index to look at (1-based)
    
    ignoreLength - Don't look at the length
    
    lazyConversion - use lazy conversion
    
    Returns:
    
    The value metadata if this value should handle the SQL type at the specified index.
    
    Throws:
    
    KettleDatabaseException - In case something went wrong.
  - getValueFromResultSet
```
public Object getValueFromResultSet(DatabaseInterface databaseInterface,
                                    ResultSet resultSet,
                                    int index)
                             throws KettleDatabaseException
```
    Get a value from a result set column based on the current value metadata
    
    Specified by:
    
    getValueFromResultSet in interface ValueMetaInterface
    
    Parameters:
    
    databaseInterface - the database metadata to use
    
    resultSet - The JDBC result set to read from
    
    index - The column index (1-based)
    
    Returns:
    
    The Kettle native data type based on the value metadata
    
    Throws:
    
    KettleDatabaseException - in case something goes wrong.
  - setPreparedStatementValue
```
public void setPreparedStatementValue(DatabaseMeta databaseMeta,
                                      PreparedStatement preparedStatement,
                                      int index,
                                      Object data)
                               throws KettleDatabaseException
```
    Description copied from interface: ValueMetaInterface
    
    Set a value on a JDBC prepared statement on the specified position
    
    Specified by:
    
    setPreparedStatementValue in interface ValueMetaInterface
    
    Parameters:
    
    databaseMeta - the database metadata to reference
    
    preparedStatement - The prepared statement
    
    index - the column index (1-based)
    
    data - the value to set
    
    Throws:
    
    KettleDatabaseException - in case something goes wrong
  - getNativeDataType
```
public Object getNativeDataType(Object object)
                         throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    This method gives you the native Java data type corresponding to the value meta-data. Conversions from other storage types and other operations are done automatically according to the specified value meta-data.
    
    Specified by:
    
    getNativeDataType in interface ValueMetaInterface
    
    Parameters:
    
    object - The input data
    
    Returns:
    
    The native data type
    
    Throws:
    
    KettleValueException - in case there is an unexpected data conversion error.
  - getDatabaseColumnTypeDefinition
```
public String getDatabaseColumnTypeDefinition(DatabaseInterface databaseInterface,
                                              String tk,
                                              String pk,
                                              boolean use_autoinc,
                                              boolean add_fieldname,
                                              boolean add_cr)
```
    Description copied from interface: ValueMetaInterface
    
    Ask for suggestions as to how this plugin data type should be represented in the specified database interface
    
    Specified by:
    
    getDatabaseColumnTypeDefinition in interface ValueMetaInterface
    
    Parameters:
    
    databaseInterface - The database type/dialect to get the column type definition for
    
    tk - Is this a technical key field?
    
    pk - Is this a primary key field?
    
    use_autoinc - Use auto-increment?
    
    add_fieldname - add the fieldname to the column type definition?
    
    add_cr - add a cariage return to the string?
    
    Returns:
    
    The field type definition
  - getNativeDataTypeClass
```
public Class<?> getNativeDataTypeClass()
                                throws KettleValueException
```
    Description copied from interface: ValueMetaInterface
    
    Return the Java class that represents the "native" storage type of this ValueMeta
    
    Specified by:
    
    getNativeDataTypeClass in interface ValueMetaInterface
    
    Returns:
    
    A Java class
    
    Throws:
    
    KettleValueException

Class ValueMetaBase

Field Summary

Fields inherited from interface org.pentaho.di.core.row.ValueMetaInterface

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INTEGER_PARSE_MASK

DEFAULT_NUMBER_PARSE_MASK

DEFAULT_BIGNUMBER_PARSE_MASK

DEFAULT_DATE_PARSE_MASK

DEFAULT_TIMESTAMP_PARSE_MASK

DEFAULT_INTEGER_FORMAT_MASK

DEFAULT_NUMBER_FORMAT_MASK

DEFAULT_BIG_NUMBER_FORMAT_MASK

DEFAULT_DATE_FORMAT_MASK

DEFAULT_TIMESTAMP_FORMAT_MASK

XML_META_TAG

XML_DATA_TAG

COMPATIBLE_DATE_FORMAT_PATTERN

EMPTY_STRING_AND_NULL_ARE_DIFFERENT

trimTypeCode

trimTypeDesc

SINGLE_BYTE_ENCODINGS

Constructor Detail

ValueMetaBase

ValueMetaBase

ValueMetaBase

ValueMetaBase

ValueMetaBase

ValueMetaBase

ValueMetaBase

Method Detail

clone

getComments

setComments

getIndex

setIndex

getLength

setLength

setLength

getName

setName

getOrigin

setOrigin

getPrecision

setPrecision

getStorageType

setStorageType

isStorageNormal

isStorageIndexed

isStorageBinaryString

getType

setType

getConversionMask

setConversionMask

getStringEncoding

setStringEncoding

getDecimalSymbol

setDecimalSymbol

getGroupingSymbol

setGroupingSymbol

getCurrencySymbol

setCurrencySymbol

isCaseInsensitive

setCaseInsensitive

isCollatorDisabled

setCollatorDisabled

getCollatorLocale

setCollatorLocale

getCollatorStrength

setCollatorStrength

isSortedDescending

setSortedDescending

isOutputPaddingEnabled

setOutputPaddingEnabled

isLargeTextField

setLargeTextField

isDateFormatLenient

setDateFormatLenient