MetricInstance (platform/sdk 5.6.1.0 API)

java.lang.Object
- com.attivio.platform.perfmon.model.MetricInstance

All Implemented Interfaces:

UseDefaultConverter, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<MetricInstance>
```
public class MetricInstance
extends java.lang.Object
implements java.io.Serializable, UseDefaultConverter, java.lang.Comparable<MetricInstance>, java.lang.Cloneable
```
A specific instance of a metric. For example a node-specific document count. MetricInstances contain an arbitrary set of name/value pairs or dimensions. These dimensions define a unique occurrence of a metric.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CONSTANT_VALUE_KEY

static java.lang.String HIDDEN_PREFIX
dimensions starting with this prefix are considered hidden

Constructor Summary

Constructors
Constructor Description

MetricInstance()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MetricInstance`	`clone()`
`int`	`compareTo(MetricInstance mi)`
`boolean`	`equals(java.lang.Object obj)`
`BaseTypesMap<java.lang.String,java.lang.String>`	`getDimensions()`
`long`	`getId()`
`Metric`	`getMetric()`
`java.util.List<java.lang.String>`	`getUserVisibleDimensions()`
`int`	`hashCode()`
`void`	`putDimension(java.lang.String name, java.lang.String value)`
`void`	`setDimensions(BaseTypesMap<java.lang.String,java.lang.String> dimensions)`
`void`	`setId(long id)`
`void`	`setMetric(Metric metric)`
`java.lang.String`	`toString()`

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

Field Detail
- HIDDEN_PREFIX
```
public static final java.lang.String HIDDEN_PREFIX
```
  dimensions starting with this prefix are considered hidden
  
  See Also:
  
  Constant Field Values
- CONSTANT_VALUE_KEY
```
public static final java.lang.String CONSTANT_VALUE_KEY
```
  See Also:
  
  Constant Field Values

Constructor Detail
- MetricInstance
```
public MetricInstance()
```

Method Detail

getMetric
```
public Metric getMetric()
```

setMetric

public void setMetric(Metric metric)

getUserVisibleDimensions
```
public java.util.List<java.lang.String> getUserVisibleDimensions()
```
Returns:

all non-hidden dimensions (anything starting with . is hidden)

getDimensions

public BaseTypesMap<java.lang.String,java.lang.String> getDimensions()

setDimensions

public void setDimensions(BaseTypesMap<java.lang.String,java.lang.String> dimensions)

putDimension

public void putDimension(java.lang.String name,
                         java.lang.String value)

getId
```
public long getId()
```

setId
```
public void setId(long id)
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

compareTo
```
public int compareTo(MetricInstance mi)
```
Specified by:

compareTo in interface java.lang.Comparable<MetricInstance>

clone
```
public MetricInstance clone()
```
Overrides:

clone in class java.lang.Object