ch.tatool.data

Interface DataService

All Known Implementing Classes:

DataServiceImpl

public interface DataService

Interface for working with different module data management methods.

Author:

Michael Ruflin

Method Summary

Methods

Modifier and Type	Method and Description
ModuleSession	createSession(Module module) Create a new session.
List<Object[]>	findDistinctSessionPropertyNames(Module module) Get all distinct session property names for a module.
List<Object[]>	findDistinctTrialPropertyNames(Module module) Get all distinct trial property names for a module.
void	finishSession(ModuleSession session) Finish a module session This will set the end time of the session
ModuleSession	getLastSession(Module module, boolean includeUnfinished) Get the last session of a module.
Messages	getMessages() Gets the messages used by Tatool
long	getSessionCount(Module module, boolean includeUnfinished) Get the number of sessions in a module
List<ModuleSession>	getSessions(Module module) Get all sessions for a given module
List<Trial>	getTrials(Module module, ModuleSession session, Node node, int maxResults) Get a list of trials for a given element, ordered by the most recent trial first.
List<Trial>	getTrials(Module module, ModuleSession session, String elementNameLike, String propertyNameLike, int offSet, int maxResults) Get a list of x trials with a given property of a given element, ordered by the most recent trial first.
List<Trial>	getTrials(ModuleSession session) Get all trials for a session.
void	insertTrial(ModuleSession session, Trial trial) Inserts a new trial object into the session.
void	saveModule(Module module) Save the module instance.
void	saveSession(ModuleSession session) Save a session without finishing it.
void	setMessages(Messages messages) Sets the messages used by Tatool

Method Detail

saveModule

void saveModule(Module module)

Save the module instance. This will save all changed module properties

createSession

ModuleSession createSession(Module module)

Create a new session. This will set the session start date

saveSession

void saveSession(ModuleSession session)

Save a session without finishing it.

finishSession

void finishSession(ModuleSession session)

Finish a module session This will set the end time of the session

getSessions

List<ModuleSession> getSessions(Module module)

Get all sessions for a given module

getLastSession

ModuleSession getLastSession(Module module,
                           boolean includeUnfinished)

Get the last session of a module.

Parameters:

module - the module to search for

Returns:

the last created session

getSessionCount

long getSessionCount(Module module,
                   boolean includeUnfinished)

Get the number of sessions in a module

Parameters:

module - the module to check

includeUnfinished - whether to include unfinished sessions (sessions without end time)

Returns:

insertTrial

void insertTrial(ModuleSession session,
               Trial trial)

Inserts a new trial object into the session.

getTrials

List<Trial> getTrials(ModuleSession session)

Get all trials for a session.

getTrials

List<Trial> getTrials(Module module,
                    ModuleSession session,
                    Node node,
                    int maxResults)

Get a list of trials for a given element, ordered by the most recent trial first.

Parameters:

the - training to find trials for

session - the session to find trials in. Use null to search for all sessions

node - the element to find trials for. Use null to search for all element.

maxResults - the maximum amount of results.

Returns:

a list of trials

getTrials

List<Trial> getTrials(Module module,
                    ModuleSession session,
                    String elementNameLike,
                    String propertyNameLike,
                    int offSet,
                    int maxResults)

Get a list of x trials with a given property of a given element, ordered by the most recent trial first.

Parameters:

training - The training to search for

session - The sessions the trials should be belong to, null if all sessions should be taken into account

elementNameLike - the name of the element to search for (either this or propertyName needs to be non-null)

propertyNameLike - the name of the property to search for (either this or elementName needs to be non-null

offSet - the offset to start from, starting with 0

maxResults - the maximum number of Trials to return, -1 for all results

Returns:

a list of Trials

findDistinctTrialPropertyNames

List<Object[]> findDistinctTrialPropertyNames(Module module)

Get all distinct trial property names for a module.

Returns:

An array with [0] containing the item name, [1] the property name

findDistinctSessionPropertyNames

List<Object[]> findDistinctSessionPropertyNames(Module module)

Get all distinct session property names for a module.

Returns:

An array with [0] containing the item name, [1] the property name

setMessages

void setMessages(Messages messages)

Sets the messages used by Tatool

getMessages

Messages getMessages()

Gets the messages used by Tatool