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

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

```
public class Trace
extends Object
```
This class represents the top level trace instance description. This model can be used to represent either a fragment of a trace instance, captured from one of multiple resources executing the transaction, or a complete end to end correlated description of the flow.

Author:

gbrown

Constructor Summary

Constructors
Constructor and Description

Trace()

Constructors
Constructor and Description
`Trace()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<Property>`	`allProperties()` This method returns all properties contained in the node hierarchy that can be used to search for the trace.
`long`	`calculateDuration()` This method returns the duration of the trace fragment.
`long`	`endTime()` This method returns the end time of the trace fragment.
`boolean`	`equals(Object obj)`
`String`	`getBusinessTransaction()`
`Set<Node>`	`getCorrelatedNodes(CorrelationIdentifier cid)` This method locates any node within the trace that is associated with the supplied correlation id.
`String`	`getHostAddress()`
`String`	`getHostName()`
`String`	`getId()`
`List<Node>`	`getNodes()`
`String`	`getPrincipal()`
`Set<Property>`	`getProperties(String name)` This method returns the set of properties having the supplied property name.
`long`	`getStartTime()`
`int`	`hashCode()`
`boolean`	`hasProperty(String name)` This method determines whether there is atleast one property with the supplied name.
`boolean`	`initialFragment()` This method determines whether this trace is the initial fragment of an instance.
`Trace`	`setBusinessTransaction(String name)`
`Trace`	`setHostAddress(String hostAddress)`
`Trace`	`setHostName(String hostName)`
`Trace`	`setId(String id)`
`Trace`	`setNodes(List<Node> nodes)`
`Trace`	`setPrincipal(String principal)`
`Trace`	`setStartTime(long startTime)`
`String`	`toString()`

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

- Constructor Detail
  - Trace
```
public Trace()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns:
    
    the id
  - setId
```
public Trace setId(String id)
```
    Parameters:
    
    id - the id to set
    
    Returns:
    
    The trace
  - getStartTime
```
public long getStartTime()
```
    Returns:
    
    the startTime
  - setStartTime
```
public Trace setStartTime(long startTime)
```
    Parameters:
    
    startTime - the startTime to set
    
    Returns:
    
    The trace
  - getBusinessTransaction
```
public String getBusinessTransaction()
```
    Returns:
    
    the business transaction name
  - setBusinessTransaction
```
public Trace setBusinessTransaction(String name)
```
    Parameters:
    
    name - the business transaction name to set
    
    Returns:
    
    The trace
  - getPrincipal
```
public String getPrincipal()
```
    Returns:
    
    the principal
  - setPrincipal
```
public Trace setPrincipal(String principal)
```
    Parameters:
    
    principal - the principal to set
    
    Returns:
    
    The trace
  - getHostName
```
public String getHostName()
```
    Returns:
    
    the host name
  - setHostName
```
public Trace setHostName(String hostName)
```
    Parameters:
    
    hostName - the host name to set
    
    Returns:
    
    The trace
  - getHostAddress
```
public String getHostAddress()
```
    Returns:
    
    the host address
  - setHostAddress
```
public Trace setHostAddress(String hostAddress)
```
    Parameters:
    
    hostAddress - the host address to set
    
    Returns:
    
    The trace
  - getNodes
```
public List<Node> getNodes()
```
    Returns:
    
    the nodes
  - setNodes
```
public Trace setNodes(List<Node> nodes)
```
    Parameters:
    
    nodes - the nodes to set
    
    Returns:
    
    The trace
  - allProperties
```
public Set<Property> allProperties()
```
    This method returns all properties contained in the node hierarchy that can be used to search for the trace.
    
    Returns:
    
    Aggregated list of all the properties in the node hierarchy
  - 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
  - initialFragment
```
public boolean initialFragment()
```
    This method determines whether this trace is the initial fragment of an instance.
    
    Returns:
    
    Whether this is the initial fragment
  - endTime
```
public long endTime()
```
    This method returns the end time of the trace fragment.
    
    Returns:
    
    The end time (in milliseconds)
  - calculateDuration
```
public long calculateDuration()
```
    This method returns the duration of the trace fragment.
    
    Returns:
    
    The duration (in milliseconds), or 0 if no nodes defined
  - getCorrelatedNodes
```
public Set<Node> getCorrelatedNodes(CorrelationIdentifier cid)
```
    This method locates any node within the trace that is associated with the supplied correlation id.
    
    Parameters:
    
    cid - The correlation identifier
    
    Returns:
    
    The nodes that were correlated with the supplied correlation identifier
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Trace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trace

Method Detail

getId

setId

getStartTime

setStartTime

getBusinessTransaction

setBusinessTransaction

getPrincipal

setPrincipal

getHostName

setHostName

getHostAddress

setHostAddress

getNodes

setNodes

allProperties

hasProperty

getProperties

initialFragment

endTime

calculateDuration

getCorrelatedNodes

hashCode

equals

toString