net.officefloor.frame.impl.execute.work

Class WorkContainerImpl<W extends Work>

java.lang.Object

net.officefloor.frame.impl.execute.work.WorkContainerImpl<W>

All Implemented Interfaces:

WorkContainer<W>

public class WorkContainerImpl<W extends Work>
extends Object
implements WorkContainer<W>

Container of a Work instance.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
WorkContainerImpl(W work, WorkMetaData<W> workMetaData, ProcessState processState) Initiate.

Method Summary

Modifier and Type	Method and Description
void	administerManagedObjects(TaskDutyAssociation<?> duty, AdministratorContext adminContext, ContainerContext containerContext) Administers the ManagedObject instances as per the input TaskDutyAssociation.
void	coordinateManagedObjects(ManagedObjectIndex[] managedObjectIndexes, JobContext jobContext, JobNode jobNode, JobNodeActivateSet notifySet, ContainerContext context) Coordinates the ManagedObject instances.
Object	getObject(ManagedObjectIndex index, ThreadState threadState) Obtains the Object of the particular ManagedObject.
W	getWork(ThreadState threadState) Obtains the Work being managed.
void	governManagedObjects(ManagedObjectIndex[] managedObjectIndexes, JobContext jobContext, JobNode jobNode, JobNodeActivateSet activateSet, ContainerContext context) Governs the ManagedObject instances.
boolean	isManagedObjectsReady(ManagedObjectIndex[] managedObjectIndexes, JobContext jobContext, JobNode jobNode, JobNodeActivateSet notifySet, ContainerContext context) Indicates if the particular ManagedObject is ready for use.
void	loadManagedObjects(ManagedObjectIndex[] managedObjectIndexes, JobContext jobContext, JobNode jobNode, JobNodeActivateSet notifySet, TeamIdentifier currentTeam, ContainerContext context) Triggers for the particular ManagedObject instances to be loaded.
void	unloadWork(JobNodeActivateSet activateSet, TeamIdentifier currentTeam) Unloads the Work.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkContainerImpl

public WorkContainerImpl(W work,
                         WorkMetaData<W> workMetaData,
                         ProcessState processState)

Initiate.

Parameters:

work - Work to be managed.

workMetaData - WorkMetaData.

processState - ProcessState.

Method Detail

getWork

public W getWork(ThreadState threadState)

Description copied from interface: WorkContainer

Obtains the Work being managed.

Specified by:

getWork in interface WorkContainer<W extends Work>

Parameters:

threadState - ThreadState requiring the Work.

Returns:

Work being managed.

loadManagedObjects

public void loadManagedObjects(ManagedObjectIndex[] managedObjectIndexes,
                               JobContext jobContext,
                               JobNode jobNode,
                               JobNodeActivateSet notifySet,
                               TeamIdentifier currentTeam,
                               ContainerContext context)

Description copied from interface: WorkContainer

Triggers for the particular ManagedObject instances to be loaded.

Specified by:

loadManagedObjects in interface WorkContainer<W extends Work>

Parameters:

managedObjectIndexes - ManagedObjectIndex instances identifying the ManagedObject instances to be loaded.

jobContext - Context for executing the JobNode.

jobNode - JobNode requesting the ManagedObject instances to be loaded.

notifySet - JobNodeActivateSet to add JobNode instances to activate.

currentTeam - TeamIdentifier of the current Team loading the ManagedObject instances.

context - ContainerContext.

governManagedObjects

public void governManagedObjects(ManagedObjectIndex[] managedObjectIndexes,
                                 JobContext jobContext,
                                 JobNode jobNode,
                                 JobNodeActivateSet activateSet,
                                 ContainerContext context)

Description copied from interface: WorkContainer

Governs the ManagedObject instances.

Specified by:

governManagedObjects in interface WorkContainer<W extends Work>

Parameters:

managedObjectIndexes - ManagedObjectIndex instances identifying the ManagedObject instances for Governance.

jobContext - Context for executing the JobNode.

jobNode - JobNode requesting the ManagedObject instances for Governance.

activateSet - JobNodeActivateSet to add JobNode instances to activate.

context - ContainerContext.

coordinateManagedObjects

public void coordinateManagedObjects(ManagedObjectIndex[] managedObjectIndexes,
                                     JobContext jobContext,
                                     JobNode jobNode,
                                     JobNodeActivateSet notifySet,
                                     ContainerContext context)

Description copied from interface: WorkContainer

Coordinates the ManagedObject instances.

Specified by:

coordinateManagedObjects in interface WorkContainer<W extends Work>

Parameters:

managedObjectIndexes - ManagedObjectIndex instances identifying the ManagedObject instances to be coordinated.

jobContext - Context for executing the JobNode.

jobNode - JobNode requesting the ManagedObject instances to be coordinated.

notifySet - JobNodeActivateSet to add JobNode instances to activate.

context - ContainerContext.

isManagedObjectsReady

public boolean isManagedObjectsReady(ManagedObjectIndex[] managedObjectIndexes,
                                     JobContext jobContext,
                                     JobNode jobNode,
                                     JobNodeActivateSet notifySet,
                                     ContainerContext context)

Description copied from interface: WorkContainer

Indicates if the particular ManagedObject is ready for use. In other words it has finished any asynchronous operations and is ready for further use.

Specified by:

isManagedObjectsReady in interface WorkContainer<W extends Work>

Parameters:

managedObjectIndexes - ManagedObjectIndex instances identifying the ManagedObject instances to check if ready.

jobContext - Context for executing the JobNode.

jobNode - JobNode requiring the ManagedObject to be ready.

notifySet - JobNodeActivateSet to add JobNode instances to activate.

context - ContainerContext.

Returns:

true if the ManagedObject is ready for use, otherwise false indicating that waiting on the ManagedObject.

administerManagedObjects

public void administerManagedObjects(TaskDutyAssociation<?> duty,
                                     AdministratorContext adminContext,
                                     ContainerContext containerContext)
                              throws Throwable

Description copied from interface: WorkContainer

Administers the ManagedObject instances as per the input TaskDutyAssociation.

Specified by:

administerManagedObjects in interface WorkContainer<W extends Work>

Parameters:

duty - TaskDutyAssociation specifying the administration to be undertaken.

adminContext - AdministratorContext.

containerContext - ContainerContext.

Throws:

Throwable - If fails to administer the ManagedObject instances.

getObject

public Object getObject(ManagedObjectIndex index,
                        ThreadState threadState)

Description copied from interface: WorkContainer

Obtains the Object of the particular ManagedObject.

Specified by:

getObject in interface WorkContainer<W extends Work>

Parameters:

index - ManagedObjectIndex identifying the ManagedObject.

threadState - ThreadState.

Returns:

Object of the particular ManagedObject.

unloadWork

public void unloadWork(JobNodeActivateSet activateSet,
                       TeamIdentifier currentTeam)

Description copied from interface: WorkContainer

Unloads the Work.

Specified by:

unloadWork in interface WorkContainer<W extends Work>

Parameters:

activateSet - JobNodeActivateSet to add JobNode instances to activate.

currentTeam - TeamIdentifier of the current Team unloading the Work.