de.tif.jacob.core.data
Interface IDataRecord

All Known Subinterfaces:

IDataBrowserRecord, IDataTableRecord

public interface IDataRecord

A data record represents the joint behaviour of instances of IDataBrowserRecord and IDataTableRecord.

There are multiple getter methods for accessing record field values. The following table shows how jACOB field types are matched to java types. If a field value could not converted to the requested java type, the respective getter method would throw a ClassCastException.

To \ From

jACOB field type

Java type(s)

Text

Boolean

Integer

Long

Decimal

Float

Double

Time

Date

Timestamp

Enumeration

Longtext

Binary

Document

java.lang.String

X

X

X

X

X

X

X

X

X

X

X

X

java.lang.Boolean

X

x

x

int, java.lang.Integer

X

X

x

x

x

x

long, java.lang.Long

X

X

X

x

x

x

java.math.BigDecimal

X

X

X

x

x

float, java.lang.Float

X

X

x

X

x

double, java.lang.Double

X

X

x

X

X

java.sql.Time

X

x

java.sql.Date

X

x

java.sql.Timestamp

X

byte[]

X

X

DataDocumentValue

X

A bold X indicates the default java type for a given jACOB field type. The default java type is returned when calling the generic getValue(int)method.

A lower x indicates that the conversion is possible but at the cost of lost information.

Field Summary

static int	DEFAULT_STYLE Constant for default style output.
static int	LONG_STYLE Constant for long style output.
static int	MEDIUM_STYLE Constant for medium style output.
static int	SHORT_STYLE Constant for short style output.

Method Summary

