org.kahina.core.data.agent

Class KahinaBreakpoint

java.lang.Object

org.kahina.core.data.KahinaObject

org.kahina.core.data.agent.KahinaBreakpoint

All Implemented Interfaces:

java.io.Serializable

public class KahinaBreakpoint
extends KahinaObject
implements java.io.Serializable

A breakpoint based on a tree pattern as used by the Kahina breakpoint system.

The main purpose of this class is to combine a TreePattern with meta information such as a type, a signal color, a name and an activation status. It constitutes the form in which breakpoints are most transparent and accessible to the user. The breakpoint editor as well as import and export formats build on breakpoints in this form.

Within the breakpoint system, a KahinaBreakpoint is compiled into a TreeAutomaton which is then used for pattern matching. The resulting TreeAutomaton will however still contain a reference to this object for meta data access.

Author:

jd

See Also:

Serialized Form

Field Summary

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

needsUpdate

Constructor Summary

Constructors

Constructor and Description
KahinaBreakpoint(int type) Class constructor specifying the breakpoint type as an integer constant.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates this breakpoint, causing the messaging system to announce its matches.
TreeAutomaton	compile() Compiles this breakpoint into a tree automaton which is then returned.
void	deactivate() Deactivates this breakpoint, preventing the messaging system from announcing its matches.
java.lang.String	exportXML(boolean asFile) Generates an XML representation of this breakpoint, optionally featuring an XML header.
org.w3c.dom.Element	exportXML(org.w3c.dom.Document dom)
java.lang.String	getName() Gets the name of the breakpoint as used by various GUI components.
TreePattern	getPattern() Gets the tree pattern associated with this breakpoint.
java.awt.Color	getSignalColor() Gets the signal color used for highlighting matches of this breakpoint.
int	getType() Gets the type of this breakpoint.
static KahinaBreakpoint	importXML(org.w3c.dom.Element breakpointNode) Constructs a breakpoint from an XML representation as produced by exportXML.
boolean	isActive() Checks whether this breakpoint is active.
void	setName(java.lang.String name) Sets the name of the breakpoint that will be used by various GUI components.
void	setPattern(TreePattern pattern) Associates this breakpoint with a new tree pattern.
void	setSignalColor(java.awt.Color signalColor) Sets the signal color used for highlighting matches of this breakpoint.
void	setType(int type) Changes the type of this breakpoint.
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

Constructor Detail

KahinaBreakpoint

public KahinaBreakpoint(int type)

Class constructor specifying the breakpoint type as an integer constant.

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:

type - one of the constant values in KahinaBreakpointType

Method Detail

compile

public TreeAutomaton compile()

Compiles this breakpoint into a tree automaton which is then returned.

Returns:

the compiled tree automaton, still referencing this breakpoint

getName

public java.lang.String getName()

Gets the name of the breakpoint as used by various GUI components.

Returns:

the name of the breakpoint

setName

public void setName(java.lang.String name)

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

Parameters:

name - a user-readable name for this breakpoint

isActive

public boolean isActive()

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

Returns:

true if this breakpoint is active, false if it is inactive

activate

public void activate()

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

deactivate

public void deactivate()

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

getSignalColor

public java.awt.Color getSignalColor()

Gets the signal color used for highlighting matches of this breakpoint.

Returns:

the signal color associated with this breakpoint

setSignalColor

public void setSignalColor(java.awt.Color signalColor)

Sets the signal color used for highlighting matches of this breakpoint.

Parameters:

signalColor - the signal color to be associated with this breakpoint

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

getPattern

public TreePattern getPattern()

Gets the tree pattern associated with this breakpoint.

Returns:

the tree pattern associated with this breakpoint

setPattern

public void setPattern(TreePattern pattern)

Associates this breakpoint with a new tree pattern.

Parameters:

pattern - the tree pattern to be associated with this breakpoint

getType

public int getType()

Gets the type of this breakpoint.

Returns:

an integer representing the breakpoint's type

setType

public void setType(int type)

Changes the type of this breakpoint.

Parameters:

type - one of the constant values in KahinaBreakpointType

exportXML

public java.lang.String exportXML(boolean asFile)

Generates an XML representation of this breakpoint, optionally featuring an XML header.

Parameters:

asFile - determines whether the result features an XML header

Returns:

the XML representation of this breakpoint as a string

exportXML

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

importXML

public static KahinaBreakpoint importXML(org.w3c.dom.Element breakpointNode)

Constructs a breakpoint from an XML representation as produced by exportXML.

Parameters:

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

Returns:

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