org.leialearns.logic.session

Interface Session

public interface Session

Defines an object that can be used to create and/or obtain Versions of various types of models. A session is assumed to be associated with a single thread of execution.

Method Summary

Methods

Modifier and Type	Method and Description
Counted	createCountedVersion() Creates a new Counted object for this session.
Toggled	createToggledVersion(Node node, boolean include) Creates a new Toggled object for this session.
Version	createVersion(ModelType modelType) Creates a new version instance.
Version	findLastVersion(ModelType modelType, AccessMode accessMode) Returns the last version of the given model type and with the given access mode.
Version	findOrCreateLastVersion(ModelType modelType, AccessMode accessMode) Returns the last version of the given model type and with the given access mode.
Version	findVersion(long ordinal) Returns the version that is associated with the given ordinal.
Version.Iterable	findVersionsInRange(long minOrdinal, long maxOrdinal, ModelType modelType, AccessMode accessMode) Returns all versions of the given model type and with the given access mode.
void	flush() Flushes all cached data to persistent storage.
Histogram	getHistogram(Version version, Node node) Retrieves a histogram from the cache.
InteractionContext	getInteractionContext() Returns the interaction context associated with this session.
Root	getRoot() Returns the root object associated with this session.
void	logVersions(String label, Version.Iterable versions) Logs the given versions.
void	putHistogram(Histogram histogram) Stores the given histogram in the cache
Session	refresh() Returns a fresh copy of the session that is (re)attached to the ORM framework.

Method Detail

getRoot

Root getRoot()

Returns the root object associated with this session.

Returns:

The root object associated with this session

getInteractionContext

InteractionContext getInteractionContext()

Returns the interaction context associated with this session.

Returns:

The interaction context associated with this session

createVersion

Version createVersion(ModelType modelType)

Creates a new version instance. The ordinal of the new version is guaranteed to be greater than all versions created or obtained earlier in the same session (assuming that the session is associated with a single thread of execution).

Parameters:

modelType - The model type for the new version

Returns:

The new version instance

findVersion

Version findVersion(long ordinal)

Returns the version that is associated with the given ordinal. Returns null if no such version exists.

Parameters:

ordinal - The ordinal of the version

Returns:

The version that is associated with the given ordinal

findLastVersion

Version findLastVersion(ModelType modelType,
                      AccessMode accessMode)

Returns the last version of the given model type and with the given access mode. Returns null if no such version exists.

Parameters:

modelType - The model type of the requested version

accessMode - The access model of the requested version

Returns:

The last version that matches the parameters

findOrCreateLastVersion

Version findOrCreateLastVersion(ModelType modelType,
                              AccessMode accessMode)

Returns the last version of the given model type and with the given access mode. Returns a new version object if no such version exists.

Parameters:

modelType - The model type of the requested version

accessMode - The access model of the requested version

Returns:

The last version that matches the parameters

findVersionsInRange

Version.Iterable findVersionsInRange(long minOrdinal,
                                   long maxOrdinal,
                                   ModelType modelType,
                                   AccessMode accessMode)

Returns all versions of the given model type and with the given access mode. The versions are returned in order of ascending ordinals.

Parameters:

minOrdinal - The minimum for the ordinals of the returned versions

maxOrdinal - The maximum for the ordinals of the returned versions

modelType - The model type of the requested versions

accessMode - The access model of the requested versions

Returns:

All versions that match the parameters

logVersions

void logVersions(String label,
               Version.Iterable versions)

Logs the given versions. This produces a log record for each combination of a node (either an internal node or a leaf) in the structure that underlies the versions and a symbol that was recorded for that node. Each log record logs the path in the structure tree, the symbol and the values for that combination of node and symbol in the respective versions.

Parameters:

label - A descriptive label for the block of log records

versions - The versions to log

createCountedVersion

Counted createCountedVersion()

Creates a new Counted object for this session.

Returns:

A new Counted object

createToggledVersion

Toggled createToggledVersion(Node node,
                           boolean include)

Creates a new Toggled object for this session.

Parameters:

node - The node that is toggled

include - Tha flag that indicates whether the given node is included in the new model of expected behavior

Returns:

A new Toggled object for this session

getHistogram

Histogram getHistogram(Version version,
                     Node node)

Retrieves a histogram from the cache.

Parameters:

version - The version of the requested histogram

node - The node of the requested histogram

Returns:

The requested histogram

putHistogram

void putHistogram(Histogram histogram)

Stores the given histogram in the cache

Parameters:

histogram - The histogram to store

refresh

Session refresh()

Returns a fresh copy of the session that is (re)attached to the ORM framework.

Returns:

A fresh copy of the session

flush

void flush()

Flushes all cached data to persistent storage.