| org.cougaar.planning.ldm.plan.ClusterObjectFactory
All known Subclasses: org.cougaar.planning.ldm.plan.ClusterObjectFactoryImpl, org.cougaar.planning.ldm.PlanningFactoryImpl,
| ClusterObjectFactory | | public interface ClusterObjectFactory (Code) | | Top-level Factory for Cluster Objects which can be created by Plugins
of various sorts.
While we do not subset these interfaces at this time, one should
keep in mind that a given component may choose to both
restrict access to (by throwing exceptions) these accessors and to
choose how these objects actually get realized.
The majority of the factory methods are of the form NewFoo newFoo()
where Foo is the basic type to be constructed. The
Return value is always an Interface type which extends the basic
type with set-methods and other methods useful for constructing
objects of this basic type.
There a few factory methods that return a completed or built object.
These methods usually take arguments that are used to build the object.
The Interface return type are usually not the extending interfaces which
contain set-methods (since the object has already been built).
|
| Method Summary | |
| Aggregation | createAggregation(Plan aPlan, Task aTask, Composition aComposition, AllocationResult estimatedresult)
| | Allocation | createAllocation(Plan aPlan, Task aTask, org.cougaar.planning.ldm.asset.Asset anAsset, AllocationResult estimatedresult, Role aRole)
| | AssetTransfer | createAssetTransfer(Plan aPlan, Task aTask, org.cougaar.planning.ldm.asset.Asset anAsset, Schedule aSchedule, org.cougaar.planning.ldm.asset.Asset toAsset, AllocationResult estimatedresult, Role aRole)
Build a new AssetTransfer (planelement)
Parameters:
aPlan - The Plan this PlanElement is against
Parameters:
aTask - The Task being disposed
Parameters:
anAsset - The Asset that is being transferred
Parameters:
aSchedule - The Schedule that represents the time window the Asset will be transferred for
Parameters:
toAsset - The Asset to which the transferred Asset is being transferred. | | Disposition | createDisposition(Plan aPlan, Task aTask, AllocationResult result)
| | Expansion | createExpansion(Plan aPlan, Task aTask, Workflow aWorkflow, AllocationResult estimatedresult)
| | Disposition | createFailedDisposition(Plan aPlan, Task aTask, AllocationResult failure)
| | TransferableTransfer | createTransferableTransfer(Transferable aTransferable, Asset anAsset)
| | MessageAddress | getMessageAddress()
| | Plan | getRealityPlan()
Return a reference to the the plan object which represents
"reality" in this cluster. | | Verb | getVerb(String v)
| | AllocationResult | newAVAllocationResult(double rating, boolean success, AspectValue[] aspectvalues)
| | AllocationResult | newAVPhasedAllocationResult(double rating, boolean success, AspectValue[] rollupavs, Collection phasedresults)
| | NewAlert | newAlert()
| | NewAlertParameter | newAlertParameter()
| | AllocationResult | newAllocationResult(double rating, boolean success, int[] aspecttypes, double[] result)
Create a new NON-PHASE AllocationResult
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
aspecttypes - The AspectTypes (and order) of the results.
Parameters:
result - The value for each aspect. | | AllocationResult | newAllocationResult(double rating, boolean success, AspectValue[] avrs)
Create a new NON-PHASE AllocationResult
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
avrs - The AspectValues of the result. | | NewAssetAssignment | newAssetAssignment()
| | AssetRescind | newAssetRescind(org.cougaar.planning.ldm.asset.Asset asset, org.cougaar.planning.ldm.asset.Asset rescindeeAsset, Schedule rescindSchedule)
Build an AssetRescind Message. | | NewAssetVerification | newAssetVerification()
| | NewAssetVerification | newAssetVerification(Asset asset, Asset assignee, Schedule schedule)
| | NewAssignedAvailabilityElement | newAssignedAvailabilityElement()
| | NewAssignedAvailabilityElement | newAssignedAvailabilityElement(Asset assignee, long startTime, long endTime)
| | NewSchedule | newAssignedAvailabilitySchedule(Enumeration availElements)
Build an asset transfer availabity schedule. | | NewSchedule | newAssignedAvailabilitySchedule()
| | NewAssignedRelationshipElement | newAssignedRelationshipElement()
| | NewAssignedRelationshipElement | newAssignedRelationshipElement(Asset assetA, Role roleA, Asset assetB, long startTime, long endTime)
| | NewAssignedRelationshipElement | newAssignedRelationshipElement(Relationship relationship)
| | NewSchedule | newAssignedRelationshipSchedule(Enumeration elements)
Create an assigned relationship schedule. | | NewSchedule | newAssignedRelationshipSchedule()
Create an empty assigned relationship schedule. | | BulkEstimate | newBulkEstimate(Task atask, List prefsets, double conf)
| | NewComposition | newComposition()
| | NewConstraint | newConstraint()
| | NewDeletion | newDeletion()
| | NewItineraryElement | newItineraryElement()
| | NewSchedule | newLocationRangeSchedule(Enumeration locationRangeElements)
Create a location range schedule. | | NewLocationRangeScheduleElement | newLocationRangeScheduleElement()
| | NewSchedule | newLocationSchedule(Enumeration locationElements)
Create a location schedule. | | NewLocationScheduleElement | newLocationScheduleElement()
| | NewMPTask | newMPTask()
| | NewNotification | newNotification()
| | AllocationResult | newPhasedAllocationResult(double rating, boolean success, int[] aspecttypes, double[] rollup, Enumeration allresults)
Create a new PHASED AllocationResult instance. | | AllocationResult | newPhasedAllocationResult(double rating, boolean success, AspectValue[] rollup, Enumeration allresults)
Create a new PHASED AllocationResult instance. | | AllocationResult | newPhasedAllocationResult(double rating, boolean success, AspectValue[] rollupavs, Collection phasedresults)
Create a new AllocationResult that takes a PHASED result in the form of AspectValues.
Subclasses of AspectValue, such as TypedQuantityAspectValue are allowed.
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
rollupavs - The Summary (or rolled up) AspectValues that represent the results.
Parameters:
phasedresults - A Collection of the phased results. | | Policy | newPolicy(String policyType)
| | Preference | newPreference(int aspecttype, ScoringFunction scorefunction)
Create a new Preference. | | Preference | newPreference(int aspecttype, ScoringFunction scorefunction, double aweight)
Create a new Preference with a weight. | | NewPrepositionalPhrase | newPrepositionalPhrase()
| | PrepositionalPhrase | newPrepositionalPhrase(String preposition, Object indirectObject)
| | Relationship | newRelationship(Role role1, HasRelationships object1, HasRelationships object2, TimeSpan timeSpan)
| | Relationship | newRelationship(Role role1, HasRelationships object1, HasRelationships object2, long startTime, long endTime)
newRelationship - returns a Relationship
Parameters:
role1 - Role for object1
Parameters:
object1 - HasRelationships which has role1
Parameters:
object2 - HasRelationships which is the other half of the relationship, role set at role1.getConverse()
Parameters:
startTime - long which specifies the start of the relationship
Parameters:
endTime - long which specifies the end of the relationship. | | Relationship | newRelationship(AssignedRelationshipElement assignedRelationship, Asset asset1, Asset asset2)
newRelationship - returns a Relationship based on the specified
AssignedRelationshipElement. | | NewRelationshipSchedule | newRelationshipSchedule(HasRelationships hasRelationships)
Build an empty relationship schedule for the specified HasRelationships. | | NewRelationshipSchedule | newRelationshipSchedule(HasRelationships hasRelationships, Collection relationships)
Build a new relationship schedule for the specified HasRelationships.
Parameters:
hasRelationships - HasRelationships to which the relationship schedule applies. | | NewReport | newReport()
| | NewSchedule | newSchedule(Enumeration scheduleElements)
Create a schedule that contains different types of scheduleelements. | | NewScheduleElement | newScheduleElement(Date start, Date end)
| | NewSchedule | newSimpleSchedule(Date start, Date end)
Build a new simple schedule that contains only one start and end
date. | | NewSchedule | newSimpleSchedule(long startTime, long endTime)
Build a new simple schedule that contains only one start and end
date. | | NewTask | newTask()
| | NewTask | newTask(UID uid)
| | TaskRescind | newTaskRescind(Task task, MessageAddress destination)
Build a TaskRescind Message. | | TaskRescind | newTaskRescind(UID taskUID, MessageAddress destination)
Build a TaskRescind Message. | | TaskRescind | newTaskRescind(UID taskUID, MessageAddress destination, boolean deleted)
Build a TaskRescind Message. | | NewTransferableAssignment | newTransferableAssignment()
| | NewTransferableRescind | newTransferableRescind()
| | NewTransferableTransfer | newTransferableTransfer()
| | NewTransferableVerification | newTransferableVerification(Transferable t)
| | NewWorkflow | newWorkflow()
| | NewTask | shadowTask(Task t)
Low-level task duplication. |
| createAssetTransfer | | AssetTransfer createAssetTransfer(Plan aPlan, Task aTask, org.cougaar.planning.ldm.asset.Asset anAsset, Schedule aSchedule, org.cougaar.planning.ldm.asset.Asset toAsset, AllocationResult estimatedresult, Role aRole)(Code) | | Build a new AssetTransfer (planelement)
Parameters:
aPlan - The Plan this PlanElement is against
Parameters:
aTask - The Task being disposed
Parameters:
anAsset - The Asset that is being transferred
Parameters:
aSchedule - The Schedule that represents the time window the Asset will be transferred for
Parameters:
toAsset - The Asset to which the transferred Asset is being transferred. Must have a ClusterPG
Parameters:
estimatedresult - - allowed to be null
Parameters:
aRole - The Role of the Asset while transferred AssetTransfer |
| createTransferableTransfer | | TransferableTransfer createTransferableTransfer(Transferable aTransferable, Asset anAsset)(Code) | | Build a new TransferableTransfer
Parameters:
aTransferable -
Parameters:
anAsset - - should be of type Organization TranserableTransfer |
| getRealityPlan | | Plan getRealityPlan()(Code) | | Return a reference to the the plan object which represents
"reality" in this cluster.
|
| newAllocationResult | | AllocationResult newAllocationResult(double rating, boolean success, int[] aspecttypes, double[] result)(Code) | | Create a new NON-PHASE AllocationResult
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
aspecttypes - The AspectTypes (and order) of the results.
Parameters:
result - The value for each aspect. AllocationResult A new AllocationResult |
| newAllocationResult | | AllocationResult newAllocationResult(double rating, boolean success, AspectValue[] avrs)(Code) | | Create a new NON-PHASE AllocationResult
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
avrs - The AspectValues of the result. AllocationResult A new AllocationResult |
| newAssignedRelationshipSchedule | | NewSchedule newAssignedRelationshipSchedule(Enumeration elements)(Code) | | Create an assigned relationship schedule. This schedule is a container
of AssignedRelationshipElements. Should only be used by logic providers
in handling new/modified/removed AssetTransfers.
Parameters:
elements - Enumeration{AssignedRelationshipElement}
See Also: org.cougaar.planning.ldm.plan.AssignedRelationshipElement |
| newBulkEstimate | | BulkEstimate newBulkEstimate(Task atask, List prefsets, double conf)(Code) | | Create a new BulkEstimate
Parameters:
atask - The Task to test allocations against preference sets
Parameters:
prefsets - A List containing Preference[] represening the preference sets.
Parameters:
conf - The confidence rating the allocation results should reach before returning final results BulkEstimate |
| newPhasedAllocationResult | | AllocationResult newPhasedAllocationResult(double rating, boolean success, int[] aspecttypes, double[] rollup, Enumeration allresults)(Code) | | Create a new PHASED AllocationResult instance.
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
aspecttypes - The AspectTypes (and order) of the results.
Parameters:
rollup - The summary values for each aspect.
Parameters:
allresults - An Enumeration of Vectors representingeach phased collection of results.For Example a phased answer may look like[ [10, 100.00, c0], [5, 50.00, c3], [5, 50.00, c6] ] AllocationResult |
| newPhasedAllocationResult | | AllocationResult newPhasedAllocationResult(double rating, boolean success, AspectValue[] rollup, Enumeration allresults)(Code) | | Create a new PHASED AllocationResult instance.
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
rollup - The summary values for each aspect as AspectValues.
Parameters:
allresults - An Enumeration of Vectors representingeach phased collection of results.For Example a phased answer may look like[ [10, 100.00, c0], [5, 50.00, c3], [5, 50.00, c6] ] AllocationResult |
| newPhasedAllocationResult | | AllocationResult newPhasedAllocationResult(double rating, boolean success, AspectValue[] rollupavs, Collection phasedresults)(Code) | | Create a new AllocationResult that takes a PHASED result in the form of AspectValues.
Subclasses of AspectValue, such as TypedQuantityAspectValue are allowed.
Parameters:
rating - The confidence rating of this result.
Parameters:
success - Whether the allocationresult violated any preferences.
Parameters:
rollupavs - The Summary (or rolled up) AspectValues that represent the results.
Parameters:
phasedresults - A Collection of the phased results. The Collection must contain one Collection or Array of AspectValues for each phase of the results. AllocationResult |
| newRelationship | | Relationship newRelationship(Role role1, HasRelationships object1, HasRelationships object2, TimeSpan timeSpan)(Code) | | newRelationship - returns a Relationship
Parameters:
role1 - Role for object1
Parameters:
object1 - HasRelationships which has role1
Parameters:
object2 - HasRelationships which is the other half of the relationship, role set at role1.getConverse()
Parameters:
timeSpan - TimeSpan for which the relationship is valid |
| newRelationship | | Relationship newRelationship(Role role1, HasRelationships object1, HasRelationships object2, long startTime, long endTime)(Code) | | newRelationship - returns a Relationship
Parameters:
role1 - Role for object1
Parameters:
object1 - HasRelationships which has role1
Parameters:
object2 - HasRelationships which is the other half of the relationship, role set at role1.getConverse()
Parameters:
startTime - long which specifies the start of the relationship
Parameters:
endTime - long which specifies the end of the relationship.
See Also: org.cougaar.util.TimeSpan |
| newRelationship | | Relationship newRelationship(AssignedRelationshipElement assignedRelationship, Asset asset1, Asset asset2)(Code) | | newRelationship - returns a Relationship based on the specified
AssignedRelationshipElement. Specified assets must match the
item identifications in the AssignedRelationshipElement
Parameters:
assignedRelationship - AssignedRelationshipElement
Parameters:
asset1 - Asset to be used in converting the AssignedRelationshipElement
Parameters:
asset2 - Asset other asset to be used in converting the AssignedRelationshipElement |
| newRelationshipSchedule | | NewRelationshipSchedule newRelationshipSchedule(HasRelationships hasRelationships)(Code) | | Build an empty relationship schedule for the specified HasRelationships.
Parameters:
hasRelationships - HasRelationships to which the relationship schedule will apply |
| newRelationshipSchedule | | NewRelationshipSchedule newRelationshipSchedule(HasRelationships hasRelationships, Collection relationships)(Code) | | Build a new relationship schedule for the specified HasRelationships.
Parameters:
hasRelationships - HasRelationships to which the relationship schedule applies. N.B. hasRelationships must be included in all the Relationships on the schedule.
Parameters:
relationships - Collection of Relationships for the specified HasRelationships. |
| newSimpleSchedule | | NewSchedule newSimpleSchedule(Date start, Date end)(Code) | | Build a new simple schedule that contains only one start and end
date.
Parameters:
start - - The start Date of the schedule
Parameters:
end - - the end or finish Date of the schedule Schedule - a schedule object containing one scheduleelement
See Also: java.util.Date |
| newSimpleSchedule | | NewSchedule newSimpleSchedule(long startTime, long endTime)(Code) | | Build a new simple schedule that contains only one start and end
date.
Parameters:
startTime - - The start time of the schedule
Parameters:
endTime - - the end or finish time of the schedule Schedule - a schedule object containing one scheduleelement
See Also: java.util.Date |
| newTaskRescind | | TaskRescind newTaskRescind(Task task, MessageAddress destination)(Code) | | Build a TaskRescind Message. This message is only sent by
CCRescind - NOT PLUGINS!!!.
The deleted status is taken from the task
Parameters:
task - - The Task to be rescinded
Parameters:
destination - - The Cluster to send the TaskRescind Message to. TaskRescind |
| newTaskRescind | | TaskRescind newTaskRescind(UID taskUID, MessageAddress destination)(Code) | | Build a TaskRescind Message. This message is only sent by
CCRescind - NOT PLUGINS!!!.
The deleted status is assumed to be false
Parameters:
taskUID - - The UID of the Task to be rescinded
Parameters:
destination - - The Cluster to send the TaskRescind Message to. TaskRescind |
| newTaskRescind | | TaskRescind newTaskRescind(UID taskUID, MessageAddress destination, boolean deleted)(Code) | | Build a TaskRescind Message. This message is only sent by
CCRescind - NOT PLUGINS!!!.
The deleted status is explicitly specifed by the deleted parameter
Parameters:
taskUID - - The UID of the Task to be rescinded
Parameters:
destination - - The Cluster to send the TaskRescind Message to.
Parameters:
deleted - - Mark the TaskRescind as referring to a deleted task. TaskRescind |
| shadowTask | | NewTask shadowTask(Task t)(Code) | | Low-level task duplication. Tasks created by this method are
not suitable for use as blackboard Objects. This method should
only be called by networking infrastructure.
|
|
|