IDataAccessor	getAccessor() Returns the related data accessor instance.
boolean	getbooleanValue(int fieldIndex) Returns the specified field value as a boolean value.
java.lang.Boolean	getBooleanValue(int fieldIndex) Returns the specified field value in Boolean format.
boolean	getbooleanValue(java.lang.String fieldName) Returns the specified field value as a boolean value.
java.lang.Boolean	getBooleanValue(java.lang.String fieldName) Returns the specified field value in Boolean format.
byte[]	getBytesValue(int fieldIndex) Returns the specified field value as a byte[] array.
byte[]	getBytesValue(java.lang.String fieldName) Returns the specified field value as a byte[] array.
java.sql.Date	getDateValue(int fieldIndex) Returns the specified field value in Date format.
java.sql.Date	getDateValue(java.lang.String fieldName) Returns the specified field value in Date format.
java.math.BigDecimal	getDecimalValue(int fieldIndex) Returns the specified field value in BigDecimal format.
java.math.BigDecimal	getDecimalValue(java.lang.String fieldName) Returns the specified field value in BigDecimal format.
DataDocumentValue	getDocumentValue(int fieldIndex) Returns the specified field value as a DataDocumentValue value.
DataDocumentValue	getDocumentValue(java.lang.String fieldName) Returns the specified field value as a DataDocumentValue value.
double	getdoubleValue(int fieldIndex) Returns the specified field value as a double value.
java.lang.Double	getDoubleValue(int fieldIndex) Returns the specified field value in Double format.
double	getdoubleValue(java.lang.String fieldName) Returns the specified field value as a double value.
java.lang.Double	getDoubleValue(java.lang.String fieldName) Returns the specified field value in Double format.
int	getFieldNumber() Returns the number of fields of this record.
float	getfloatValue(int fieldIndex) Returns the specified field value as a float value.
java.lang.Float	getFloatValue(int fieldIndex) Returns the specified field value in Float format.
float	getfloatValue(java.lang.String fieldName) Returns the specified field value as a float value.
java.lang.Float	getFloatValue(java.lang.String fieldName) Returns the specified field value in Float format.
IDataRecordId	getId() Returns the record id of this record, i.e. an id which unambiguously identifies a record in any table.
java.lang.Integer	getIntegerValue(int fieldIndex) Returns the specified field value in Integer format.
java.lang.Integer	getIntegerValue(java.lang.String fieldName) Returns the specified field value in Integer format.
int	getintValue(int fieldIndex) Returns the specified field value as a int value.
int	getintValue(java.lang.String fieldName) Returns the specified field value as a int value.
long	getlongValue(int fieldIndex) Returns the specified field value as a long value.
java.lang.Long	getLongValue(int fieldIndex) Returns the specified field value in Long format.
long	getlongValue(java.lang.String fieldName) Returns the specified field value as a long value.
java.lang.Long	getLongValue(java.lang.String fieldName) Returns the specified field value in Long format.
IDataKeyValue	getPrimaryKeyValue() Returns the primary key value of this record.
java.math.BigDecimal	getSaveDecimalValue(int fieldIndex) Similar behaviour than getDecimalValue(int) except that 0.0 is returned in case the value is null.
java.math.BigDecimal	getSaveDecimalValue(java.lang.String fieldName) Similar behaviour than getDecimalValue(String) except that 0.0 is returned in case the value is null.
java.lang.String	getSaveStringValue(int fieldIndex) Similar behaviour than getStringValue(int) except that an empty string is returned in case the value is null.
java.lang.String	getSaveStringValue(int fieldIndex, java.util.Locale locale) Similar behaviour than getStringValue(int, Locale) except that an empty string is returned in case the value is null.
java.lang.String	getSaveStringValue(int fieldIndex, java.util.Locale locale, int style) Similar behaviour than getStringValue(int, Locale, int) except that an empty string is returned in case the value is null.
java.lang.String	getSaveStringValue(java.lang.String fieldName) Similar behaviour than getStringValue(String) except that an empty string is returned in case the value is null.
java.lang.String	getSaveStringValue(java.lang.String fieldName, java.util.Locale locale) Similar behaviour than getStringValue(String, Locale) except that an empty string is returned in case the value is null.
java.lang.String	getSaveStringValue(java.lang.String fieldName, java.util.Locale locale, int style) Similar behaviour than getStringValue(String, Locale, int) except that an empty string is returned in case the value is null.
java.lang.String	getStringValue(int fieldIndex) Returns the default string representation of the specified field value.
java.lang.String	getStringValue(int fieldIndex, java.util.Locale locale) Returns the specified field value as a string by means of considering the given locale.
java.lang.String	getStringValue(int fieldIndex, java.util.Locale locale, int style) Returns the specified field value as a string by means of considering the given locale and style.
java.lang.String	getStringValue(java.lang.String fieldName) Returns the default string representation of the specified field value.
java.lang.String	getStringValue(java.lang.String fieldName, java.util.Locale locale) Returns the specified field value as a string by means of considering the given locale.
java.lang.String	getStringValue(java.lang.String fieldName, java.util.Locale locale, int style) Returns the specified field value as a string by means of considering the given locale and style.
ITableAlias	getTableAlias() Returns the table alias this record belongs to.
java.sql.Timestamp	getTimestampValue(int fieldIndex) Returns the specified field value in Timestamp format.
java.sql.Timestamp	getTimestampValue(java.lang.String fieldName) Returns the specified field value in Timestamp format.
java.sql.Time	getTimeValue(int fieldIndex) Returns the specified field value in Time format.
java.sql.Time	getTimeValue(java.lang.String fieldName) Returns the specified field value in Time format.
java.lang.Object	getValue(int fieldIndex) Returns the field value specified by its index.
java.lang.Object	getValue(java.lang.String fieldName) Returns the field value specified by its name.
boolean	hasNullValue(int fieldIndex) Checks whether the field value specified by its index is null, i.e. the field value has not been set.

Field Detail

SHORT_STYLE

static final int SHORT_STYLE

Constant for short style output.

See Also:

getStringValue(int, Locale, int), Constant Field Values

MEDIUM_STYLE

static final int MEDIUM_STYLE

Constant for medium style output.

See Also:

getStringValue(int, Locale, int), Constant Field Values

LONG_STYLE

static final int LONG_STYLE

Constant for long style output.

See Also:

getStringValue(int, Locale, int), Constant Field Values

DEFAULT_STYLE

static final int DEFAULT_STYLE

Constant for default style output.

See Also:

getStringValue(int, Locale, int), Constant Field Values

Method Detail

getPrimaryKeyValue

IDataKeyValue getPrimaryKeyValue()

Returns the primary key value of this record.

