genius.core.parties

Class AbstractNegotiationParty

java.lang.Object

genius.core.parties.AbstractNegotiationParty

All Implemented Interfaces:

NegotiationParty, java.io.Serializable

Direct Known Subclasses:

BoaParty

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

A basic implementation of the NegotiationParty interface. This basic implementation sets up some common variables for you.

Author:

David Festen, Reyhan (The random bid generator)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Random	rand Random seed used by this party.
protected TimeLineInfo	timeline Time line used by the party if time deadline is set.
protected PairwiseComparisonUserModel	userModel
protected AbstractUtilitySpace	utilitySpace utility space used by this party (set in constructor).

Constructor Summary

Constructors

Constructor and Description
AbstractNegotiationParty()

Method Summary

Modifier and Type	Method and Description
protected Bid	generateRandomBid() Generates a random bid which will be generated using this.utilitySpace.
PersistentDataContainer	getData()
Deadline	getDeadlines()
Action	getLastReceivedAction()
int	getNumberOfParties()
AgentID	getPartyId()
java.lang.Class<? extends MultilateralProtocol>	getProtocol() Get the protocol that this party supports.
protected Value	getRandomValue(Issue currentIssue) Gets a random value for the given issue.
TimeLineInfo	getTimeLine() Gets this agent's time line.
double	getUtility(Bid bid) Gets the utility for the given bid.
AbstractUtilitySpace	getUtilitySpace() Gets this agent's utility space.
double	getUtilityWithDiscount(Bid bid) Gets the time discounted utility for the given bid.
void	init(NegotiationInfo info) Initializes the party, informing it of many negotiation details.
java.util.HashMap<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 act) This method is called to inform the party that another NegotiationParty chose an Action.
java.lang.String	toString() Returns a human readable string representation of this party.

Methods inherited from class java.lang.Object

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

Methods inherited from interface genius.core.parties.NegotiationParty

chooseAction, getDescription

Field Detail

timeline

protected TimeLineInfo timeline

Time line used by the party if time deadline is set.

rand

protected java.util.Random rand

Random seed used by this party.

utilitySpace

protected AbstractUtilitySpace utilitySpace

utility space used by this party (set in constructor). NOTICE this is protected and appears to be used directly by lots of implementations.

userModel

protected PairwiseComparisonUserModel userModel

Constructor Detail

AbstractNegotiationParty

public AbstractNegotiationParty()

Method Detail

init

public 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.

generateRandomBid

protected Bid generateRandomBid()

Generates a random bid which will be generated using this.utilitySpace.

Returns:

A random bid

getRandomValue

protected Value getRandomValue(Issue currentIssue)
                        throws java.lang.Exception

Gets a random value for the given issue.

Parameters:

currentIssue - The issue to generate a random value for

Returns:

The random value generated for the issue

Throws:

java.lang.Exception - if the issues type is not Discrete, Real or Integer.

getUtility

public double getUtility(Bid bid)

Gets the utility for the given bid.

Parameters:

bid - The bid to get the utility for

Returns:

A double value between [0, 1] (inclusive) that represents the bids utility

getUtilityWithDiscount

public double getUtilityWithDiscount(Bid bid)

Gets the time discounted utility for the given bid.

Parameters:

bid - The bid to get the utility for

Returns:

A double value between [0, 1] (inclusive) that represents the bids utility

getUtilitySpace

public final AbstractUtilitySpace getUtilitySpace()

Gets this agent's utility space.

Returns:

The utility space

getTimeLine

public TimeLineInfo getTimeLine()

Gets this agent's time line.

Returns:

The time line for this agent

toString

public java.lang.String toString()

Returns a human readable string representation of this party.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of party id

receiveMessage

public void receiveMessage(AgentID sender,
                           Action act)

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).

act - The action performed

getLastReceivedAction

public Action getLastReceivedAction()

Returns:

last received Action or null if nothing received yet.

getNumberOfParties

public int getNumberOfParties()

getPartyId

public final AgentID getPartyId()

getProtocol

public 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 java.util.HashMap<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.

getData

public PersistentDataContainer getData()

Returns:

persistent data

getDeadlines

public Deadline getDeadlines()