genius.core

Class Bid

java.lang.Object

genius.core.Bid

All Implemented Interfaces:

java.io.Serializable

public class Bid
extends java.lang.Object
implements java.io.Serializable

A bid is a set of tuples [idnumber,value], where idnumber is the unique number of the issue, and value is the picked alternative.

Bid is a immutable. But you can create modified copies using putValue(int, Value). Bid should be considered final so do not extend this.

Author:

Dmytro Tykhonov, Koen Hindriks

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Bid(Bid bid) This method clones the given bid.
Bid(Domain domain) Create a new empty bid of which the values still must be set.
Bid(Domain domain, java.util.Collection<IssueValue> values) create bid from set of IssueValues
Bid(Domain domainP, java.util.HashMap<java.lang.Integer,Value> bidP) createFrom a new bid in a domain.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Bid pBid)
boolean	equals(java.lang.Object obj)
Domain	getDomain()
java.util.List<Issue>	getIssues()
Value	getValue(int issueNr)
java.util.HashMap<java.lang.Integer,Value>	getValues()
int	hashCode()
Bid	putValue(int issueId, Value pValue)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Bid

public Bid(Domain domain)

Create a new empty bid of which the values still must be set.

Parameters:

domain - the domain for this bid

Bid

public Bid(Domain domainP,
           java.util.HashMap<java.lang.Integer,Value> bidP)

createFrom a new bid in a domain. Partially checks the validity of the bid as well There is only this constructor because we require that ALL values in the domain get assigned a value.

Parameters:

domainP - the domain in which the bid is done

bidP - HashMap, which is a set of pairs [issueID,value]

Bid

public Bid(Domain domain,
           java.util.Collection<IssueValue> values)

create bid from set of IssueValues

Parameters:

domain - the Domain

values - a Collection of IssueValues

Bid

public Bid(Bid bid)

This method clones the given bid.

Parameters:

bid - the bid to clone

Method Detail

getValue

public Value getValue(int issueNr)

Parameters:

issueNr - number of an issue.

Returns:

the picked value for given issue idnumber

Throws:

java.lang.IllegalArgumentException - if there exist no issue with the given number.

putValue

public Bid putValue(int issueId,
                    Value pValue)

Parameters:

issueId - unique ID of an issue.

pValue - value of the issue.

Returns:

new Bid as the current bid but with the value of the issue with the given issueID to the given value

Throws:

java.lang.IllegalArgumentException - if there exist no issue with the given number.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(Bid pBid)

Parameters:

pBid - to which this bid must be compared.

Returns:

true if the values of this and the given bid are equal.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getValues

public java.util.HashMap<java.lang.Integer,Value> getValues()

Returns:

a (copy of ) the list of all values in this bid. FIXME we really should return an immutable Map here but that may break many agents.

getIssues

public java.util.List<Issue> getIssues()

getDomain

public Domain getDomain()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object