Returns:

the primary key value or null if no primary key exists for this type of record.

getId

IDataRecordId getId()

Returns the record id of this record, i.e. an id which unambiguously identifies a record in any table.

Returns:

the record id

getAccessor

IDataAccessor getAccessor()

Returns the related data accessor instance.

Returns:

the data accessor

getTableAlias

ITableAlias getTableAlias()

Returns the table alias this record belongs to.

Returns:

the table alias

getFieldNumber

int getFieldNumber()

Returns the number of fields of this record.

Returns:

the number of fields

getValue

java.lang.Object getValue(int fieldIndex)
                          throws java.lang.IndexOutOfBoundsException

Returns the field value specified by its index.

The java type (class) of the field value returned is determined by the field type. Please see IDataRecord!

Parameters:

fieldIndex - the field index of the value

Returns:

The field value or null

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getValue

java.lang.Object getValue(java.lang.String fieldName)
                          throws java.lang.NoSuchFieldException

Returns the field value specified by its name.

The java type (class) of the field value returned is determined by the field type. Please see IDataRecord!

Parameters:

fieldName - the name of the field

Returns:

The field value or null

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

hasNullValue

boolean hasNullValue(int fieldIndex)
                     throws java.lang.IndexOutOfBoundsException

Checks whether the field value specified by its index is null, i.e. the field value has not been set.

Note: This method is equivalent to null == getValue(int), but could be much more efficient in case of document, binary or long text values. This is because these values need not necessarily being retrieved from data source.

Parameters:

fieldIndex - the field index of the value

Returns:

true if the field value is null, otherwise false

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getSaveStringValue

java.lang.String getSaveStringValue(int fieldIndex)
                                    throws java.lang.IndexOutOfBoundsException

Similar behaviour than getStringValue(int) except that an empty string is returned in case the value is null.

Parameters:

fieldIndex - the field index

Returns:

the field value as string

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getSaveStringValue

java.lang.String getSaveStringValue(int fieldIndex,
                                    java.util.Locale locale)
                                    throws java.lang.IndexOutOfBoundsException

Similar behaviour than getStringValue(int, Locale) except that an empty string is returned in case the value is null.

Parameters:

fieldIndex - the field index

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

Returns:

the field value as string

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getSaveStringValue

java.lang.String getSaveStringValue(int fieldIndex,
                                    java.util.Locale locale,
                                    int style)
                                    throws java.lang.IndexOutOfBoundsException

Similar behaviour than getStringValue(int, Locale, int) except that an empty string is returned in case the value is null.

Parameters:

fieldIndex - the field index

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

style - the style to use

Returns:

the field value as string

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

See Also:

DEFAULT_STYLE, SHORT_STYLE, MEDIUM_STYLE, LONG_STYLE

getSaveStringValue

java.lang.String getSaveStringValue(java.lang.String fieldName)
                                    throws java.lang.NoSuchFieldException

Similar behaviour than getStringValue(String) except that an empty string is returned in case the value is null.

Parameters:

fieldName - the name of the field

Returns:

the field value as string

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

getSaveStringValue

java.lang.String getSaveStringValue(java.lang.String fieldName,
                                    java.util.Locale locale)
                                    throws java.lang.NoSuchFieldException

Similar behaviour than getStringValue(String, Locale) except that an empty string is returned in case the value is null.

Parameters:

fieldName - the name of the field

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

Returns:

the field value as string

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

getSaveStringValue

java.lang.String getSaveStringValue(java.lang.String fieldName,
                                    java.util.Locale locale,
                                    int style)
                                    throws java.lang.NoSuchFieldException

Similar behaviour than getStringValue(String, Locale, int) except that an empty string is returned in case the value is null.

Parameters:

fieldName - the name of the field

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

style - the style to use

Returns:

the field value as string

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

See Also:

DEFAULT_STYLE, SHORT_STYLE, MEDIUM_STYLE, LONG_STYLE

getStringValue

java.lang.String getStringValue(int fieldIndex)
                                throws java.lang.IndexOutOfBoundsException

Returns the default string representation of the specified field value.

The following table shows the format of the defaut string presentation for the different jACOB field types:

