Package net.officefloor.frame.impl.construct.managedobject

Class RawBoundManagedObjectMetaData

java.lang.Object

net.officefloor.frame.impl.construct.managedobject.RawBoundManagedObjectMetaData

public class RawBoundManagedObjectMetaData
extends java.lang.Object

Raw meta-data for a bound ManagedObject.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
RawBoundManagedObjectMetaData(java.lang.String boundManagedObjectName, boolean isInput, ThreadLocalConfiguration threadLocalConfiguration)	Initiate.

Method Summary

Modifier and Type	Method	Description
RawBoundManagedObjectInstanceMetaData<?>	addInstance(java.lang.String boundManagedObjectName, RawManagedObjectMetaData<?,?> rawMoMetaData, ManagedObjectDependencyConfiguration<?>[] dependenciesConfiguration, ManagedObjectGovernanceConfiguration[] governanceConfiguration, AdministrationConfiguration<?,?,?>[] preloadAdministration)	Adds a RawBoundManagedObjectInstanceMetaData to this RawBoundManagedObjectMetaData.
static ManagedObjectIndex[]	createSortedRequiredManagedObjects(java.util.Map<ManagedObjectIndex,RawBoundManagedObjectMetaData> requiredManagedObjects, OfficeFloorIssues.AssetType assetType, java.lang.String assetName, OfficeFloorIssues issues)	Sorts the required ManagedObjectIndex instances for the ManagedFunction so that dependency ManagedObject instances are before the ManagedObject instances using them.
java.lang.String	getBoundManagedObjectName()	Obtains the name the ManagedObject is bound under.
int	getDefaultInstanceIndex()	Obtains the index of the default RawBoundManagedObjectInstanceMetaData for this RawBoundManagedObjectMetaData.
ManagedObjectIndex	getManagedObjectIndex()	Obtains the ManagedObjectIndex.
RawBoundManagedObjectInstanceMetaData<?>[]	getRawBoundManagedObjectInstanceMetaData()	Obtains the RawBoundManagedObjectInstanceMetaData instances for the ManagedObjectSource instances that may provide a ManagedObject for this RawBoundManagedObjectMetaData.
boolean	isInput()	Indicates if input.
static ManagedObjectIndex	loadRequiredManagedObjects(RawBoundManagedObjectMetaData boundMo, java.util.Map<ManagedObjectIndex,RawBoundManagedObjectMetaData> requiredManagedObjects)	Recursively loads all the ManagedObjectIndex instances for the RawBoundManagedObjectMetaData.
void	setManagedObjectIndex(ManagedObjectScope managedObjectScope, int indexOfManagedObjectWithinScope)	Specifies the ManagedObjectIndex.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawBoundManagedObjectMetaData

public RawBoundManagedObjectMetaData(java.lang.String boundManagedObjectName,
                                     boolean isInput,
                                     ThreadLocalConfiguration threadLocalConfiguration)

Initiate.

Parameters:

boundManagedObjectName - Name that the ManagedObject is bound under.

isInput - Indicates if an Input ManagedObject.

threadLocalConfiguration - ThreadLocalConfiguration. May be null.

Method Detail

loadRequiredManagedObjects

public static ManagedObjectIndex loadRequiredManagedObjects(RawBoundManagedObjectMetaData boundMo,
                                                            java.util.Map<ManagedObjectIndex,RawBoundManagedObjectMetaData> requiredManagedObjects)

Recursively loads all the ManagedObjectIndex instances for the RawBoundManagedObjectMetaData.

Parameters:

boundMo - RawBoundManagedObjectMetaData.

requiredManagedObjects - Mapping of the required ManagedObjectIndex instances by the ManagedFunction to their respective RawBoundManagedObjectMetaData.

Returns:

ManagedObjectIndex of the input RawBoundManagedObjectMetaData.

createSortedRequiredManagedObjects

public static ManagedObjectIndex[] createSortedRequiredManagedObjects(java.util.Map<ManagedObjectIndex,RawBoundManagedObjectMetaData> requiredManagedObjects,
                                                                      OfficeFloorIssues.AssetType assetType,
                                                                      java.lang.String assetName,
                                                                      OfficeFloorIssues issues)

Sorts the required ManagedObjectIndex instances for the ManagedFunction so that dependency ManagedObject instances are before the ManagedObject instances using them. In essence this is a topological sort so that dependencies are first.

This is necessary for coordinating so that dependencies are coordinated before the ManagedObject instances using them are coordinated.

Parameters:

requiredManagedObjects - Mapping of the ManagedObjectIndex to its RawBoundManagedObjectMetaData.

assetType - OfficeFloorIssues.AssetType.

assetName - Name of asset to issues.

issues - OfficeFloorIssues.

Returns:

Listing of required ManagedObject instances to be sorted, or null indicating unable to sort, possible because of cyclic dependencies.

isInput

public boolean isInput()

Indicates if input.

Returns:

true if input.

setManagedObjectIndex

public void setManagedObjectIndex(ManagedObjectScope managedObjectScope,
                                  int indexOfManagedObjectWithinScope)

Specifies the ManagedObjectIndex.

Parameters:

managedObjectScope - ManagedObjectScope.

indexOfManagedObjectWithinScope - Index of the ManagedObject within the ManagedObjectScope.

addInstance

public RawBoundManagedObjectInstanceMetaData<?> addInstance(java.lang.String boundManagedObjectName,
                                                            RawManagedObjectMetaData<?,?> rawMoMetaData,
                                                            ManagedObjectDependencyConfiguration<?>[] dependenciesConfiguration,
                                                            ManagedObjectGovernanceConfiguration[] governanceConfiguration,
                                                            AdministrationConfiguration<?,?,?>[] preloadAdministration)

Adds a RawBoundManagedObjectInstanceMetaData to this RawBoundManagedObjectMetaData.

Parameters:

boundManagedObjectName - Name that the ManagedObject is bound under.

rawMoMetaData - RawManagedObjectMetaData.

dependenciesConfiguration - Listing of the ManagedObjectDependencyConfiguration for the RawBoundManagedObjectInstanceMetaData.

governanceConfiguration - Listing of the ManagedObjectGovernanceConfiguration for the RawBoundManagedObjectInstanceMetaData.

preloadAdministration - Listing of the pre-load AdministrationConfiguration for the RawBoundManagedObjectInstanceMetaData.

Returns:

RawBoundManagedObjectInstanceMetaData.

getBoundManagedObjectName

public java.lang.String getBoundManagedObjectName()

Obtains the name the ManagedObject is bound under.

Returns:

Name the ManagedObject is bound under.

getManagedObjectIndex

public ManagedObjectIndex getManagedObjectIndex()

Obtains the ManagedObjectIndex.

Returns:

ManagedObjectIndex.

getDefaultInstanceIndex

public int getDefaultInstanceIndex()

Obtains the index of the default RawBoundManagedObjectInstanceMetaData for this RawBoundManagedObjectMetaData.

Returns:

Index of the default RawBoundManagedObjectInstanceMetaData for this RawBoundManagedObjectMetaData.

getRawBoundManagedObjectInstanceMetaData

public RawBoundManagedObjectInstanceMetaData<?>[] getRawBoundManagedObjectInstanceMetaData()

Obtains the RawBoundManagedObjectInstanceMetaData instances for the ManagedObjectSource instances that may provide a ManagedObject for this RawBoundManagedObjectMetaData.

Returns:

RawBoundManagedObjectMetaData instances for this RawBoundManagedObjectMetaData.