Package com.illumon.iris.db.plot

Class BaseFigureImpl

java.lang.Object

com.illumon.iris.db.plot.BaseFigureImpl

All Implemented Interfaces:

BaseFigure, PlotExceptionCause, Serializable

public class BaseFigureImpl
extends Object
implements BaseFigure, PlotExceptionCause

Container for Charts.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	BaseFigureImpl()	Creates a new Figure instance with a 1x1 grid.
	BaseFigureImpl(int numRows, int numCols)	Creates a new Figure instance with a numRows x numCols grid.
protected	BaseFigureImpl(BaseFigureImpl figure)	Creates a copy of a Figure.

Method Summary

Modifier and Type	Method	Description
ChartImpl	chart(int index)	Returns a chart from this Figure's grid.
ChartImpl	chart(int rowNum, int colNum)	Returns a chart from this Figure's grid.
void	consolidateTableMaps()
void	consolidateTables()
BaseFigureImpl	copy()	Creates a copy of this Figure.
BaseFigureImpl	figureRemoveSeries(String... names)	Removes all series with names from this Figure.
BaseFigureImpl	figureTitle(String title)	Sets the title of this Figure
BaseFigureImpl	figureTitleColor(Paint color)	Sets the color of this Figure's title
BaseFigureImpl	figureTitleColor(String color)	Sets the color of this Figure's title
BaseFigureImpl	figureTitleFont(Font font)	Sets the font of this Figure's title
BaseFigureImpl	figureTitleFont(String family, String style, int size)	Sets the font of this Figure's title
ChartArray	getCharts()	Gets this Figure's Charts.
List<FigureImplFunction>	getFigureFunctionList()
LambdaGovernor	getGovernor()
int	getHeight()	Gets the numRows of this Figure.
FigureTableSnapshotManager	getManager()
String	getName()
PlotInfo	getPlotInfo()
int	getSessionId()
Map<Table,Set<Function<Table,Table>>>	getTableFunctionMap()
Set<TableHandle>	getTableHandles()	Gets the table handles associated with this figure.
Map<TableMap,Set<Function<TableMap,TableMap>>>	getTableMapFunctionMap()
Theme	getTheme()	Gets the Theme of this Figure.
String	getTitle()	Gets the title of this Figure.
Paint	getTitleColor()	Gets the Paint of this Figure's title.
Font	getTitleFont()	Gets the Font of this Figure's title.
long	getUpdateInterval()	Gets the updateInterval, in milliseconds, for this Figure.
int	getWidth()	Gets the width of this Figure.
InitializationGate	initializationGate()
boolean	isDefaultTheme()
boolean	isResizable()	Whether this Figure's height and width are changeable.
ChartImpl	newChart()	Adds a new Chart to this figure.
ChartImpl	newChart(int index)	Adds a new Chart to this figure.
ChartImpl	newChart(int rowNum, int colNum)	Adds a new Chart to this figure.
void	onClose()	Tear down once figure is closed.
void	onInflate()
void	registerFigureFunction(FigureImplFunction function)
void	registerTableFunction(Table t, Function<Table,Table> function)
void	registerTableMapFunction(TableMapHandle tableMapHandle, Function<Table,Table> tableTransform)
BaseFigureImpl	removeChart(int index)	Removes a chart from the Figure's grid.
BaseFigureImpl	removeChart(int rowNum, int colNum)	Removes a chart from the Figure's grid.
BaseFigure	save(String saveLocation, boolean wait, long timeoutSeconds)	Saves the Figure as an image.
BaseFigure	save(String saveLocation, int width, int height, boolean wait, long timeoutSeconds)	Saves the Figure as an image.
void	setGovernor(LambdaGovernor newGovernor)
void	setManager(FigureTableSnapshotManager manager)
void	setName(String figureName)
void	setSessionId(int sessionId)
void	setTableSnapshotsAndRegisterListeners(FigureTableSnapshotManager manager)
BaseFigureImpl	theme(Theme theme)	Sets the Theme of this Figure
BaseFigureImpl	theme(String theme)	Sets the Theme of this Figure
BaseFigureImpl	updateInterval(long updateIntervalMillis)	Sets the update interval of this Figure.
void	validateInitialization()	Checks if the figure can be instantiated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.illumon.iris.db.plot.BaseFigure

save, save

Constructor Details

BaseFigureImpl

public BaseFigureImpl()

Creates a new Figure instance with a 1x1 grid. If newChart() with no arguments is called on this new Figure, the Figure will resize itself to hold the new Chart.

BaseFigureImpl

public BaseFigureImpl(int numRows, int numCols)

