Node (Hawkular APM::API 0.10.0.Final API)

java.lang.Object
- org.hawkular.apm.api.model.trace.Node

Direct Known Subclasses:

ContainerNode
```
public abstract class Node
extends Object
```
This abstract class is the base for all nodes describing a trace instance flow.

Author:

gbrown

Constructor Summary

Constructors
Constructor and Description

Node(NodeType type)

Node(NodeType type, String uri)

Constructors
Constructor and Description
`Node(NodeType type)`
`Node(NodeType type, String uri)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInteractionId(String id)` This method adds an interaction correlation id.
`protected long`	`completedDuration()` This method calculates the duration when all work initiated by this node has been completed.
`protected long`	`completedTime()` This method calculates the time (in nanoseconds) when all work initiated by this node has been completed.
`boolean`	`containerNode()` This method indicates whether this is a container based node.
`protected long`	`endTime()` This method calculates the end time of this node based on the base time and duration.
`boolean`	`equals(Object obj)`
`protected void`	`findCorrelatedNodes(CorrelationIdentifier cid, Set<Node> nodes)` This method identifies all of the nodes within a trace that are associated with the supplied correlation identifier.
`long`	`getBaseTime()`
`List<CorrelationIdentifier>`	`getCorrelationIds()`
`List<CorrelationIdentifier>`	`getCorrelationIds(CorrelationIdentifier.Scope scope)` This methd returns the subset of correlation ids that have the specified scope.
`Map<String,String>`	`getDetails()` This method returns the specific details about the node.
`long`	`getDuration()`
`String`	`getFault()`
`String`	`getFaultDescription()`
`List<Issue>`	`getIssues()`
`String`	`getOperation()`
`Set<Property>`	`getProperties()`
`Set<Property>`	`getProperties(String name)` This method returns the set of properties having the supplied property name.
`NodeType`	`getType()`
`String`	`getUri()`
`int`	`hashCode()`
`boolean`	`hasProperty(String name)` This method determines whether there is atleast one property with the supplied name.
`protected void`	`includeProperties(Set<Property> allProperties)` This method adds the properties for this node to the supplied set.
`boolean`	`interactionNode()` This method indicates whether this is an interaction based node.
`protected boolean`	`isCorrelated(CorrelationIdentifier cid)` This method determines whether the node is correlated to the supplied identifier.
`protected long`	`overallEndTime()` This method determines the overall end time of this node.
`Node`	`setBaseTime(long baseTime)`
`Node`	`setCorrelationIds(List<CorrelationIdentifier> correlationIds)`
`Node`	`setDetails(Map<String,String> details)`
`Node`	`setDuration(long duration)`
`Node`	`setFault(String fault)`
`Node`	`setFaultDescription(String faultDescription)`
`void`	`setIssues(List<Issue> issues)`
`void`	`setOperation(String operation)`
`Node`	`setProperties(Set<Property> properties)`
`Node`	`setType(NodeType type)`
`Node`	`setUri(String uri)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Node
```
public Node(NodeType type)
```
  - Node
```
public Node(NodeType type,
            String uri)
