net.powermatcher.core.concentrator

Class Concentrator

java.lang.Object

net.powermatcher.core.BaseAgent

net.powermatcher.core.BaseAgentEndpoint

net.powermatcher.core.concentrator.Concentrator

All Implemented Interfaces:

Agent, AgentEndpoint, MatcherEndpoint, ObservableAgent

Direct Known Subclasses:

PeakShavingConcentrator

public class Concentrator
extends BaseAgentEndpoint
implements MatcherEndpoint

This class represents a Concentrator component where several instances can be created.

The Concentrator receives Bid from the agents and forwards this in an aggregate Bid up in the hierarchy to a Concentrator or to the Auctioneer. It will receive price updates from the Auctioneer and forward them to its connected agents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Concentrator.Config

Nested classes/interfaces inherited from class net.powermatcher.core.BaseAgentEndpoint

BaseAgentEndpoint.Connected

Nested classes/interfaces inherited from interface net.powermatcher.api.Agent

Agent.Status

Nested classes/interfaces inherited from interface net.powermatcher.api.AgentEndpoint

AgentEndpoint.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected Concentrator.Config	config

Fields inherited from class net.powermatcher.core.BaseAgentEndpoint

NOT_CONNECTED

Fields inherited from class net.powermatcher.core.BaseAgent

context, LOGGER

Constructor Summary

Constructors

Constructor and Description
Concentrator()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(Concentrator.Config config) Convenient activate method that takes a Concentrator.Config object.
void	activate(java.util.Map<java.lang.String,?> properties) OSGi calls this method to activate a managed service.
void	addObserver(AgentObserver observer) Used to add an AgentObserver to the list of observers of this instance.
void	agentEndpointDisconnected(Session session) Notifies the Agent that this MatcherEndpoint instance is disconnected from the AgentEndpoint.
void	connectToAgent(Session session) Connects this MatcherEndpoint instance to an AgentEndpoint.
void	connectToMatcher(Session session) Connects this AgentEndpoint instance to a MatcherEndpoint.
void	deactivate() OSGi calls this method to deactivate a managed service.
void	handleBidUpdate(Session session, BidUpdate bidUpdate) Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.
void	handlePriceUpdate(PriceUpdate priceUpdate) Called by MatcherEndpoint via the Session to update the Price used by this AgentEndpoint instance.
void	matcherEndpointDisconnected(Session session) Notifies the Agent that this AgentEndpoint instance is disconnected from the MatcherEndpoint.
void	removeObserver(AgentObserver observer) Used to remove an AgentObserver from the list of observers of this instance.
void	setContext(org.flexiblepower.context.FlexiblePowerContext context) Give the agent a reference to a FlexiblePowerContext.
protected Bid	transformBid(Bid aggregatedBid) This method should be overridden when the bid that will be sent has to be changed.
protected Price	transformPrice(Price price, SentBidInformation info) This method should be overridden when the price that will be sent down has to be changed.

Methods inherited from class net.powermatcher.core.BaseAgentEndpoint

getAgentId, getDesiredParentId, getLastBidUpdate, getStatus, init, publishBid

Methods inherited from class net.powermatcher.core.BaseAgent

now, publishEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.powermatcher.api.Agent

getAgentId, getStatus

Field Detail

config

protected Concentrator.Config config

Constructor Detail

Concentrator

public Concentrator()

Method Detail

activate

public void activate(java.util.Map<java.lang.String,?> properties)

OSGi calls this method to activate a managed service.

Parameters:

properties - the configuration properties

activate

public void activate(Concentrator.Config config)

Convenient activate method that takes a Concentrator.Config object. This also makes subclassing easier.

Parameters:

config - The Concentrator.Config object that configures this concentrator

setContext

public void setContext(org.flexiblepower.context.FlexiblePowerContext context)

Description copied from interface: Agent

Give the agent a reference to a FlexiblePowerContext. This should be done by the runtime bundle after the component is activated.

Specified by:

setContext in interface Agent

Overrides:

setContext in class BaseAgent

Parameters:

context - reference to the FlexiblePowerContext

