agi.foundation.tracking

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

Class EntitySchema<TEntity>

java.lang.Object

agi.foundation.tracking.EntitySchema<TEntity>

Type Parameters:

TEntity - The type of the entity.

public class EntitySchema<TEntity>
extends Object

Describes the archived schema for an entity. An instance of this schema is provided to TrackingArchive via the IEntityArchiveDescriptor interface on an EntityDescriptor.

Constructor Summary

Constructors

Constructor and Description
EntitySchema(Class<?> entityIdentifierType) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
<T> void	addProperty(TypeLiteral<T> typeLiteralT, String name, EntityTransactedPropertyGetter<TEntity,T> transactedPropertyGetter) Adds a TransactedProperty to the schema.
Class<?>	getEntityIdentifierType() Gets the type of the EntityIdentifier (get) of this entity type.
List<EntitySchemaProperty<TEntity>>	getProperties() Gets the collection of properties in this schema.
int	getPropertyCount() Gets the number of properties in this schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitySchema

public EntitySchema(@Nonnull
                    Class<?> entityIdentifierType)

Initializes a new instance.

Parameters:

entityIdentifierType - The type of the EntityIdentifier (get) of this entity type.

Throws:

ArgumentNullException - Thrown when entityIdentifierType is null.

Method Detail

addProperty

public final <T> void addProperty(TypeLiteral<T> typeLiteralT,
                                  @Nonnull
                                  String name,
                                  @Nonnull
                                  EntityTransactedPropertyGetter<TEntity,T> transactedPropertyGetter)

Adds a TransactedProperty to the schema.

Type Parameters:

T - The type of the property.

Parameters:

typeLiteralT - A TypeLiteral object representing the generic type T.

name - The name of the property.

transactedPropertyGetter - A callback to use to obtain the TransactedProperty.

Throws:

ArgumentNullException - Thrown when name or transactedPropertyGetter is null.

ArgumentException - Thrown when name is an empty string, or if a property with the same name already exists in the schema.

getEntityIdentifierType

@Nonnull
public final Class<?> getEntityIdentifierType()

Gets the type of the EntityIdentifier (get) of this entity type.

getProperties

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

Gets the collection of properties in this schema.

getPropertyCount

public final int getPropertyCount()

Gets the number of properties in this schema.