org.sonar.api.measures
Class Measure

java.lang.Object
  extended by org.sonar.api.measures.Measure
Direct Known Subclasses:
RuleMeasure

public class Measure
extends Object

Since:
1.10

Field Summary
protected  Metric.Level alertStatus
           
protected  String alertText
           
protected  String data
           
protected  Date date
           
static int DEFAULT_PRECISION
          Default precision when saving a float type metric
protected  String description
           
protected  Double diff1
           
protected  Double diff2
           
protected  Double diff3
           
protected static int MAX_TEXT_SIZE
           
protected  Metric metric
           
protected  PersistenceMode persistenceMode
           
protected  Integer tendency
           
protected  String url
           
protected  Double value
           
 
Constructor Summary
Measure()
           
Measure(Metric metric)
           
Measure(Metric metric, Double value)
           
Measure(Metric metric, Double value, int precision)
           
Measure(Metric metric, Double value, String data)
           
Measure(Metric metric, Metric.Level level)
           
Measure(Metric metric, String data)
          Measure with text data.
 
Method Summary
 boolean equals(Object obj)
           
 Metric.Level getAlertStatus()
           
 String getAlertText()
           
 String getData()
           
 Metric.Level getDataAsLevel()
           
 Date getDate()
          Used only in TimeMachine queries
 String getDescription()
           
 Double getDiffValue1()
           
 Double getDiffValue2()
           
 Double getDiffValue3()
           
 Integer getId()
           
 Integer getIntValue()
           
 Metric getMetric()
           
 PersistenceMode getPersistenceMode()
          Default persistence mode is FULL, except when instantiating the measure with a String parameter.
 Integer getTendency()
           
 String getUrl()
           
 Double getValue()
           
 int hashCode()
           
 Measure setAlertStatus(Metric.Level status)
           
 Measure setAlertText(String alertText)
           
 Measure setData(Metric.Level level)
           
 Measure setData(String s)
           
 Measure setDate(Date date)
          Used only in TimeMachine queries
 Measure setDescription(String description)
           
 Measure setDiffValue1(Double diff1)
           
 Measure setDiffValue2(Double diff2)
           
 Measure setDiffValue3(Double diff3)
           
 Measure setId(Integer id)
           
 Measure setIntValue(Integer i)
           
 Measure setMetric(Metric metric)
           
 Measure setPersistenceMode(PersistenceMode mode)
           
 Measure setTendency(Integer tendency)
           
 Measure setUrl(String url)
           
 Measure setValue(Double v)
          Setting the measure value with the default precision of 1
 Measure setValue(Double v, int precision)
          Setting the measure value with a given precision
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_TEXT_SIZE

protected static final int MAX_TEXT_SIZE
See Also:
Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION
Default precision when saving a float type metric

See Also:
Constant Field Values

metric

protected Metric metric

value

protected Double value

data

protected String data

description

protected String description

alertStatus

protected Metric.Level alertStatus

alertText

protected String alertText

tendency

protected Integer tendency

date

protected Date date

diff1

protected Double diff1

diff2

protected Double diff2

diff3

protected Double diff3

url

protected String url

persistenceMode

protected PersistenceMode persistenceMode
Constructor Detail

Measure

public Measure(Metric metric)

Measure

public Measure(Metric metric,
               Double value)

Measure

public Measure(Metric metric,
               Double value,
               int precision)

Measure

public Measure(Metric metric,
               Double value,
               String data)

Measure

public Measure(Metric metric,
               String data)
Measure with text data.


Measure

public Measure(Metric metric,
               Metric.Level level)

Measure

public Measure()
Method Detail

getPersistenceMode

public PersistenceMode getPersistenceMode()
Default persistence mode is FULL, except when instantiating the measure with a String parameter.


setPersistenceMode

public Measure setPersistenceMode(PersistenceMode mode)

getMetric

public Metric getMetric()

setMetric

public Measure setMetric(Metric metric)

getDataAsLevel

public Metric.Level getDataAsLevel()

getDate

public Date getDate()
Used only in TimeMachine queries


setDate

public Measure setDate(Date date)
Used only in TimeMachine queries


getValue

public Double getValue()

getIntValue

public Integer getIntValue()

setValue

public Measure setValue(Double v)
Setting the measure value with the default precision of 1

Parameters:
v - the measure value
Returns:
the measure object instance

setIntValue

public Measure setIntValue(Integer i)

setValue

public Measure setValue(Double v,
                        int precision)
Setting the measure value with a given precision

Parameters:
v - the measure value
precision - the measure value precision
Returns:
the measure object instance

getData

public String getData()

setData

public Measure setData(String s)

setData

public Measure setData(Metric.Level level)

getDescription

public String getDescription()

setDescription

public Measure setDescription(String description)

getAlertStatus

public Metric.Level getAlertStatus()

setAlertStatus

public Measure setAlertStatus(Metric.Level status)

getAlertText

public String getAlertText()

setAlertText

public Measure setAlertText(String alertText)

getTendency

public Integer getTendency()

setTendency

public Measure setTendency(Integer tendency)

getId

public Integer getId()

setId

public Measure setId(Integer id)

getDiffValue1

public Double getDiffValue1()

setDiffValue1

public Measure setDiffValue1(Double diff1)

getDiffValue2

public Double getDiffValue2()

setDiffValue2

public Measure setDiffValue2(Double diff2)

getDiffValue3

public Double getDiffValue3()

setDiffValue3

public Measure setDiffValue3(Double diff3)

getUrl

public String getUrl()

setUrl

public Measure setUrl(String url)

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009 SonarSource SA. All Rights Reserved.