net.powermatcher.api.data

Class PricePoint

java.lang.Object

net.powermatcher.api.data.PricePoint

All Implemented Interfaces:

java.lang.Comparable<PricePoint>

public class PricePoint
extends java.lang.Object
implements java.lang.Comparable<PricePoint>

PricePoint represents a Price and the demand that goes with it.

Constructor Summary

Constructors

Constructor and Description
PricePoint(MarketBasis marketBasis, double price, double demand) A copy constructor used to create a PricePoint with a new MarketBasis.
PricePoint(Price price, double demand) A constructor to create an instance of PricePoint.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PricePoint that) Compares this object with the specified object for order.
boolean	equals(java.lang.Object obj)
double	getDemand()
Price	getPrice()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PricePoint

public PricePoint(Price price,
          double demand)

A constructor to create an instance of PricePoint.

Parameters:

price - the Price value

demand - the double value of the demand

PricePoint

public PricePoint(MarketBasis marketBasis,
          double price,
          double demand)

A copy constructor used to create a PricePoint with a new MarketBasis.

Parameters:

marketBasis - the new MarketBasis

price - the Price value

demand - the double value of the demand

Method Detail

getPrice

public Price getPrice()

Returns:

the current value of price.

getDemand

public double getDemand()

Returns:

the current value of demand.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(PricePoint that)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. This method first compares the Price values of both PricePoints. Then it compares the demand values of both instances. The one with the highest value is the greatest.

Specified by:

compareTo in interface java.lang.Comparable<PricePoint>

Parameters:

that - The PricePoint instance you want to compare with this one.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.