org.kahina.core.data.agent

Class KahinaControlAgent

java.lang.Object

org.kahina.core.data.KahinaObject

org.kahina.core.data.agent.KahinaControlAgent

All Implemented Interfaces:

java.io.Serializable, KahinaListener

Direct Known Subclasses:

LogicProgrammingControlAgent, LogicProgrammingControlAgent

public class KahinaControlAgent
extends KahinaObject
implements KahinaListener

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	active
protected KahinaControlActuator	actuator
protected LogicProgrammingInstance<?,?,?,?>	kahina
protected java.lang.String	name
protected KahinaStepPropertySensor	sensor
protected java.awt.Color	signalColor

Fields inherited from class org.kahina.core.data.KahinaObject

needsUpdate

Constructor Summary

Constructors

Constructor and Description
KahinaControlAgent(LogicProgrammingInstance<?,?,?,?> kahina) Class constructor for control points.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates this control point, causing the messaging system to announce its matches.
KahinaControlAgent	copy()
void	deactivate() Deactivates this control point, preventing the messaging system from announcing its matches.
void	deregister()
java.lang.String	exportXML(boolean asFile) Generates an XML representation of this control point, optionally featuring an XML header.
org.w3c.dom.Element	exportXML(org.w3c.dom.Document dom)
KahinaControlActuator	getActuator()
KahinaInstance<?,?,?,?>	getKahina()
java.lang.String	getName() Gets the name of the control point as used by various GUI components.
KahinaStepPropertySensor	getSensor()
java.awt.Color	getSignalColor() Gets the signal color used for highlighting matches of this control point.
KahinaTree	getStepTree()
static KahinaControlAgent	importXML(org.w3c.dom.Element controlAgentNode, LogicProgrammingInstance<?,?,?,?> instance) Constructs a control point from an XML representation as produced by exportXML.
boolean	isActive() Checks whether this control point is active.
void	processEvent(KahinaEvent event)
void	register()
void	setActuator(KahinaControlActuator actuator)
void	setName(java.lang.String name) Sets the name of the control point that will be used by various GUI components.
void	setSensor(KahinaStepPropertySensor sensor)
void	setSignalColor(java.awt.Color signalColor) Sets the signal color used for highlighting matches of this control point.
java.lang.String	toString() Returns the breakpoint's name, prefixed by '#' if it is inactive.

Methods inherited from class org.kahina.core.data.KahinaObject

needsUpdate, requireUpdate

Methods inherited from class java.lang.Object

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

Field Detail

kahina

protected LogicProgrammingInstance<?,?,?,?> kahina

name

protected java.lang.String name

active

protected boolean active

signalColor

protected java.awt.Color signalColor

sensor

protected KahinaStepPropertySensor sensor

actuator

protected KahinaControlActuator actuator

Constructor Detail

KahinaControlAgent

public KahinaControlAgent(LogicProgrammingInstance<?,?,?,?> kahina)

Class constructor for control points. An actuator must be set before the control point can be used.

The breakpoint starts out with the following default values:
name - "Breakpoint " + a number
signalColor - a random RGB color
active - true (= activated)
pattern - the empty pattern

Parameters:

a - backpointer to the relevant KahinaController

Method Detail

register

public void register()

deregister

public void deregister()

copy

public KahinaControlAgent copy()

getKahina

public KahinaInstance<?,?,?,?> getKahina()

getActuator

public KahinaControlActuator getActuator()

setActuator

public void setActuator(KahinaControlActuator actuator)

getSensor

public KahinaStepPropertySensor getSensor()

setSensor

public void setSensor(KahinaStepPropertySensor sensor)

getName

public java.lang.String getName()

Gets the name of the control point as used by various GUI components.

Returns:

the name of the control point

setName

public void setName(java.lang.String name)

Sets the name of the control point that will be used by various GUI components.

Parameters:

name - a user-readable name for this control point

isActive

public boolean isActive()

Checks whether this control point is active. Used by tree automata to decide whether to inform Kahina about matches.

Returns:

true if this control point is active, false if it is inactive

activate

public void activate()

Activates this control point, causing the messaging system to announce its matches.

deactivate

public void deactivate()

Deactivates this control point, preventing the messaging system from announcing its matches.

getSignalColor

public java.awt.Color getSignalColor()

Gets the signal color used for highlighting matches of this control point.

Returns:

the signal color associated with this control point

setSignalColor

public void setSignalColor(java.awt.Color signalColor)

Sets the signal color used for highlighting matches of this control point.

Parameters:

signalColor - the signal color to be associated with this control point

getStepTree

public KahinaTree getStepTree()

toString

public java.lang.String toString()

Returns the breakpoint's name, prefixed by '#' if it is inactive.

Overrides:

toString in class java.lang.Object

exportXML

public java.lang.String exportXML(boolean asFile)

Generates an XML representation of this control point, optionally featuring an XML header.

Parameters:

asFile - determines whether the result features an XML header

Returns:

the XML representation of this control point as a string

exportXML

public org.w3c.dom.Element exportXML(org.w3c.dom.Document dom)

importXML

public static KahinaControlAgent importXML(org.w3c.dom.Element controlAgentNode,
                           LogicProgrammingInstance<?,?,?,?> instance)

Constructs a control point from an XML representation as produced by exportXML.

Parameters:

controlAgentNode - an XML DOM element with name "controlPoint" as produced when parsing the result of exportXML

Returns:

a new control point object corresponding to the XML representation contained in the DOM element

processEvent

public void processEvent(KahinaEvent event)

Specified by:

processEvent in interface KahinaListener