Field type	Format	Example
Text	No specific representation since text values are already strings	Hello world
Integer	Standard decimal format without thousands separators	101234
Long	Standard decimal format without thousands separators	-1234567890
Decimal	Standard decimal format without thousands separators and a dot as decimal separator	-123456.7890
Float	as Decimal	0.00123456
Decimal	as Decimal	-123000.25
Time	HH:mm without seconds	21:15
Date	yyyy-MM-dd	2004-09-21
Timestamp	Depending on the resolution as: yyyy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss yyyy-MM-dd HH:mm:ss.SSS	2004-09-21 21:15:10.320
Enumeration	The enumeration value	Confirmed
Longtext	The complete long text	The quick brown fox jumps over the lazy dog ...
Binary	Throws a UnsupportedOperationException
Document	The document name, if existing	word.doc

Note: This method is equivalent to getStringValue(int, Locale), if the locale is set to null.

Parameters:

fieldIndex - the field index

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getStringValue

java.lang.String getStringValue(int fieldIndex,
                                java.util.Locale locale)
                                throws java.lang.IndexOutOfBoundsException

Returns the specified field value as a string by means of considering the given locale.

For example: This method would return "04/15/2005 12:59:00 AM" for a timestamp field, if locale is set to Locale.US.

Note: This method is equivalent to getStringValue(int, Locale, int), if the style is set to DEFAULT_STYLE.

Parameters:

fieldIndex - the field index

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

getStringValue

java.lang.String getStringValue(int fieldIndex,
                                java.util.Locale locale,
                                int style)
                                throws java.lang.IndexOutOfBoundsException

Returns the specified field value as a string by means of considering the given locale and style.

For example: Setting the locale to Locale.GERMAN for a decimal field would return "12345,678" for style SHORT_STYLE and "12.345,678" for style LONG_STYLE.

Parameters:

fieldIndex - the field index

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

style - the style to use

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

See Also:

DEFAULT_STYLE, SHORT_STYLE, MEDIUM_STYLE, LONG_STYLE

getStringValue

java.lang.String getStringValue(java.lang.String fieldName)
                                throws java.lang.NoSuchFieldException

Returns the default string representation of the specified field value.

For further information see getStringValue(int).

Parameters:

fieldName - the name of the field

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

getStringValue

java.lang.String getStringValue(java.lang.String fieldName,
                                java.util.Locale locale)
                                throws java.lang.NoSuchFieldException

Returns the specified field value as a string by means of considering the given locale.

For example: This method would return "04/15/2005 12:59:00 AM" for a timestamp field, if locale is set to Locale.US.

Note: This method is equivalent to getStringValue(String, Locale, int), if the style is set to DEFAULT_STYLE.

Parameters:

fieldName - the name of the field

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

getStringValue

java.lang.String getStringValue(java.lang.String fieldName,
                                java.util.Locale locale,
                                int style)
                                throws java.lang.NoSuchFieldException

Returns the specified field value as a string by means of considering the given locale and style.

For example: Setting the locale to Locale.GERMAN for a decimal field would return "12345,678" for style SHORT_STYLE and "12.345,678" for style LONG_STYLE.

Parameters:

fieldName - the name of the field

locale - the locale to consider or null to use default string presentation (see getStringValue(int)).

style - the style to use

Returns:

the field value as string or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

See Also:

DEFAULT_STYLE, SHORT_STYLE, MEDIUM_STYLE, LONG_STYLE

getTimeValue

java.sql.Time getTimeValue(int fieldIndex)
                           throws java.lang.IndexOutOfBoundsException,
                                  java.lang.ClassCastException

Returns the specified field value in Time format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Time format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getTimeValue

java.sql.Time getTimeValue(java.lang.String fieldName)
                           throws java.lang.NoSuchFieldException,
                                  java.lang.ClassCastException

Returns the specified field value in Time format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Time format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getDateValue

java.sql.Date getDateValue(int fieldIndex)
                           throws java.lang.IndexOutOfBoundsException,
                                  java.lang.ClassCastException

Returns the specified field value in Date format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Date format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getDateValue

java.sql.Date getDateValue(java.lang.String fieldName)
                           throws java.lang.NoSuchFieldException,
                                  java.lang.ClassCastException

