agi.foundation.tracking

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

Class MemoryArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

java.lang.Object

agi.foundation.tracking.TrackingArchive<TEntity>

agi.foundation.tracking.MemoryArchive<TEntity>

Type Parameters:

TEntity - The entity type to archive.

All Implemented Interfaces:

IDisposable, AutoCloseable

public class MemoryArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>
extends TrackingArchive<TEntity>

A TrackingArchive that stores tracking data in memory.

Constructor Summary

Constructors

Constructor and Description
MemoryArchive(TypeLiteral<TEntity> typeLiteralTEntity, TransactionContext context) Construct a new instance with the provided context.
MemoryArchive(TypeLiteral<TEntity> typeLiteralTEntity, TransactionContext context, TrackingTypeArchiverCollection typeArchivers) Construct a new instance with the provided context and type archivers.

Method Summary

Modifier and Type	Method and Description
protected void	archiveEntities(Transaction transaction, Iterable<? extends TEntity> entities) Archives a set of entities.
void	clear() Clears the contents of the archive.
TimeInterval	getArchivedInterval() Gets the overall interval that exists in the archive for any entity.
TimeInterval	getArchivedInterval(Object entityIdentifier) Gets the overall interval that exists in the archive for the specified entity identifier.
protected Object[]	getArchivedPrimitivePropertyComponents(Iterable<? extends ArchivedProperty> primitivePropertyComponents, JulianDate start, JulianDate stop, int maximumRecords) Retrieves archived primitive property components for all entities over the provided time period.
protected Object[]	getArchivedPrimitivePropertyComponents(Object entityIdentifier, Iterable<? extends ArchivedProperty> primitivePropertyComponents, JulianDate start, JulianDate stop, int maximumRecords) Retrieves archived primitive property components for the provided entity over the provided time period.

Methods inherited from class agi.foundation.tracking.TrackingArchive

dispose, dispose, getArchivedData, getArchivedData, getContext, getEntityPrimitivePropertyComponents, getIsRunning, getMaximumQueueLength, getMotion1, getMotion1, getMotion2, getMotion2, getOrientations, getOrientations, getOrientations, getPositions, getPositions, getPositions, getPrimitivePropertyComponents, getProperties, getTypeArchivers, setMaximumQueueLength, startWriting, stopWriting, waitForArchiveQueue, writingShutdown, writingStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

MemoryArchive

public MemoryArchive(TypeLiteral<TEntity> typeLiteralTEntity,
                     @Nonnull
                     TransactionContext context)

Construct a new instance with the provided context.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

context - The context in which archiving is to take place.

MemoryArchive

public MemoryArchive(TypeLiteral<TEntity> typeLiteralTEntity,
                     @Nonnull
                     TransactionContext context,
                     @Nonnull
                     TrackingTypeArchiverCollection typeArchivers)

Construct a new instance with the provided context and type archivers.

Parameters:

typeLiteralTEntity - A TypeLiteral object representing the generic type TEntity.

context - The context in which archiving is to take place.

typeArchivers - The type archivers to use to archive entity properties.

Method Detail

clear

public void clear()

Clears the contents of the archive.

Specified by:

clear in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

getArchivedPrimitivePropertyComponents

protected Object[] getArchivedPrimitivePropertyComponents(Iterable<? extends ArchivedProperty> primitivePropertyComponents,
                                                          @Nonnull
                                                          JulianDate start,
                                                          @Nonnull
                                                          JulianDate stop,
                                                          int maximumRecords)

Retrieves archived primitive property components for all entities over the provided time period.

Specified by:

getArchivedPrimitivePropertyComponents in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

Parameters:

primitivePropertyComponents - The archived properties to retrieve.

start - The time of the first property to retrieve.

stop - The time of the last property to retrieve.

maximumRecords - The maximum number of each property to retrieve.

Returns:

The array of primitive components.

getArchivedPrimitivePropertyComponents

protected Object[] getArchivedPrimitivePropertyComponents(Object entityIdentifier,
                                                          Iterable<? extends ArchivedProperty> primitivePropertyComponents,
                                                          @Nonnull
                                                          JulianDate start,
                                                          @Nonnull
                                                          JulianDate stop,
                                                          int maximumRecords)

Retrieves archived primitive property components for the provided entity over the provided time period.

Specified by:

getArchivedPrimitivePropertyComponents in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

Parameters:

entityIdentifier - The identifier of the entity whose properties to retrieve.

primitivePropertyComponents - The archived properties to retrieve.

start - The time of the first property to retrieve.

stop - The time of the last property to retrieve.

maximumRecords - The maximum number of each property to retrieve.

Returns:

The array of primitive components.

archiveEntities

protected void archiveEntities(Transaction transaction,
                               Iterable<? extends TEntity> entities)

Archives a set of entities.

Specified by:

archiveEntities in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

Parameters:

transaction - A transaction that should be used to retrieve properties of the entities. It is possible for later transactions to commit additional updates before this method is called for older updates. However, this transaction will see the state of the system as of the time that the updates being archived were committed. Using this transaction rather than creating a separate one will guarantee that updates are not missed.

entities - The entities to archive.

getArchivedInterval

public TimeInterval getArchivedInterval(Object entityIdentifier)

Gets the overall interval that exists in the archive for the specified entity identifier.

Specified by:

getArchivedInterval in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

Parameters:

entityIdentifier - The identifier of the entity for which to obtain the interval of availability.

Returns:

The interval of archived data.

getArchivedInterval

public TimeInterval getArchivedInterval()

Gets the overall interval that exists in the archive for any entity.

Specified by:

getArchivedInterval in class TrackingArchive<TEntity extends IEntityIdentifier & IEntityLastUpdate>

Returns:

The interval of archived data.