Package net.officefloor.frame.impl.execute.office

Class OfficeMetaDataImpl

java.lang.Object

net.officefloor.frame.impl.execute.office.OfficeMetaDataImpl

All Implemented Interfaces:

OfficeMetaData

public class OfficeMetaDataImpl
extends java.lang.Object
implements OfficeMetaData

OfficeMetaData implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor

Description

OfficeMetaDataImpl(java.lang.String officeName, OfficeManagerHirer officeManagerHirer, MonitorClock monitorClock, FunctionLoop functionLoop, ThreadLocalAwareExecutor threadLocalAwareExecutor, Executive executive, ManagedExecutionFactory managedExecutionFactory, ManagedFunctionMetaData<?,?>[] functionMetaDatas, ManagedFunctionLocator functionLocator, ProcessMetaData processMetaData, ManagedFunctionMetaData<?,?> stateKeepAliveFunctionMetaData, java.util.Map<java.lang.String,ManagedFunctionMetaData<?,?>> loadObjectMetaDatas, OfficeStartupFunction[] startupFunctions, Profiler profiler)

Initiate.

Method Summary

Modifier and Type	Method	Description
FunctionState	createProcess(FlowMetaData flowMetaData, java.lang.Object parameter, FlowCallback callback, ThreadState callbackThreadState)	Creates a new ProcessState.
ProcessIdentifier	createProcessIdentifier(ProcessState processState)	Creates a ProcessIdentifier for a new ProcessState.
StateManager	createStateManager()	Creates a StateManager.
Executive	getExecutive()	Obtains the Executive for this Office.
java.util.concurrent.Executor	getExecutor(ProcessIdentifier processIdentifier)	Obtains the Executor for the ProcessState.
FunctionLoop	getFunctionLoop()	Obtains the FunctionLoop for the Office.
ManagedExecutionFactory	getManagedExecutionFactory()	Obtains the ManagedExecutionFactory for this Office.
ManagedFunctionLocator	getManagedFunctionLocator()	Obtains the ManagedFunctionLocator.
ManagedFunctionMetaData<?,?>[]	getManagedFunctionMetaData()	Obtains the ManagedFunctionMetaData of the ManagedFunction that may be done within this Office.
MonitorClock	getMonitorClock()	Obtains the MonitorClock for the Office.
OfficeManager	getOfficeManager(ProcessIdentifier processIdentifier)	Obtains the OfficeManager for the ProcessState.
java.lang.String	getOfficeName()	Obtains the name of the Office.
ProcessMetaData	getProcessMetaData()	Obtains the ProcessMetaData for processes within this Office.
OfficeStartupFunction[]	getStartupFunctions()	Obtains the OfficeStartupFunction instances for this Office.
ProcessManager	invokeProcess(FlowMetaData flowMetaData, java.lang.Object parameter, long delay, FlowCallback callback, ThreadState callbackThreadState, ManagedObject inputManagedObject, ManagedObjectMetaData<?> inputManagedObjectMetaData, int processBoundIndexForInputManagedObject)	Invokes a ProcessState.
OfficeManager	setupDefaultOfficeManager()	Sets up the default OfficeManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeMetaDataImpl

public OfficeMetaDataImpl(java.lang.String officeName,
                          OfficeManagerHirer officeManagerHirer,
                          MonitorClock monitorClock,
                          FunctionLoop functionLoop,
                          ThreadLocalAwareExecutor threadLocalAwareExecutor,
                          Executive executive,
                          ManagedExecutionFactory managedExecutionFactory,
                          ManagedFunctionMetaData<?,?>[] functionMetaDatas,
                          ManagedFunctionLocator functionLocator,
                          ProcessMetaData processMetaData,
                          ManagedFunctionMetaData<?,?> stateKeepAliveFunctionMetaData,
                          java.util.Map<java.lang.String,ManagedFunctionMetaData<?,?>> loadObjectMetaDatas,
                          OfficeStartupFunction[] startupFunctions,
                          Profiler profiler)

Initiate.

Parameters:

officeName - Name of the Office.

officeManagerHirer - OfficeManagerHirer.

monitorClock - MonitorClock.

functionLoop - FunctionLoop.

threadLocalAwareExecutor - ThreadLocalAwareExecutor.

executive - Executive.

managedExecutionFactory - ManagedExecutionFactory.

functionMetaDatas - ManagedFunctionMetaData of the ManagedFunction that can be executed within the Office.

functionLocator - ManagedFunctionLocator.

processMetaData - ProcessMetaData of the ProcessState instances created within this Office.

stateKeepAliveFunctionMetaData - ManagedFunctionMetaData of the ManagedFunction that keeps the StateManager active.

loadObjectMetaDatas - Load object ManagedFunctionMetaData by ManagedObject bound name.

startupFunctions - OfficeStartupFunction instances.

profiler - Profiler.

Method Detail

getOfficeName

public java.lang.String getOfficeName()

Description copied from interface: OfficeMetaData

Obtains the name of the Office.

Specified by:

getOfficeName in interface OfficeMetaData

Returns:

Name of the Office.

createProcessIdentifier

public ProcessIdentifier createProcessIdentifier(ProcessState processState)

Description copied from interface: OfficeMetaData

Creates a ProcessIdentifier for a new ProcessState.

Specified by:

createProcessIdentifier in interface OfficeMetaData

Parameters:

processState - New ProcessState.

Returns:

New ProcessIdentifier.

getOfficeManager

public OfficeManager getOfficeManager(ProcessIdentifier processIdentifier)

Description copied from interface: OfficeMetaData

