casa.policy.sc3

Class ConcreteCommitmentProcessor

java.lang.Object

casa.CommitmentProcessor

casa.policy.sc3.ConcreteCommitmentProcessor

All Implemented Interfaces:

Comparable<ConcreteCommitmentProcessor>

public class ConcreteCommitmentProcessor
extends CommitmentProcessor
implements Comparable<ConcreteCommitmentProcessor>

Title: CASA Agent Infrastructure

Description:

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, University of Calgary

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	expiredMemoryTime Remember expired and fulfilled commitments for an hour
protected SocialCommitmentsStore	store
protected long	StoreTransactionCount Use for debugging.

Fields inherited from class casa.CommitmentProcessor

agent

Constructor Summary

Constructors

Constructor and Description
ConcreteCommitmentProcessor(PolicyAgentInterface agent, SocialCommitmentsStore store)

Method Summary

Modifier and Type	Method and Description
protected SocialCommitment	choose()
protected SocialCommitment	choose(List<SocialCommitment> coll) Choose a commitment to focus on by first calling the owner agent's TransientAgent.chooseSC(Collection) method; if that method returns null (indicating it doesn't want to make the decision) then choose the first commitment that has a priority higher or equal to and other commitment.
protected SocialCommitment	chooseWithoutMarking()
protected SocialCommitment	chooseWithoutMarking(List<SocialCommitment> coll)
int	compareTo(ConcreteCommitmentProcessor o)
protected SocialCommitment	findMoreSpecific(SocialCommitment chosen, Collection<SocialCommitment> coll)
protected List<SocialCommitment>	getActiveCommitments()
SocialCommitmentsStore	getStore() Return the social commitment store.
boolean	hasActiveCommitments()
boolean	isStoppable() determines if this process can be stopped.
private boolean	isSubsumedBy(SocialCommitment c1, SocialCommitment c2)
SocialCommitment	peek()
protected PerformDescriptor	perform(SocialCommitment commitment, PolicyAgentInterface agent)
SocialCommitment	processCommitment(SocialCommitment sc)
SocialCommitment	processCommitments() If there are active social commitments in the store, choose one, and execute it and return true.
String	toString()

Methods inherited from class casa.CommitmentProcessor

notifyMessageSent

Methods inherited from class java.lang.Object

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

Field Detail

store

protected SocialCommitmentsStore store

StoreTransactionCount

protected long StoreTransactionCount

Use for debugging. Records the last number of transactions we saw in the store so we can tell if anything potentially interesting has happened.

expiredMemoryTime

protected static final long expiredMemoryTime

Remember expired and fulfilled commitments for an hour

See Also:

Constant Field Values

Constructor Detail

ConcreteCommitmentProcessor

public ConcreteCommitmentProcessor(PolicyAgentInterface agent,
                                   SocialCommitmentsStore store)

Method Detail

processCommitments

public SocialCommitment processCommitments()

If there are active social commitments in the store, choose one, and execute it and return true. If there are no active social commitments return false. A social commitment is chosen by calling #choose(Collection).

Specified by:

processCommitments in class CommitmentProcessor

Returns:

true if it did something; otherwise false

processCommitment

public SocialCommitment processCommitment(SocialCommitment sc)

Specified by:

processCommitment in class CommitmentProcessor

hasActiveCommitments

public boolean hasActiveCommitments()

Specified by:

hasActiveCommitments in class CommitmentProcessor

getActiveCommitments

protected List<SocialCommitment> getActiveCommitments()

choose

protected SocialCommitment choose()

Specified by:

choose in class CommitmentProcessor

Returns:

a single commitment from the active commitments in the store.

See Also:

getActiveCommitments(), choose(List)

choose

protected SocialCommitment choose(List<SocialCommitment> coll)

Choose a commitment to focus on by first calling the owner agent's TransientAgent.chooseSC(Collection) method; if that method returns null (indicating it doesn't want to make the decision) then choose the first commitment that has a priority higher or equal to and other commitment. But if there is a more specific commitment than this one choose that one instead. Care is taken to mark previously chosen commitments so that if this method is called repeatedly with the same argument collection, it will not keep choosing the same commitment, but will iterate through the collection. In the event all the commitments have been marked, it unmarks them all, and proceeds as usual.

Parameters:

coll - The collection of commitments to pick from

Returns:

The chosen commitment

chooseWithoutMarking

protected SocialCommitment chooseWithoutMarking()

chooseWithoutMarking

protected SocialCommitment chooseWithoutMarking(List<SocialCommitment> coll)

findMoreSpecific

protected SocialCommitment findMoreSpecific(SocialCommitment chosen,
                                            Collection<SocialCommitment> coll)

Parameters:

chosen - the current candidate commitment

coll - the list of other possible candidate commitments to consider

Returns:

Finds the most specific commitment available (by subsumption)

isSubsumedBy

private boolean isSubsumedBy(SocialCommitment c1,
                             SocialCommitment c2)

Parameters:

c1 - the candidate child commitment

c2 - the candidate parent commitment

Returns:

whether c1 is more specific than c2.

perform

protected PerformDescriptor perform(SocialCommitment commitment,
                                    PolicyAgentInterface agent)

toString

public String toString()

Overrides:

toString in class Object

isStoppable

public boolean isStoppable()

Description copied from class: CommitmentProcessor

determines if this process can be stopped. A subclass may override if there are more constraints on stopping. This implementation checks to see that event queue is empty and there are no (non-standing-request) requests with replies pending.

Specified by:

isStoppable in class CommitmentProcessor

Returns:

true if the process is stoppable, false otherwise.

peek

public SocialCommitment peek()

Specified by:

peek in class CommitmentProcessor

getStore

public SocialCommitmentsStore getStore()

Return the social commitment store.

Specified by:

getStore in class CommitmentProcessor

Returns:

the social commitment store

See Also:

CommitmentProcessor.getStore()

compareTo

public int compareTo(ConcreteCommitmentProcessor o)

Specified by:

compareTo in interface Comparable<ConcreteCommitmentProcessor>