ensemble

Class MusicalAgentComponent

java.lang.Object

ensemble.MusicalAgentComponent

All Implemented Interfaces:

LifeCycle, RouterClient

Direct Known Subclasses:

EventHandler, KnowledgeBase, Reasoning

public abstract class MusicalAgentComponent
extends java.lang.Object
implements LifeCycle, RouterClient

The Class MusicalAgentComponent.

Field Summary

Fields

Modifier and Type	Field and Description
private MusicalAgent	myAgent The my agent.
private java.lang.String	myName The my name.
private Constants.EA_STATE	myState The my state.
private java.lang.String	myType The my type.
protected Parameters	parameters The parameters.

Constructor Summary

Constructors

Constructor and Description
MusicalAgentComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String key, java.lang.String value) Adds the parameter.
void	addParameters(Parameters newParameters) Adds the parameters.
boolean	configure() User-implemented method that configures the component, setting up user parameters and essential properties.
boolean	finit() User-implemented finalization method, called by stop().
java.lang.String	getAddress() Returns this component framework address.
MusicalAgent	getAgent() Gets the agent.
java.lang.String	getComponentName() Gets the component name.
java.lang.String	getComponentType() Gets the component type.
java.lang.String	getParameter(java.lang.String key) Gets the parameter.
java.lang.String	getParameter(java.lang.String key, java.lang.String defaultValue) Gets the parameter.
Parameters	getParameters() Returns all configured parameters.
Constants.EA_STATE	getState() Gets the state.
java.lang.String	getType() Gets the type.
boolean	init() User-implemented initialization method, called by start().
boolean	parameterUpdate(java.lang.String name, java.lang.String newValue) User-implement method called when a parameter has been updated.
void	processCommand(Command cmd) An user-implemented method to process a received command.
void	receiveCommand(Command cmd) A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.
void	sendCommand(Command cmd) A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.
protected void	setAgent(MusicalAgent myAgent) Sets the agent.
protected void	setComponentName(java.lang.String myName) Sets the component name.
void	setParameters(Parameters parameters) Framework-implemented method that sets system and user parameters.
protected void	setState(Constants.EA_STATE myState) Sets the state.
protected void	setType(java.lang.String myType) Sets the type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ensemble.LifeCycle

start, stop

Field Detail

myName

private java.lang.String myName

The my name.

myAgent

private MusicalAgent myAgent

The my agent.

myType

private java.lang.String myType

The my type.

myState

private Constants.EA_STATE myState

The my state.

parameters

protected Parameters parameters

The parameters.

Constructor Detail

MusicalAgentComponent

public MusicalAgentComponent()

Method Detail

getComponentName

public final java.lang.String getComponentName()

Gets the component name.

Returns:

the component name

getComponentType

public final java.lang.String getComponentType()

Gets the component type.

Returns:

the component type

setComponentName

protected final void setComponentName(java.lang.String myName)

Sets the component name.

Parameters:

myName - the new component name

getAgent

public final MusicalAgent getAgent()

Gets the agent.

Returns:

the agent

setAgent

protected final void setAgent(MusicalAgent myAgent)

Sets the agent.

Parameters:

myAgent - the new agent

getType

public final java.lang.String getType()

Gets the type.

Returns:

the type

setType

protected final void setType(java.lang.String myType)

Sets the type.

Parameters:

myType - the new type

getState

public final Constants.EA_STATE getState()

Gets the state.

Returns:

the state

setState

protected final void setState(Constants.EA_STATE myState)

Sets the state.

Parameters:

myState - the new state

addParameter

public final void addParameter(java.lang.String key,
                java.lang.String value)

Adds the parameter.

Parameters:

key - the key

value - the value

addParameters

public final void addParameters(Parameters newParameters)

Adds the parameters.

Parameters:

newParameters - the new parameters

getParameter

public final java.lang.String getParameter(java.lang.String key)

Gets the parameter.

Parameters:

key - the key

Returns:

the parameter

getParameter

public final java.lang.String getParameter(java.lang.String key,
                            java.lang.String defaultValue)

Gets the parameter.

Parameters:

key - the key

defaultValue - the default value

Returns:

the parameter

setParameters

public final void setParameters(Parameters parameters)

Description copied from interface: LifeCycle

Framework-implemented method that sets system and user parameters.

Specified by:

setParameters in interface LifeCycle

Parameters:

parameters - a Parameters object with all user and system Parameters for this object

getParameters

public final Parameters getParameters()

Description copied from interface: LifeCycle

Returns all configured parameters.

Specified by:

getParameters in interface LifeCycle

Returns:

a Parameters object with system and user parameters

getAddress

public final java.lang.String getAddress()

Description copied from interface: RouterClient

Returns this component framework address.

Specified by:

getAddress in interface RouterClient

Returns:

the component address

receiveCommand

public final void receiveCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that receives a command sent by the RouterAgent and calls processCommand.

Specified by:

receiveCommand in interface RouterClient

Parameters:

cmd - the cmd

sendCommand

public final void sendCommand(Command cmd)

Description copied from interface: RouterClient

A framework-implemented method that sends a command to its destination, via RouterAgent if the recipient is another agent.

Specified by:

sendCommand in interface RouterClient

Parameters:

cmd - the cmd

configure

public boolean configure()

Description copied from interface: LifeCycle

User-implemented method that configures the component, setting up user parameters and essential properties.

Specified by:

configure in interface LifeCycle

Returns:

true, if successful

init

public boolean init()

Description copied from interface: LifeCycle

User-implemented initialization method, called by start().

Specified by:

init in interface LifeCycle

Returns:

true, if successful

finit

public boolean finit()

Description copied from interface: LifeCycle

User-implemented finalization method, called by stop().

Specified by:

finit in interface LifeCycle

Returns:

true, if successful

processCommand

public void processCommand(Command cmd)

Description copied from interface: RouterClient

An user-implemented method to process a received command.

Specified by:

processCommand in interface RouterClient

Parameters:

cmd - the cmd

parameterUpdate

public boolean parameterUpdate(java.lang.String name,
                      java.lang.String newValue)

Description copied from interface: LifeCycle

User-implement method called when a parameter has been updated.

Specified by:

parameterUpdate in interface LifeCycle

Parameters:

name - the name

newValue - the new value

Returns:

true, if successful