AbstractGraphRow (JMeter Plugins Common Classes 0.2 API)

java.lang.Object
- kg.apc.charting.AbstractGraphRow

Direct Known Subclasses:

GraphRowAverages, GraphRowExactValues, GraphRowOverallAverages, GraphRowSimple, GraphRowSumValues
```
public abstract class AbstractGraphRow
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`color`
`protected boolean`	`drawLine`
`protected String`	`label`
`protected Rectangle`	`legendColorBox` When user clicks on this, color of the box and metric line will change.
`static float`	`LINE_THICKNESS_BIG`
`static int`	`MARKER_SIZE_BIG`
`static int`	`MARKER_SIZE_NONE`
`static int`	`MARKER_SIZE_SMALL`
`protected int`	`markerSize`
`protected long`	`maxX`
`protected long`	`minX`
`static int`	`ROW_AVERAGES`
`static int`	`ROW_EXACT_VALUES`
`static int`	`ROW_OVERALL_AVERAGES`
`static int`	`ROW_PERCENTILES`
`static int`	`ROW_ROLLING_SUM_VALUES`
`static int`	`ROW_SIMPLE`
`static int`	`ROW_SUM_VALUES`

Constructor Summary

Constructors
Constructor and Description

AbstractGraphRow()

Constructors
Constructor and Description
`AbstractGraphRow()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(long xVal, double yVal)`
`Color`	`getColor()`
`abstract AbstractGraphPanelChartElement`	`getElement(long value)` Needed for csv export.
`long`	`getFirstTime()`
`int`	`getGranulationValue()`
`Long`	`getHigherKey(long value)`
`String`	`getLabel()`
`Rectangle`	`getLegendColorBox()`
`AbstractGraphPanelChartElement`	`getLowerElement(long value)` Needed for aggregate average rows witch need to be summed.
`int`	`getMarkerSize()`
`long`	`getMaxX()`
`double[]`	`getMinMaxY(int maxPoints)`
`long`	`getMinX()`
`static AbstractGraphRow`	`instantiateNewRow(int rowType)`
`boolean`	`isDrawBar()`
`boolean`	`isDrawLine()`
`boolean`	`isDrawOnChart()`
`boolean`	`isDrawSpline()`
`boolean`	`isDrawThickLines()`
`boolean`	`isDrawValueLabel()`
`boolean`	`isShowInLegend()`
`abstract Iterator<Map.Entry<Long,AbstractGraphPanelChartElement>>`	`iterator()`
`void`	`setColor(Color nextColor)`
`void`	`setDrawBar(boolean b)`
`void`	`setDrawLine(boolean b)`
`void`	`setDrawOnChart(boolean drawOnChart)`
`void`	`setDrawSpline(boolean drawSpline)`
`void`	`setDrawThickLines(boolean isThickLine)`
`void`	`setDrawValueLabel(boolean drawValueLabel)`
`void`	`setExcludeOutOfRangeValues(boolean excludeOutOfRangeValues)` For bar chart x axis too big prevention.
`void`	`setGranulationValue(int value)` set the granulation value for drawbar width
`void`	`setLabel(String label)`
`void`	`setLegendColorBox(Rectangle val)`
`void`	`setMarkerSize(int aMarkerSize)`
`void`	`setShowInLegend(boolean showInLegend)`
`abstract int`	`size()`

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

Field Detail
- MARKER_SIZE_NONE
```
public static final int MARKER_SIZE_NONE
```
  See Also:
  
  Constant Field Values
- MARKER_SIZE_SMALL
```
public static final int MARKER_SIZE_SMALL
```
  See Also:
  
  Constant Field Values
- MARKER_SIZE_BIG
```
public static final int MARKER_SIZE_BIG
```
  See Also:
  
  Constant Field Values
- LINE_THICKNESS_BIG
```
public static final float LINE_THICKNESS_BIG
```
  See Also:
  
  Constant Field Values
- ROW_AVERAGES
```
public static final int ROW_AVERAGES
```
  See Also:
  
  Constant Field Values
- ROW_EXACT_VALUES
```
public static final int ROW_EXACT_VALUES
```
  See Also:
  
  Constant Field Values
- ROW_OVERALL_AVERAGES
```
public static final int ROW_OVERALL_AVERAGES
```
  See Also:
  
  Constant Field Values
- ROW_PERCENTILES
```
public static final int ROW_PERCENTILES
```
  See Also:
  
  Constant Field Values
- ROW_SUM_VALUES
```
public static final int ROW_SUM_VALUES
```
  See Also:
  
  Constant Field Values
- ROW_ROLLING_SUM_VALUES
```
public static final int ROW_ROLLING_SUM_VALUES
```
  See Also:
  
  Constant Field Values
- ROW_SIMPLE
```
public static final int ROW_SIMPLE
```
  See Also:
  
  Constant Field Values
- drawLine
```
protected boolean drawLine
```
- markerSize
```
protected int markerSize
```
- color
```
protected Color color
```
- legendColorBox
```
protected Rectangle legendColorBox
```
  When user clicks on this, color of the box and metric line will change.
- label
```
protected String label
```
- maxX
```
protected long maxX
```
- minX
```
protected long minX
```

Constructor Detail
- AbstractGraphRow
```
public AbstractGraphRow()
```

Method Detail

setDrawThickLines

public void setDrawThickLines(boolean isThickLine)

isDrawThickLines
```
public boolean isDrawThickLines()
```

setDrawLine
```
public void setDrawLine(boolean b)
```
Parameters:

b -

setMarkerSize

public void setMarkerSize(int aMarkerSize)

Parameters:: aMarkerSize -

isDrawLine
```
public boolean isDrawLine()
```
Returns:

the drawLine

getMarkerSize
```
public int getMarkerSize()
```
Returns:

the markerSize

getColor
```
public Color getColor()
```
Returns:

setColor

public void setColor(Color nextColor)

Parameters:: nextColor -

getLabel
```
public String getLabel()
```
Returns:

the label

setLabel
```
public void setLabel(String label)
```
Parameters:

label - the label to set

getMaxX
```
public long getMaxX()
```
Returns:

the maxX

getMinMaxY
```
public double[] getMinMaxY(int maxPoints)
```
Returns:

the exact maxY, taking in account maxPoint limit

getMinX
```
public long getMinX()
```
Returns:

the minX

add

public void add(long xVal,
                double yVal)

Parameters:: xVal -; yVal -

iterator

public abstract Iterator<Map.Entry<Long,AbstractGraphPanelChartElement>> iterator()

Returns:

isDrawValueLabel
```
public boolean isDrawValueLabel()
```
Returns:

the drawValueLabel

setDrawValueLabel
```
public void setDrawValueLabel(boolean drawValueLabel)
```
Parameters:

drawValueLabel - the drawValueLabel to set

isShowInLegend
```
public boolean isShowInLegend()
```
Returns:

the showInLegend

setShowInLegend
```
public void setShowInLegend(boolean showInLegend)
```
Parameters:

showInLegend - the showInLegend to set

isDrawOnChart
```
public boolean isDrawOnChart()
```
Returns:

the drawOnChart

setDrawOnChart
```
public void setDrawOnChart(boolean drawOnChart)
```
Parameters:

drawOnChart - the drawOnChart to set

setDrawBar
```
public void setDrawBar(boolean b)
```

isDrawBar
```
public boolean isDrawBar()
```
Returns:

the drawBar

isDrawSpline
```
public boolean isDrawSpline()
```

setDrawSpline

public void setDrawSpline(boolean drawSpline)

getGranulationValue
```
public int getGranulationValue()
```
Returns:

the granulation value for drawbar width

setGranulationValue
```
public void setGranulationValue(int value)
```
set the granulation value for drawbar width

setExcludeOutOfRangeValues
```
public void setExcludeOutOfRangeValues(boolean excludeOutOfRangeValues)
```
For bar chart x axis too big prevention. Must be overridden if necessary.

Parameters:

excludeOutOfRangeValues -

getElement
```
public abstract AbstractGraphPanelChartElement getElement(long value)
```
Needed for csv export.

Parameters:

value - the key to get the element

Returns:

the corresponding element

getLowerElement
```
public AbstractGraphPanelChartElement getLowerElement(long value)
```
Needed for aggregate average rows witch need to be summed. Must be overridden in child class if needed

Parameters:

value - the upper key to get the floor element

Returns:

the floor element, null if not exist

getHigherKey
```
public Long getHigherKey(long value)
```

size
```
public abstract int size()
```

instantiateNewRow

public static AbstractGraphRow instantiateNewRow(int rowType)

getFirstTime
```
public long getFirstTime()
```
Returns:

the firstTime

setLegendColorBox

public void setLegendColorBox(Rectangle val)

getLegendColorBox
```
public Rectangle getLegendColorBox()
```

Class AbstractGraphRow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARKER_SIZE_NONE

MARKER_SIZE_SMALL

MARKER_SIZE_BIG

LINE_THICKNESS_BIG

ROW_AVERAGES

ROW_EXACT_VALUES

ROW_OVERALL_AVERAGES

ROW_PERCENTILES

ROW_SUM_VALUES

ROW_ROLLING_SUM_VALUES

ROW_SIMPLE

drawLine

markerSize

color

legendColorBox

label

maxX

minX

Constructor Detail

AbstractGraphRow

Method Detail

setDrawThickLines

isDrawThickLines

setDrawLine

setMarkerSize

isDrawLine

getMarkerSize

getColor

setColor

getLabel

setLabel

getMaxX

getMinMaxY

getMinX

add

iterator

isDrawValueLabel

setDrawValueLabel

isShowInLegend

setShowInLegend

isDrawOnChart

setDrawOnChart

setDrawBar

isDrawBar

isDrawSpline

setDrawSpline

getGranulationValue

setGranulationValue

setExcludeOutOfRangeValues

getElement

getLowerElement

getHigherKey

size

instantiateNewRow

getFirstTime

setLegendColorBox

getLegendColorBox