Returns the specified field value in Date format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Date format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getDecimalValue

java.math.BigDecimal getDecimalValue(int fieldIndex)
                                     throws java.lang.IndexOutOfBoundsException,
                                            java.lang.ClassCastException

Returns the specified field value in BigDecimal format.

Parameters:

fieldIndex - the field index

Returns:

the field value in BigDecimal format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getDecimalValue

java.math.BigDecimal getDecimalValue(java.lang.String fieldName)
                                     throws java.lang.NoSuchFieldException,
                                            java.lang.ClassCastException

Returns the specified field value in BigDecimal format.

Parameters:

fieldName - the name of the field

Returns:

the field value in BigDecimal format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getSaveDecimalValue

java.math.BigDecimal getSaveDecimalValue(int fieldIndex)
                                         throws java.lang.IndexOutOfBoundsException,
                                                java.lang.ClassCastException

Similar behaviour than getDecimalValue(int) except that 0.0 is returned in case the value is null.

Parameters:

fieldIndex - the field index

Returns:

the field value in BigDecimal format or 0.0 if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getSaveDecimalValue

java.math.BigDecimal getSaveDecimalValue(java.lang.String fieldName)
                                         throws java.lang.NoSuchFieldException,
                                                java.lang.ClassCastException

Similar behaviour than getDecimalValue(String) except that 0.0 is returned in case the value is null.

Parameters:

fieldName - the name of the field

Returns:

the field value in BigDecimal format or 0.0 if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getdoubleValue

double getdoubleValue(int fieldIndex)
                      throws java.lang.IndexOutOfBoundsException,
                             java.lang.ClassCastException

Returns the specified field value as a double value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a double value or 0.0 if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getDoubleValue

java.lang.Double getDoubleValue(int fieldIndex)
                                throws java.lang.IndexOutOfBoundsException,
                                       java.lang.ClassCastException

Returns the specified field value in Double format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Double format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getdoubleValue

double getdoubleValue(java.lang.String fieldName)
                      throws java.lang.NoSuchFieldException,
                             java.lang.ClassCastException

Returns the specified field value as a double value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a double value or 0.0 if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getDoubleValue

java.lang.Double getDoubleValue(java.lang.String fieldName)
                                throws java.lang.NoSuchFieldException,
                                       java.lang.ClassCastException

Returns the specified field value in Double format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Double format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getfloatValue

float getfloatValue(int fieldIndex)
                    throws java.lang.IndexOutOfBoundsException,
                           java.lang.ClassCastException

Returns the specified field value as a float value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a float value or 0.0 if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getFloatValue

java.lang.Float getFloatValue(int fieldIndex)
                              throws java.lang.IndexOutOfBoundsException,
                                     java.lang.ClassCastException

Returns the specified field value in Float format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Float format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getfloatValue

float getfloatValue(java.lang.String fieldName)
                    throws java.lang.NoSuchFieldException,
                           java.lang.ClassCastException

Returns the specified field value as a float value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a float value or 0.0 if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getFloatValue

java.lang.Float getFloatValue(java.lang.String fieldName)
                              throws java.lang.NoSuchFieldException,
                                     java.lang.ClassCastException

Returns the specified field value in Float format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Float format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getbooleanValue

boolean getbooleanValue(int fieldIndex)
                        throws java.lang.IndexOutOfBoundsException,
                               java.lang.ClassCastException

Returns the specified field value as a boolean value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a boolean value or false if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

Since:

2.6

getbooleanValue

boolean getbooleanValue(java.lang.String fieldName)
                        throws java.lang.NoSuchFieldException,
                               java.lang.ClassCastException

Returns the specified field value as a boolean value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a boolean value or false if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

Since:

2.6

getBooleanValue

java.lang.Boolean getBooleanValue(int fieldIndex)
                                  throws java.lang.IndexOutOfBoundsException,
                                         java.lang.ClassCastException

Returns the specified field value in Boolean format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Boolean format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

Since:

2.6

getBooleanValue

java.lang.Boolean getBooleanValue(java.lang.String fieldName)
                                  throws java.lang.NoSuchFieldException,
                                         java.lang.ClassCastException

