de.tif.jacob.core.data
Class IDataKeyValue

java.lang.Object
  de.tif.jacob.core.data.IDataKeyValue

All Implemented Interfaces:

java.io.Serializable

public final class IDataKeyValue
extends java.lang.Object
implements java.io.Serializable

Data key value instances could be obtained by means of

IDataRecord.getPrimaryKeyValue()

IDataTableRecord.getKeyValue(IKey)

IDataTableRecord.getKeyValue(String).

See Also:

Serialized Form

Field Summary

static java.lang.String	RCS_ID The revision control system id.
static java.lang.String	RCS_REV The revision control system id in short form.

Constructor Summary

IDataKeyValue(java.lang.Object fieldValue)

IDataKeyValue(java.lang.Object[] fieldValues)

Method Summary

boolean	equals(java.lang.Object anObject) Indicates whether some other object is "equal to" this one.
java.lang.Object	getFieldValue(int fieldIndex) Returns the specified field value given by its index.
int	hashCode() Returns a hash code for this key value.
int	numberOfFieldValues() Returns the number of field values this key value exists of.
java.lang.String	toString() Returns the key value as string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The revision control system id in short form.

See Also:

Constant Field Values

Constructor Detail

IDataKeyValue

public IDataKeyValue(java.lang.Object[] fieldValues)

IDataKeyValue

public IDataKeyValue(java.lang.Object fieldValue)

Method Detail

numberOfFieldValues

public int numberOfFieldValues()

Returns the number of field values this key value exists of.

Returns:

the number of field values. For non composite keys the number returned will be 1.

getFieldValue

public java.lang.Object getFieldValue(int fieldIndex)
                               throws java.lang.IndexOutOfBoundsException

Returns the specified field value given by its index.

Parameters:

fieldIndex - the field index

Returns:

the requested field value.

Throws:

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

equals

public boolean equals(java.lang.Object anObject)

Indicates whether some other object is "equal to" this one.

Different instances of this class are equal, if the underlying field values are equal as well.

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Returns a hash code for this key value.

For different instances of this class the hash codes are equal, if the hash codes of the underlying field values are equal as well.

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Returns the key value as string. In case of composite keys, a string in the following form k1|k2|k3 will be returned.

Overrides:

toString in class java.lang.Object

Returns:

the key value as string