org.hawkular.btm.client.collector.internal

Class FragmentBuilder

java.lang.Object

org.hawkular.btm.client.collector.internal.FragmentBuilder

public class FragmentBuilder
extends Object

This class represents the builder for a business transaction fragment. NOTE: This class is not thread safe as the sequence of events within a thread of execution should be in sequence, and therefore should not result in any concurrent conflicts.

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
FragmentBuilder()

Method Summary

Modifier and Type	Method and Description
BusinessTransaction	getBusinessTransaction()
Node	getCurrentNode() This method returns the current node providing the scope for further levels of detail.
byte[]	getInData(int hashCode) This method returns the data associated with the in buffer and resets the buffer to be inactive.
Node	getLatestNode(String nodeType, boolean onStack) This method returns the latest node of the specified type, either on the stack, or on the 'popped' nodes.
ReportingLevel	getLevel()
protected Stack<Node>	getNodeStack()
byte[]	getOutData(int hashCode) This method returns the data associated with the out buffer and resets the buffer to be inactive.
protected Stack<Node>	getPoppedNodes()
List<String>	getUncompletedCorrelationIds() This method returns the un-completed correlation ids list.
void	initInBuffer(int hashCode) This method initialises the in data buffer.
void	initOutBuffer(int hashCode) This method initialises the out data buffer.
boolean	isComplete() This method determines if the fragment is complete.
boolean	isInBufferActive(int hashCode) This method determines if the in data buffer is active.
boolean	isOutBufferActive(int hashCode) This method determines if the out data buffer is active.
boolean	isSuppressed() This method returns whether the fragment is in suppression mode.
protected boolean	nodeMatches(Node node, Class<? extends Node> cls, String uri) This method determines whether the supplied node matches the specified class and optional URI.
Node	popNode(Class<? extends Node> cls, String uri) This method pops the latest node from the business transaction fragment hierarchy.
protected Node	popNode(Stack<Node> stack, Class<? extends Node> cls, String uri) This method pops a node of the defined class and optional uri from the stack.
void	pushNode(Node node) This method pushes a new node into the business transaction fragment hierarchy.
Node	releaseNode(String id) This method indicates that the identified node, for this thread of execution, should be released.
void	retainNode(String id) This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes.
Node	retrieveNode(String id) This method returns the node associated, for this thread of execution, identified by the supplied id.
void	setLevel(ReportingLevel level)
void	suppress() This method initiates suppression of any child node.
String	toString()
void	writeInData(int hashCode, byte[] b, int offset, int len) This method writes data to the in buffer.
void	writeOutData(int hashCode, byte[] b, int offset, int len) This method writes data to the out buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

FragmentBuilder

public FragmentBuilder()

Method Detail

isComplete

public boolean isComplete()

This method determines if the fragment is complete.

Returns:

Whether the fragment is complete

getBusinessTransaction

public BusinessTransaction getBusinessTransaction()

Returns:

the businessTransaction

getLevel

public ReportingLevel getLevel()

Returns:

the level

setLevel

public void setLevel(ReportingLevel level)

Parameters:

level - the level to set

getCurrentNode

public Node getCurrentNode()

This method returns the current node providing the scope for further levels of detail.

Returns:

The current node

getNodeStack

protected Stack<Node> getNodeStack()

Returns:

the nodeStack

getPoppedNodes

protected Stack<Node> getPoppedNodes()

Returns:

the poppedNodes

getLatestNode

public Node getLatestNode(String nodeType,
                          boolean onStack)

This method returns the latest node of the specified type, either on the stack, or on the 'popped' nodes.

Parameters:

nodeType - The node type

onStack - Whether from the stack

Returns:

The node, or null if not found

pushNode

public void pushNode(Node node)

This method pushes a new node into the business transaction fragment hierarchy.

Parameters:

node - The new node

popNode

public Node popNode(Class<? extends Node> cls,
                    String uri)

This method pops the latest node from the business transaction fragment hierarchy.

Parameters:

cls - The type of node to pop

uri - The optional uri to match

Returns:

The node

popNode

protected Node popNode(Stack<Node> stack,
                       Class<? extends Node> cls,
                       String uri)

This method pops a node of the defined class and optional uri from the stack. If the uri is not defined, then the latest node of the approach class will be chosen.

Parameters:

stack - The stack

cls - The node type

uri - The optional uri to match

Returns:

The node, or null if no suitable candidate is found

nodeMatches

protected boolean nodeMatches(Node node,
                              Class<? extends Node> cls,
                              String uri)

This method determines whether the supplied node matches the specified class and optional URI.

Parameters:

node - The node

cls - The class

uri - The optional URI

Returns:

Whether the node is of the correct type and matches the optional URI

retainNode

public void retainNode(String id)

This method indicates that the current node, for this thread of execution, should be retained temporarily pending further changes.

Parameters:

id - The identifier used to later on to identify the node

releaseNode

public Node releaseNode(String id)

This method indicates that the identified node, for this thread of execution, should be released.

Parameters:

id - The identifier used to identify the node

Returns:

The node, or null if not found

retrieveNode

public Node retrieveNode(String id)

This method returns the node associated, for this thread of execution, identified by the supplied id.

Parameters:

id - The identifier used to identify the node

Returns:

The node, or null if not found

getUncompletedCorrelationIds

public List<String> getUncompletedCorrelationIds()

This method returns the un-completed correlation ids list.

Returns:

The uncompleted correlation ids

suppress

public void suppress()

This method initiates suppression of any child node.

isSuppressed

public boolean isSuppressed()

This method returns whether the fragment is in suppression mode.

Returns:

Whether fragment is being suppressed

initInBuffer

public void initInBuffer(int hashCode)

This method initialises the in data buffer.

Parameters:

hashCode - The hash code

isInBufferActive

public boolean isInBufferActive(int hashCode)

This method determines if the in data buffer is active.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

Returns:

Whether the data buffer is active

writeInData

public void writeInData(int hashCode,
                        byte[] b,
                        int offset,
                        int len)

This method writes data to the in buffer.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

b - The bytes

offset - The offset

len - The length

getInData

public byte[] getInData(int hashCode)

This method returns the data associated with the in buffer and resets the buffer to be inactive.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

Returns:

The data

initOutBuffer

public void initOutBuffer(int hashCode)

This method initialises the out data buffer.

Parameters:

hashCode - The hash code

isOutBufferActive

public boolean isOutBufferActive(int hashCode)

This method determines if the out data buffer is active.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

Returns:

Whether the data buffer is active

writeOutData

public void writeOutData(int hashCode,
                         byte[] b,
                         int offset,
                         int len)

This method writes data to the out buffer.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

b - The bytes

offset - The offset

len - The length

getOutData

public byte[] getOutData(int hashCode)

This method returns the data associated with the out buffer and resets the buffer to be inactive.

Parameters:

hashCode - The hash code, or -1 to ignore the hash code

Returns:

The data

toString

public String toString()

Overrides:

toString in class Object