Returns the specified field value in Boolean format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Boolean format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

Since:

2.6

getintValue

int getintValue(int fieldIndex)
                throws java.lang.IndexOutOfBoundsException,
                       java.lang.ClassCastException

Returns the specified field value as a int value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a int value or 0 if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getintValue

int getintValue(java.lang.String fieldName)
                throws java.lang.NoSuchFieldException,
                       java.lang.ClassCastException

Returns the specified field value as a int value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a int value or 0 if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getIntegerValue

java.lang.Integer getIntegerValue(int fieldIndex)
                                  throws java.lang.IndexOutOfBoundsException,
                                         java.lang.ClassCastException

Returns the specified field value in Integer format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Integer format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getIntegerValue

java.lang.Integer getIntegerValue(java.lang.String fieldName)
                                  throws java.lang.NoSuchFieldException,
                                         java.lang.ClassCastException

Returns the specified field value in Integer format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Integer format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getlongValue

long getlongValue(int fieldIndex)
                  throws java.lang.IndexOutOfBoundsException,
                         java.lang.ClassCastException

Returns the specified field value as a long value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a long value or 0 if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getLongValue

java.lang.Long getLongValue(int fieldIndex)
                            throws java.lang.IndexOutOfBoundsException,
                                   java.lang.ClassCastException

Returns the specified field value in Long format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Long format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getlongValue

long getlongValue(java.lang.String fieldName)
                  throws java.lang.NoSuchFieldException,
                         java.lang.ClassCastException

Returns the specified field value as a long value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a long value or 0 if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getLongValue

java.lang.Long getLongValue(java.lang.String fieldName)
                            throws java.lang.NoSuchFieldException,
                                   java.lang.ClassCastException

Returns the specified field value in Long format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Long format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getTimestampValue

java.sql.Timestamp getTimestampValue(int fieldIndex)
                                     throws java.lang.IndexOutOfBoundsException,
                                            java.lang.ClassCastException

Returns the specified field value in Timestamp format.

Parameters:

fieldIndex - the field index

Returns:

the field value in Timestamp format or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getTimestampValue

java.sql.Timestamp getTimestampValue(java.lang.String fieldName)
                                     throws java.lang.NoSuchFieldException,
                                            java.lang.ClassCastException

Returns the specified field value in Timestamp format.

Parameters:

fieldName - the name of the field

Returns:

the field value in Timestamp format or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested format. For valid conversions see IDataRecord.

getBytesValue

byte[] getBytesValue(int fieldIndex)
                     throws java.lang.IndexOutOfBoundsException,
                            java.lang.ClassCastException

Returns the specified field value as a byte[] array.

Attention: This method does not return a copy. So take care when modifying the result array.

Parameters:

fieldIndex - the field index

Returns:

the field value as a byte[] array or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getBytesValue

byte[] getBytesValue(java.lang.String fieldName)
                     throws java.lang.NoSuchFieldException,
                            java.lang.ClassCastException

Returns the specified field value as a byte[] array.

Attention: This method does not return a copy. So take care when modifying the result array.

Parameters:

fieldName - the name of the field

Returns:

the field value as a byte[] array or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getDocumentValue

DataDocumentValue getDocumentValue(int fieldIndex)
                                   throws java.lang.IndexOutOfBoundsException,
                                          java.lang.ClassCastException

Returns the specified field value as a DataDocumentValue value.

Parameters:

fieldIndex - the field index

Returns:

the field value as a DataDocumentValue or null if the value does not exist.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= fieldIndex < getFieldNumber() is not fulfilled

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.

getDocumentValue

DataDocumentValue getDocumentValue(java.lang.String fieldName)
                                   throws java.lang.NoSuchFieldException,
                                          java.lang.ClassCastException

Returns the specified field value as a DataDocumentValue value.

Parameters:

fieldName - the name of the field

Returns:

the field value as a DataDocumentValue or null if the value does not exist.

Throws:

java.lang.NoSuchFieldException - if no such field name exists for this record

java.lang.ClassCastException - if the field value can not be converted to the requested java type. For valid conversions see IDataRecord.