Creates a new Figure instance with a numRows x numCols grid.

Parameters:

numRows - number of rows

numCols - number of columns

BaseFigureImpl

protected BaseFigureImpl(BaseFigureImpl figure)

Creates a copy of a Figure.

Parameters:

figure - figure to copy.

Method Details

copy

public BaseFigureImpl copy()

Creates a copy of this Figure.

Returns:

copy of this Figure.

getTheme

public Theme getTheme()

Gets the Theme of this Figure.

Returns:

this Figure's theme

getWidth

public int getWidth()

Gets the width of this Figure. This is equal to the number of columns.

Returns:

this Figure's width

getHeight

public int getHeight()

Gets the numRows of this Figure. This is equal to the number of rows.

Returns:

this Figure's height

getTitle

public String getTitle()

Gets the title of this Figure.

Returns:

this Figure's title

getTitleFont

public Font getTitleFont()

Gets the Font of this Figure's title.

Returns:

this Figure's title's Font

getTitleColor

public Paint getTitleColor()

Gets the Paint of this Figure's title.

Returns:

this Figure's title's Paint

isResizable

public boolean isResizable()

Whether this Figure's height and width are changeable.

Returns:

true if this Figure's height and width are changeable, false otherwise

getCharts

public ChartArray getCharts()

Gets this Figure's Charts.

Returns:

this Figure's Charts

getUpdateInterval

public long getUpdateInterval()

Gets the updateInterval, in milliseconds, for this Figure.

Returns:

update interval of this Figure, in milliseconds

isDefaultTheme

public boolean isDefaultTheme()

getTableHandles

public Set<TableHandle> getTableHandles()

Gets the table handles associated with this figure.

Returns:

table handles associated with this figure.

getGovernor

public LambdaGovernor getGovernor()

setGovernor

@TestUseOnly public void setGovernor(LambdaGovernor newGovernor)

getManager

public FigureTableSnapshotManager getManager()

setManager

public void setManager(FigureTableSnapshotManager manager)

setTableSnapshotsAndRegisterListeners

public void setTableSnapshotsAndRegisterListeners(FigureTableSnapshotManager manager)

figureRemoveSeries

public BaseFigureImpl figureRemoveSeries(String... names)

Description copied from interface: BaseFigure

Removes all series with names from this Figure.

Specified by:

figureRemoveSeries in interface BaseFigure

Parameters:

names - series names

Returns:

this Figure

onInflate

public void onInflate()

onClose

public void onClose()

Tear down once figure is closed.

registerTableFunction

public void registerTableFunction(Table t, Function<Table,Table> function)

getTableFunctionMap

public Map<Table,Set<Function<Table,Table>>> getTableFunctionMap()

registerTableMapFunction

public void registerTableMapFunction(TableMapHandle tableMapHandle, Function<Table,Table> tableTransform)

getTableMapFunctionMap

public Map<TableMap,Set<Function<TableMap,TableMap>>> getTableMapFunctionMap()

registerFigureFunction

public void registerFigureFunction(FigureImplFunction function)

getFigureFunctionList

public List<FigureImplFunction> getFigureFunctionList()

theme

public BaseFigureImpl theme(Theme theme)

Description copied from interface: BaseFigure

Sets the Theme of this Figure

Specified by:

theme in interface BaseFigure

Parameters:

theme - theme

Returns:

this Figure

theme

public BaseFigureImpl theme(String theme)

Description copied from interface: BaseFigure

Sets the Theme of this Figure

Specified by:

theme in interface BaseFigure

Parameters:

theme - theme name

Returns:

this Figure

updateInterval

public BaseFigureImpl updateInterval(long updateIntervalMillis)

Description copied from interface: BaseFigure

Sets the update interval of this Figure. The plot will be redrawn at this update interval.

Specified by:

updateInterval in interface BaseFigure

Parameters:

updateIntervalMillis - update interval, in milliseconds

Returns:

this Figure

figureTitle

public BaseFigureImpl figureTitle(String title)

Description copied from interface: BaseFigure

Sets the title of this Figure

Specified by:

figureTitle in interface BaseFigure

Parameters:

title - title

Returns:

this Figure

figureTitleFont

public BaseFigureImpl figureTitleFont(Font font)

Description copied from interface: BaseFigure

Sets the font of this Figure's title

Specified by:

figureTitleFont in interface BaseFigure

Parameters:

font - font

Returns:

this Figure

figureTitleFont

public BaseFigureImpl figureTitleFont(String family, String style, int size)

Description copied from interface: BaseFigure

Sets the font of this Figure's title