See Also:

Agent.setContext(org.flexiblepower.context.FlexiblePowerContext)

deactivate

public void deactivate()

OSGi calls this method to deactivate a managed service.

Overrides:

deactivate in class BaseAgentEndpoint

connectToMatcher

public void connectToMatcher(Session session)

Description copied from class: BaseAgentEndpoint

Connects this AgentEndpoint instance to a MatcherEndpoint.

Specified by:

connectToMatcher in interface AgentEndpoint

Overrides:

connectToMatcher in class BaseAgentEndpoint

Parameters:

session - the Session that will link this AgentEndpoint with a MatcherEndpoint.

matcherEndpointDisconnected

public void matcherEndpointDisconnected(Session session)

Description copied from class: BaseAgentEndpoint

Notifies the Agent that this AgentEndpoint instance is disconnected from the MatcherEndpoint.

Specified by:

matcherEndpointDisconnected in interface AgentEndpoint

Overrides:

matcherEndpointDisconnected in class BaseAgentEndpoint

Parameters:

session - the Session that used to link the MatcherEndpoint with this AgentEndpoint.

handlePriceUpdate

public void handlePriceUpdate(PriceUpdate priceUpdate)

Called by MatcherEndpoint via the Session to update the Price used by this AgentEndpoint instance. This base implementation checks if the PriceUpdate is valid and publishes the IncomingPriceUpdateEvent.

Specified by:

handlePriceUpdate in interface AgentEndpoint

Overrides:

handlePriceUpdate in class BaseAgentEndpoint

Parameters:

priceUpdate - The new Price, wrapped in a PriceUpdate, along with the id of the Bid it was based on.

transformBid

protected Bid transformBid(Bid aggregatedBid)

This method should be overridden when the bid that will be sent has to be changed.

Parameters:

aggregatedBid - The (input) aggregated bid as calculated normally (the sum of all the bids of the agents).

Returns:

The bid that will be sent to the matcher that is connected to this Concentrator.

transformPrice

protected Price transformPrice(Price price,
                   SentBidInformation info)

This method should be overridden when the price that will be sent down has to be changed. This is called just before the price will be sent down to the connected agents.

Parameters:

price - The input price update as received from the connected matcher.

info - The information about the bid that has been send

Returns:

The Price as it has to be sent to the connected agents.

agentEndpointDisconnected

public void agentEndpointDisconnected(Session session)

Description copied from interface: MatcherEndpoint

Notifies the Agent that this MatcherEndpoint instance is disconnected from the AgentEndpoint.

Specified by:

agentEndpointDisconnected in interface MatcherEndpoint

Parameters:

session - the Session that used to link this MatcherEndpoint with an AgentEndpoint.

connectToAgent

public void connectToAgent(Session session)

Description copied from interface: MatcherEndpoint

Connects this MatcherEndpoint instance to an AgentEndpoint.

Specified by:

connectToAgent in interface MatcherEndpoint

Parameters:

session - the Session that will link this AgentEndpoint with a MatcherEndpoint.

handleBidUpdate

public void handleBidUpdate(Session session,
                   BidUpdate bidUpdate)

Description copied from interface: MatcherEndpoint

Called by the AgentEndpoint via the Session to update the Bid used by this AgentEndpoint instance.

Specified by:

handleBidUpdate in interface MatcherEndpoint

Parameters:

session - The session linking this MatcherEndpoint with a specific AgentEndpoint instance.

bidUpdate - The new BidUpdate.

addObserver

public void addObserver(AgentObserver observer)

Description copied from class: BaseAgent

Used to add an AgentObserver to the list of observers of this instance.

Specified by:

addObserver in interface ObservableAgent

Overrides:

addObserver in class BaseAgent

Parameters:

observer - the new AgentObserver.

removeObserver

public void removeObserver(AgentObserver observer)

Description copied from class: BaseAgent

Used to remove an AgentObserver from the list of observers of this instance.

Specified by:

removeObserver in interface ObservableAgent

Overrides:

removeObserver in class BaseAgent

Parameters:

observer - the AgentObserver that will be removed.