```
- Method Detail
  - containerNode
```
public boolean containerNode()
```
    This method indicates whether this is a container based node.
    
    Returns:
    
    Whether the node is a container
  - interactionNode
```
public boolean interactionNode()
```
    This method indicates whether this is an interaction based node.
    
    Returns:
    
    Whether the node is interaction based
  - getType
```
public NodeType getType()
```
    Returns:
    
    the type
  - setType
```
public Node setType(NodeType type)
```
    Parameters:
    
    type - the type to set
    
    Returns:
    
    The node
  - getUri
```
public String getUri()
```
    Returns:
    
    the uri
  - setUri
```
public Node setUri(String uri)
```
    Parameters:
    
    uri - the uri to set
    
    Returns:
    
    The node
  - getOperation
```
public String getOperation()
```
    Returns:
    
    the operation
  - setOperation
```
public void setOperation(String operation)
```
    Parameters:
    
    operation - the operation to set
  - getBaseTime
```
public long getBaseTime()
```
    Returns:
    
    the baseTime (in nanoseconds)
  - setBaseTime
```
public Node setBaseTime(long baseTime)
```
    Parameters:
    
    baseTime - the baseTime (in nanoseconds) to set
    
    Returns:
    
    The node
  - getDuration
```
public long getDuration()
```
    Returns:
    
    the duration
  - setDuration
```
public Node setDuration(long duration)
```
    Parameters:
    
    duration - the duration to set
    
    Returns:
    
    The node
  - getFault
```
public String getFault()
```
    Returns:
    
    the fault
  - setFault
```
public Node setFault(String fault)
```
    Parameters:
    
    fault - the fault to set
    
    Returns:
    
    The node
  - getFaultDescription
```
public String getFaultDescription()
```
    Returns:
    
    the faultDescription
  - setFaultDescription
```
public Node setFaultDescription(String faultDescription)
```
    Parameters:
    
    faultDescription - the faultDescription to set
    
    Returns:
    
    The node
  - getProperties
```
public Set<Property> getProperties()
```
    Returns:
    
    the properties
  - setProperties
```
public Node setProperties(Set<Property> properties)
```
    Parameters:
    
    properties - the properties to set
    
    Returns:
    
    The node
  - getDetails
```
public Map<String,String> getDetails()
```
    This method returns the specific details about the node.
    
    Returns:
    
    the details
  - setDetails
```
public Node setDetails(Map<String,String> details)
```
    Parameters:
    
    details - the details to set
    
    Returns:
    
    The node
  - hasProperty
```
public boolean hasProperty(String name)
```
    This method determines whether there is atleast one property with the supplied name.
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    Whether a property of the supplied name is defined
  - getProperties
```
public Set<Property> getProperties(String name)
```
    This method returns the set of properties having the supplied property name.
    
    Parameters:
    
    name - The property name
    
    Returns:
    
    The set of properties with the supplied name
  - includeProperties
```
protected void includeProperties(Set<Property> allProperties)
```
    This method adds the properties for this node to the supplied set.
    
    Parameters:
    
    allProperties - The aggregated set of properties
  - getCorrelationIds
```
public List<CorrelationIdentifier> getCorrelationIds()
```
    Returns:
    
    the correlationIds
  - setCorrelationIds
```
public Node setCorrelationIds(List<CorrelationIdentifier> correlationIds)
```
    Parameters:
    
    correlationIds - the correlationIds to set
    
    Returns:
    
    The node
  - addInteractionId
```
public void addInteractionId(String id)
```
    This method adds an interaction correlation id.
    
    Parameters:
    
    id - The id
  - getCorrelationIds
```
public List<CorrelationIdentifier> getCorrelationIds(CorrelationIdentifier.Scope scope)
```
    This methd returns the subset of correlation ids that have the specified scope.
    
    Parameters:
    
    scope - The scope
    
    Returns:
    
    The subset of correlation ids that are associated with the scope
  - getIssues
```
public List<Issue> getIssues()
```
    Returns:
    
    the issues
  - setIssues
```
public void setIssues(List<Issue> issues)
```
    Parameters:
    
    issues - the issues to set
  - endTime
```
protected long endTime()
```
    This method calculates the end time of this node based on the base time and duration. An end time will only be returned if the base time has been set.
    
    Returns:
    
    The end time (in nanoseconds), based on base time and duration, or 0 if not known
  - completedTime
```
protected long completedTime()
```
    This method calculates the time (in nanoseconds) when all work initiated by this node has been completed. Where async execution is performed, this could mean the work continues beyond the scope of the node that initiates the work.
    
    Returns:
    
    The completed time (in nanoseconds)
  - completedDuration
```
protected long completedDuration()
```
    This method calculates the duration when all work initiated by this node has been completed. Where async execution is performed, this could mean the work continues beyond the scope of the node that initiates the work. This will only be calculated where a base time (in nanoseconds) has been set.
    
    Returns:
    
    The completed duration (ns)
  - overallEndTime
```
protected long overallEndTime()
```
    This method determines the overall end time of this node.
    
    Returns:
    
    The overall end time
  - findCorrelatedNodes
```
protected void findCorrelatedNodes(CorrelationIdentifier cid,
                                   Set<Node> nodes)
```
    This method identifies all of the nodes within a trace that are associated with the supplied correlation identifier.
    
    Parameters:
    
    cid - The correlation identifier
    
    nodes - The set of nodes that are associated with the correlation identifier
  - isCorrelated
```
protected boolean isCorrelated(CorrelationIdentifier cid)
```
    This method determines whether the node is correlated to the supplied identifier.
    
    Parameters:
    
    cid - The correlation id
    
    Returns:
    
    Whether the node is correlated to the supplied id
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Node

Method Detail

containerNode

interactionNode

getType

setType

getUri

setUri

getOperation

setOperation

getBaseTime

setBaseTime

getDuration

setDuration

getFault

setFault

getFaultDescription

setFaultDescription

getProperties

setProperties

getDetails

setDetails

hasProperty

getProperties

includeProperties

getCorrelationIds

setCorrelationIds

addInteractionId

getCorrelationIds

getIssues

setIssues

endTime

completedTime

completedDuration

overallEndTime

findCorrelatedNodes

isCorrelated

hashCode

equals