Specified by:

figureTitleFont in interface BaseFigure

Parameters:

family - font family; if null, set to Arial

style - font style; if null, set to Font.FontStyle PLAIN

size - the point size of the Font

Returns:

this Figure

figureTitleColor

public BaseFigureImpl figureTitleColor(Paint color)

Description copied from interface: BaseFigure

Sets the color of this Figure's title

Specified by:

figureTitleColor in interface BaseFigure

Parameters:

color - color

Returns:

this Figure

figureTitleColor

public BaseFigureImpl figureTitleColor(String color)

Description copied from interface: BaseFigure

Sets the color of this Figure's title

Specified by:

figureTitleColor in interface BaseFigure

Parameters:

color - color

Returns:

this Figure

newChart

public ChartImpl newChart()

Description copied from interface: BaseFigure

Adds a new Chart to this figure.

Specified by:

newChart in interface BaseFigure

Returns:

the new Chart. The Chart is placed in the next available grid space, starting at the upper left hand corner of the grid, going left to right, top to bottom. If no available space is found in the grid:

• if this Figure was created with no specified grid size, then the Figure will resize itself to add the new Chart;
• if not, a RuntimeException will be thrown.

newChart

public ChartImpl newChart(int index)

Description copied from interface: BaseFigure

Adds a new Chart to this figure.

Specified by:

newChart in interface BaseFigure

Parameters:

index - index from the Figure's grid to remove. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3].

Returns:

the new Chart. The Chart is placed at the grid space indicated by the index.

newChart

public ChartImpl newChart(int rowNum, int colNum)

Description copied from interface: BaseFigure

Adds a new Chart to this figure.

Specified by:

newChart in interface BaseFigure

Parameters:

rowNum - row index in this Figure's grid. The row index starts at 0.

colNum - column index in this Figure's grid. The column index starts at 0.

Returns:

the new Chart. The Chart is placed at the grid space [rowNum, colNum.

removeChart

public BaseFigureImpl removeChart(int index)

Description copied from interface: BaseFigure

Removes a chart from the Figure's grid.

Specified by:

removeChart in interface BaseFigure

Parameters:

index - index from the Figure's grid to remove. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3].

Returns:

this Figure with the chart removed.

removeChart

public BaseFigureImpl removeChart(int rowNum, int colNum)

Description copied from interface: BaseFigure

Removes a chart from the Figure's grid.

Specified by:

removeChart in interface BaseFigure

Parameters:

rowNum - row index in this Figure's grid. The row index starts at 0.

colNum - column index in this Figure's grid. The column index starts at 0.

Returns:

this Figure with the chart removed.

chart

public ChartImpl chart(int index)

Description copied from interface: BaseFigure

Returns a chart from this Figure's grid.

Specified by:

chart in interface BaseFigure

Parameters:

index - index from the Figure's grid to remove. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3].

Returns:

selected Chart

chart

public ChartImpl chart(int rowNum, int colNum)

Description copied from interface: BaseFigure

Returns a chart from this Figure's grid.

Specified by:

chart in interface BaseFigure

Parameters:

rowNum - row index in this Figure's grid. The row index starts at 0.

colNum - column index in this Figure's grid. The column index starts at 0.

Returns:

selected Chart

save

public BaseFigure save(String saveLocation, boolean wait, long timeoutSeconds)

Description copied from interface: BaseFigure

Saves the Figure as an image.

Specified by:

save in interface BaseFigure

Parameters:

saveLocation - save location. Must not be null

wait - whether to hold the calling thread until the file is written

timeoutSeconds - timeout in seconds to wait.

Returns:

figure

save

public BaseFigure save(String saveLocation, int width, int height, boolean wait, long timeoutSeconds)

Description copied from interface: BaseFigure

Saves the Figure as an image.

Specified by:

save in interface BaseFigure

Parameters:

saveLocation - save location. Must not be null

width - image width

height - image height

wait - whether to hold the calling thread until the file is written

timeoutSeconds - timeout in seconds to wait.

Returns:

figure

validateInitialization

public void validateInitialization()

Checks if the figure can be instantiated. Throws an error if not.

Throws:

RuntimeException - if no charts or no plots have been created

getPlotInfo

public PlotInfo getPlotInfo()

Specified by:

getPlotInfo in interface PlotExceptionCause

setName

public void setName(String figureName)

setSessionId

public void setSessionId(int sessionId)

getName

public String getName()

getSessionId

public int getSessionId()

initializationGate

public InitializationGate initializationGate()

consolidateTableMaps

public void consolidateTableMaps()

consolidateTables

public void consolidateTables()