de.softdevel.d1.record

Class CRecord

java.lang.Object

de.softdevel.d1.record.CRecord

public final class CRecord
extends java.lang.Object

A record is a set of data slots and has an additional ID. The slots can be accessed by a Key-ID.

Constructor Summary

Constructors

Constructor and Description
CRecord(CRecord aTemplate) Copy constructor.
CRecord(IId aId) Constructor.

Method Summary

Modifier and Type	Method and Description
ISlot	addSlot(java.lang.Object aKey, ISlot aSlot) Set a slot.
void	clear() Clear all data in the record.
void	clearSlots() Remove all slots, but not the ID.
static CRecord	createFromStream(java.io.DataInputStream aStream) Read a record from an input stream.
boolean	equals(java.lang.Object aObj)
boolean	exist(ISlotKey aKey) Check if a certain slot exist.
IId	getId()
ISlot	getSlot(ISlotKey aKey, CSlotType aType) Get a slot and check it's type.
ISlot	getSlot(java.lang.Object aKey) Get a Slot.
java.util.Map<ISlotKey,ISlot>	getSlots() Get all slots as Map.
CSlotType	getSlotType(ISlotKey aKey) Get the slot type.
java.lang.Object	getValue(ISlotKey aKey) Get a data pool value by key.
java.lang.Object	getValue(ISlotKey aKey, CSlotType aType) Get a data pool value by key.
java.lang.Object	getValue(ISlotKey aKey, CSlotType aType, java.lang.Object aDefaultValue) Get a data pool value by key.
java.lang.Object	getValue(ISlotKey aKey, java.lang.Object aDefaultValue) Get a data pool value by key.
byte	getVersion()
int	hashCode()
void	removeSlot(ISlotKey aKey) Remove a slot.
void	setId(IId aId) Set the ID of the record.
static void	setNameDb(INameDb aNameDb) Internal method to set the name database.
static void	setSlotFactory(ISlotFactory aFactory) Internal method to set the slot factory.
void	setValue(ISlotKey aKey, CSlotType aType, java.lang.Object aValue) Set a value.
void	setValueSafe(ISlotKey aKey, CSlotType aType, java.lang.Object aValue) Set a value.
int	size()
void	takeSlots(CRecord aRecord) Add all slots from another record/message to this one.
void	toStream(java.io.DataOutputStream aStream) Write the record into a stream.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CRecord

public CRecord(CRecord aTemplate)

Copy constructor.

Parameters:

aTemplate - The record template.

CRecord

public CRecord(IId aId)

Constructor.

Parameters:

aId - The record ID.

Method Detail

createFromStream

public static CRecord createFromStream(java.io.DataInputStream aStream)
                                throws java.io.IOException

Read a record from an input stream.

Parameters:

aStream - The input stream.

Returns:

The record.

Throws:

java.io.IOException - on error

setNameDb

public static void setNameDb(INameDb aNameDb)

Internal method to set the name database. TODO replace

Parameters:

aNameDb - The name database.

setSlotFactory

public static void setSlotFactory(ISlotFactory aFactory)

Internal method to set the slot factory.

Parameters:

aFactory - The slot factory.

addSlot

public ISlot addSlot(java.lang.Object aKey,
                     ISlot aSlot)

Set a slot.

Parameters:

aKey - The key of the slot.

aSlot - The slot.

Returns:

The slot.

clear

public void clear()

Clear all data in the record.

clearSlots

public void clearSlots()

Remove all slots, but not the ID.

equals

public boolean equals(java.lang.Object aObj)

Overrides:

equals in class java.lang.Object

getId

public IId getId()

Returns:

The ID of the record.

getSlot

public ISlot getSlot(ISlotKey aKey,
                     CSlotType aType)
              throws CException

Get a slot and check it's type.

Parameters:

aKey - The key of the slot.

aType - The expected type of the slot.

Returns:

The slot or null.

Throws:

CException - if the slot type was another one.

getSlot

public ISlot getSlot(java.lang.Object aKey)

Get a Slot. The slot can contain any possible value, see CSlotType.

Parameters:

aKey - The key of the slot.

Returns:

The found slot or null.

getSlots

public java.util.Map<ISlotKey,ISlot> getSlots()

Get all slots as Map.

Returns:

all slots as map.

getSlotType

public CSlotType getSlotType(ISlotKey aKey)

Get the slot type.

Parameters:

aKey - The key to find the slot.

Returns:

The slot type.

getValue

public java.lang.Object getValue(ISlotKey aKey)

Get a data pool value by key.

Parameters:

aKey - The key.

Returns:

The data pool value (can be null).

getValue

public java.lang.Object getValue(ISlotKey aKey,
                                 CSlotType aType)
                          throws CException

Get a data pool value by key. Check if the given type matches the slot type. If the type does not match the given type, log and throw an exception. If the slot does not exist, no type check can be performed.

Parameters:

aKey - The key.

aType - The expected data type

Returns:

The data pool value (can be null).

Throws:

CException - if the type does not match an existing slot.

getValue

public java.lang.Object getValue(ISlotKey aKey,
                                 CSlotType aType,
                                 java.lang.Object aDefaultValue)
                          throws CException

Get a data pool value by key. Check if the given type matches the slot type. If the type does not match the given type, log and throw an exception. If the slot does not exist, no type check can be performed.

Parameters:

aKey - The key.

aType - The expected data type

aDefaultValue - If the record does not exist, this default value is returned.

Returns:

The data pool value (can be null).

Throws:

CException - if the type does not match an existing slot.

getValue

public java.lang.Object getValue(ISlotKey aKey,
                                 java.lang.Object aDefaultValue)

Get a data pool value by key.

Parameters:

aKey - The key.

aDefaultValue - If the record does not exist, this default value is returned.

Returns:

The data pool value (can be null).

getVersion

public byte getVersion()

Returns:

The version of the record.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

exist

public boolean exist(ISlotKey aKey)

Check if a certain slot exist.

Parameters:

aKey - The key of the slot.

Returns:

True = the slot is present.

removeSlot

public void removeSlot(ISlotKey aKey)

Remove a slot.

Parameters:

aKey - The key of the slot.

setId

public void setId(IId aId)

Set the ID of the record.

Parameters:

aId - The ID.

setValue

public void setValue(ISlotKey aKey,
                     CSlotType aType,
                     java.lang.Object aValue)
              throws CException

Set a value.

Parameters:

aKey - The key of the slot.

aType - The type of the slot.

aValue - The value of the slot.

Throws:

CException - on parsing the value.

setValueSafe

public void setValueSafe(ISlotKey aKey,
                         CSlotType aType,
                         java.lang.Object aValue)

Set a value. If an exception is thrown, it will be catched and logged.

Parameters:

aKey - The key of the slot.

aType - The type of the slot.

aValue - The value of the slot.

size

public int size()

Returns:

The amount of slots in the record.

takeSlots

public void takeSlots(CRecord aRecord)

Add all slots from another record/message to this one. The records is cleared before.

Parameters:

aRecord - The record.

toStream

public void toStream(java.io.DataOutputStream aStream)
              throws java.io.IOException

Write the record into a stream.

Parameters:

aStream - The output stream.

Throws:

java.io.IOException - on error.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object