org.bimserver.charting.Charts

Class Chart

java.lang.Object

org.bimserver.charting.Charts.Chart

Direct Known Subclasses:

Alluvial, BumpChart, ClusterForce, ConvexHull, Delaunay, DepthClusteredTreeview, HexagonalBinning, Packing, ParallelCoordinates, RadialDendrogram, ScatterPlot, SmallMultiplesArea, Streamgraph, Treemap, Treeview, VoronoiTessellation

public class Chart
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	Category
String	Description
boolean	FitToSize
Model	Model
ArrayList<ChartOption>	Options
String	Title

Constructor Summary

Constructors

Constructor and Description
Chart(String title, String description, String category, ArrayList<ChartOption> options, Model model)
Chart(String title, String description, String category, ArrayList<ChartOption> options, Model model, boolean fitToSize)
Chart(String title, String description, String category, Model model)

Method Summary

Modifier and Type	Method and Description
ChartOption	getOption(String optionTitle)
Object	getOptionValue(String optionTitle)
StringBuilder	getRawTextDataSet(ArrayList<LinkedHashMap<String,Object>> data)
boolean	hasOption(String optionTitle)
void	saveToSVG(ArrayList<LinkedHashMap<String,Object>> rawData, String directoryPath)
void	saveToSVG(ArrayList<LinkedHashMap<String,Object>> rawData, String directoryPath, String filename)
void	saveToSVGInUserDirectory(ArrayList<LinkedHashMap<String,Object>> rawData)
void	saveToSVGInUserDirectory(ArrayList<LinkedHashMap<String,Object>> rawData, String filename)
boolean	setDimensionLookupKey(String dimensionKey, String dataKey)
boolean	setDimensionLookupKeys(String dimensionKey, Collection<String> dataKeys)
boolean	setOption(String optionTitle, Object value)
StringBuilder	writeSVG(ArrayList<LinkedHashMap<String,Object>> data) Writes out an SVG file given raw format of data.
StringBuilder	writeSVGBody(StringBuilder builder, ArrayList<LinkedHashMap<String,Object>> data) Functionality to call functionality to write out non-header components of the SVG file, representing the chart.
StringBuilder	writeSVGChartSpecificPayload(StringBuilder builder, ChartRows filteredData) Functionality to calculate and write out axes and/or backgrounds.

Methods inherited from class java.lang.Object

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

Field Detail

Title

public String Title

Description

public String Description

Category

public String Category

Options

public ArrayList<ChartOption> Options

Model

public Model Model

FitToSize

public boolean FitToSize

Constructor Detail

Chart

public Chart(String title,
             String description,
             String category,
             ArrayList<ChartOption> options,
             Model model,
             boolean fitToSize)

Parameters:

title -

description -

category -

options -

model -

fitToSize -

Chart

public Chart(String title,
             String description,
             String category,
             ArrayList<ChartOption> options,
             Model model)

Parameters:

title -

description -

category -

options -

model -

Chart

public Chart(String title,
             String description,
             String category,
             Model model)

Parameters:

title -

description -

category -

model -

Method Detail

hasOption

public boolean hasOption(String optionTitle)

getOptionValue

public Object getOptionValue(String optionTitle)

getOption

public ChartOption getOption(String optionTitle)

setOption

public boolean setOption(String optionTitle,
                         Object value)

writeSVG

public StringBuilder writeSVG(ArrayList<LinkedHashMap<String,Object>> data)

Writes out an SVG file given raw format of data. This method is not meant to be overriden.

Parameters:

data -

Returns:

writeSVGBody

public StringBuilder writeSVGBody(StringBuilder builder,
                                  ArrayList<LinkedHashMap<String,Object>> data)

Functionality to call functionality to write out non-header components of the SVG file, representing the chart.

Parameters:

builder -

data -

Returns:

writeSVGChartSpecificPayload

public StringBuilder writeSVGChartSpecificPayload(StringBuilder builder,
                                                  ChartRows filteredData)

Functionality to calculate and write out axes and/or backgrounds.

Parameters:

builder -

filteredData -

Returns:

setDimensionLookupKey

public boolean setDimensionLookupKey(String dimensionKey,
                                     String dataKey)

setDimensionLookupKeys

public boolean setDimensionLookupKeys(String dimensionKey,
                                      Collection<String> dataKeys)

getRawTextDataSet

public StringBuilder getRawTextDataSet(ArrayList<LinkedHashMap<String,Object>> data)

saveToSVGInUserDirectory

public void saveToSVGInUserDirectory(ArrayList<LinkedHashMap<String,Object>> rawData)

saveToSVGInUserDirectory

public void saveToSVGInUserDirectory(ArrayList<LinkedHashMap<String,Object>> rawData,
                                     String filename)

saveToSVG

public void saveToSVG(ArrayList<LinkedHashMap<String,Object>> rawData,
                      String directoryPath)

saveToSVG

public void saveToSVG(ArrayList<LinkedHashMap<String,Object>> rawData,
                      String directoryPath,
                      String filename)