Obtains the OfficeManager for the ProcessState.

Specified by:

getOfficeManager in interface OfficeMetaData

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState.

Returns:

OfficeManager of the Office.

getExecutor

public java.util.concurrent.Executor getExecutor(ProcessIdentifier processIdentifier)

Description copied from interface: OfficeMetaData

Obtains the Executor for the ProcessState.

Specified by:

getExecutor in interface OfficeMetaData

Parameters:

processIdentifier - ProcessIdentifier of the ProcessState.

Returns:

Executor for the ProcessState.

getMonitorClock

public MonitorClock getMonitorClock()

Description copied from interface: OfficeMetaData

Obtains the MonitorClock for the Office.

Specified by:

getMonitorClock in interface OfficeMetaData

Returns:

MonitorClock for the Office.

getFunctionLoop

public FunctionLoop getFunctionLoop()

Description copied from interface: OfficeMetaData

Obtains the FunctionLoop for the Office.

Specified by:

getFunctionLoop in interface OfficeMetaData

Returns:

FunctionLoop for the Office.

getProcessMetaData

public ProcessMetaData getProcessMetaData()

Description copied from interface: OfficeMetaData

Obtains the ProcessMetaData for processes within this Office.

Specified by:

getProcessMetaData in interface OfficeMetaData

Returns:

ProcessMetaData for processes within this Office.

getManagedFunctionMetaData

public ManagedFunctionMetaData<?,?>[] getManagedFunctionMetaData()

Description copied from interface: OfficeMetaData

Obtains the ManagedFunctionMetaData of the ManagedFunction that may be done within this Office.

Specified by:

getManagedFunctionMetaData in interface OfficeMetaData

Returns:

ManagedFunctionMetaData instances of this Office.

getManagedFunctionLocator

public ManagedFunctionLocator getManagedFunctionLocator()

Description copied from interface: OfficeMetaData

Obtains the ManagedFunctionLocator.

Specified by:

getManagedFunctionLocator in interface OfficeMetaData

Returns:

ManagedFunctionLocator.

getStartupFunctions

public OfficeStartupFunction[] getStartupFunctions()

Description copied from interface: OfficeMetaData

Obtains the OfficeStartupFunction instances for this Office.

Specified by:

getStartupFunctions in interface OfficeMetaData

Returns:

OfficeStartupFunction instances for this Office.

getExecutive

public Executive getExecutive()

Description copied from interface: OfficeMetaData

Obtains the Executive for this Office.

Specified by:

getExecutive in interface OfficeMetaData

Returns:

Executive for this Office.

getManagedExecutionFactory

public ManagedExecutionFactory getManagedExecutionFactory()

Description copied from interface: OfficeMetaData

Obtains the ManagedExecutionFactory for this Office.

Specified by:

getManagedExecutionFactory in interface OfficeMetaData

Returns:

ManagedExecutionFactory for this Office.

createProcess

public FunctionState createProcess(FlowMetaData flowMetaData,
                                   java.lang.Object parameter,
                                   FlowCallback callback,
                                   ThreadState callbackThreadState)

Description copied from interface: OfficeMetaData

Creates a new ProcessState.

Specified by:

createProcess in interface OfficeMetaData

Parameters:

flowMetaData - FlowMetaData of the starting FunctionState for the ProcessState.

parameter - Parameter to the starting FunctionState.

callback - Optional FlowCallback of the ProcessState. May be null.

callbackThreadState - Optional ThreadState for the FlowCallback. May be null.

Returns:

FunctionState to start processing the ProcessState.

setupDefaultOfficeManager

public OfficeManager setupDefaultOfficeManager()

Description copied from interface: OfficeMetaData

Sets up the default OfficeManager.

Specified by:

setupDefaultOfficeManager in interface OfficeMetaData

Returns:

Default OfficeManager.

createStateManager

public StateManager createStateManager()

Description copied from interface: OfficeMetaData

Creates a StateManager.

Specified by:

createStateManager in interface OfficeMetaData

Returns:

Statement.

invokeProcess

public ProcessManager invokeProcess(FlowMetaData flowMetaData,
                                    java.lang.Object parameter,
                                    long delay,
                                    FlowCallback callback,
                                    ThreadState callbackThreadState,
                                    ManagedObject inputManagedObject,
                                    ManagedObjectMetaData<?> inputManagedObjectMetaData,
                                    int processBoundIndexForInputManagedObject)
                             throws InvalidParameterTypeException

Description copied from interface: OfficeMetaData

Invokes a ProcessState.

Specified by:

invokeProcess in interface OfficeMetaData

Parameters:

flowMetaData - FlowMetaData of the starting FunctionState for the ProcessState.

parameter - Parameter to the starting FunctionState.

delay - Millisecond delay in invoking the ProcessState. 0 (or negative value) will invoke immediately on the current Thread.

callback - Optional FlowCallback of the ProcessState. May be null.

callbackThreadState - Optional ThreadState for the FlowCallback. May be null.

inputManagedObject - ManagedObject that possibly invoked the new ProcessState. This may be null and if so the remaining parameters will be ignored.

inputManagedObjectMetaData - ManagedObjectMetaData for the ManagedObject that invoked the new ProcessState. Should the ManagedObject be provided this must then also be provided.

processBoundIndexForInputManagedObject - Index of the ManagedObject within the ProcessState. Ignored if ManagedObject passed in is null.

Returns:

ProcessManager for the invoked ProcessState.

Throws:

InvalidParameterTypeException - Should the type of parameter be invalid for the initial ManagedFunction.