genius.core

Class AgentAdapter

java.lang.Object

genius.core.AgentAdapter

All Implemented Interfaces:

NegotiationParty, java.io.Serializable

Direct Known Subclasses:

Agent

public abstract class AgentAdapter
extends java.lang.Object
implements NegotiationParty

Adapts Agent to the NegotiationParty so that legacy agents can be run in the new multiparty system. Notice that these agents could handle only 1 opponent, and thus may behave weird if presented with more than one opponent. What is unusual (in the Java sense) is that Agent extends this, not the other way round. This way, all old agents also become a NegotiationParty.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AgentAdapter()

Method Summary

Modifier and Type	Method and Description
Action	chooseAction(java.util.List<java.lang.Class<? extends Action>> possibleActions) When this function is called, it is expected that the Party chooses one of the actions from the possible action list and returns an instance of the chosen action.
protected abstract Agent	getAgent()
java.lang.String	getDescription() This is a convenience wrapper so that we don't have to fix all old agent descriptions (these used to be in the xml file)
java.lang.Class<? extends MultilateralProtocol>	getProtocol() Get the protocol that this party supports.
void	init(NegotiationInfo info) Initializes the party, informing it of many negotiation details.
java.util.Map<java.lang.String,java.lang.String>	negotiationEnded(Bid acceptedBid) This is called to inform the agent that the negotiation has been ended.
void	receiveMessage(AgentID sender, Action action) This method is called to inform the party that another NegotiationParty chose an Action.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentAdapter

public AgentAdapter()

Method Detail

getAgent

protected abstract Agent getAgent()

Returns:

the actual agent that is being adapted.

init

public final void init(NegotiationInfo info)

Description copied from interface: NegotiationParty

Initializes the party, informing it of many negotiation details. This MUST be called exactly once, immediately after construction of any class implementing this.

Specified by:

init in interface NegotiationParty

Parameters:

info - information about the negotiation that this party is part of.

chooseAction

public final Action chooseAction(java.util.List<java.lang.Class<? extends Action>> possibleActions)

Description copied from interface: NegotiationParty

When this function is called, it is expected that the Party chooses one of the actions from the possible action list and returns an instance of the chosen action.

Specified by:

chooseAction in interface NegotiationParty

Parameters:

possibleActions - List of all actions possible.

Returns:

The chosen Action.

receiveMessage

public final void receiveMessage(AgentID sender,
                                 Action action)

Description copied from interface: NegotiationParty

This method is called to inform the party that another NegotiationParty chose an Action.

Specified by:

receiveMessage in interface NegotiationParty

Parameters:

sender - The initiator of the action.This is either the AgentID, or null if the sender is not an agent (e.g., the protocol).

action - The action performed

getDescription

public java.lang.String getDescription()

This is a convenience wrapper so that we don't have to fix all old agent descriptions (these used to be in the xml file)

Specified by:

getDescription in interface NegotiationParty

Returns:

a human-readable description for this party.

getProtocol

public final java.lang.Class<? extends MultilateralProtocol> getProtocol()

Description copied from interface: NegotiationParty

Get the protocol that this party supports.

Specified by:

getProtocol in interface NegotiationParty

Returns:

the actual supported MultilateralProtocol, usually StackedAlternatingOffersProtocol.

negotiationEnded

public final java.util.Map<java.lang.String,java.lang.String> negotiationEnded(Bid acceptedBid)

Description copied from interface: NegotiationParty

This is called to inform the agent that the negotiation has been ended. This allows the agent to record some final conclusions about the run.

Specified by:

negotiationEnded in interface NegotiationParty

Parameters:

acceptedBid - the final accepted bid, or null if no agreement was reached.

Returns:

Map containing data to log for this agent. null is equal to returning an empty HashMap. Typically, this info will be logged by XmlWriteStream.write(String, java.util.Map) to an XML file.