agi.foundation.tracking

(agi.foundation.tracking-2024r3.jar)

Class RawEntityData<TEntity>

java.lang.Object

agi.foundation.tracking.RawEntityData<TEntity>

Type Parameters:

TEntity - The type of entity.

public class RawEntityData<TEntity>
extends Object

Holds raw entity data read from a TrackingArchive. The data may contain multiple distinct entities, multiple updates to a single entity, or both.

Method Summary

Modifier and Type	Method and Description
TEntity	createEntity(int recordIndex, Transaction transaction) Creates an entity with the data from a specified record in the data set.
void	fillArray(int recordIndex, Object[] values) Fills an array from a specified record in the data set.
void	fillEntity(int recordIndex, Transaction transaction, TEntity entity) Fills a given entity instance with the data from a specified record in the data set.
Object	getEntityIdentifier(int recordIndex) Gets the entity identifier from a specified record in the data set.
List<EntitySchemaProperty<TEntity>>	getProperties() Gets the properties included in this data set.
int	getRecordCount() Gets the number of entity records in the data set.
Object[]	getValues(int recordIndex) Gets the values from a specified record in the data set.

Methods inherited from class java.lang.Object

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

Method Detail

getRecordCount

public final int getRecordCount()

Gets the number of entity records in the data set. Each record represents one update to one entity. The overall data set may contain multiple distinct entities, multiple updates to a single entity, or both.

getProperties

@Nonnull
public final List<EntitySchemaProperty<TEntity>> getProperties()

Gets the properties included in this data set.

getEntityIdentifier

public final Object getEntityIdentifier(int recordIndex)

Gets the entity identifier from a specified record in the data set.

Parameters:

recordIndex - The index of the entity record from which to get the identifier.

Returns:

The identifier.

Throws:

IllegalStateException - The data set does not contain the EntityIdentifier (get) property.

getValues

@Nonnull
public final Object[] getValues(int recordIndex)

Gets the values from a specified record in the data set. The returned array will contain one element for each property in Properties (get) and will be in the same order.

Parameters:

recordIndex - The index of the entity record from which to get the values.

Returns:

The values in the record, each element corresponding to a property in Properties (get).

fillArray

public final void fillArray(int recordIndex,
                            @Nonnull
                            Object[] values)

Fills an array from a specified record in the data set. The array must contain one element for each property in Properties (get) and on return of the array will be filled with values in the same order.

Parameters:

recordIndex - The index of the entity record from which to get the values.

values - On input, an array of the same length as Properties (get). On return, the values in the record corresponding to the Properties (get).

Throws:

ArgumentNullException - Thrown when values is null.

fillEntity

public final void fillEntity(int recordIndex,
                             Transaction transaction,
                             TEntity entity)

Fills a given entity instance with the data from a specified record in the data set. The EntityIdentifier (get) property, if it exists in the data set, is ignored; it is not required to match the entity to be filled.

Parameters:

recordIndex - The index of the entity record from which to fill the entity.

transaction - The transaction to use to set properties of the entity.

entity - The entity to fill.

createEntity

public final TEntity createEntity(int recordIndex,
                                  @Nonnull
                                  Transaction transaction)

Creates an entity with the data from a specified record in the data set.

Parameters:

recordIndex - The index of the entity record from which to create the entity.

transaction - The transaction to use to set properties of the entity.

Returns:

The new entity created from the data record.

Throws:

IllegalStateException - The data set does not contain the EntityIdentifier (get) property, which is required in order to create an entity.

ArgumentNullException - Thrown when transaction is null.