org.bimserver.charting.Models

Class Model

java.lang.Object

org.bimserver.charting.Models.Model

Direct Known Subclasses:

AlluvialModel, ParallelCoordinatesModel, PointsModel, StreamModel, TreeModel

public class Model
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	Description
ArrayList<ModelDimension>	Dimensions
String	Title

Constructor Summary

Constructors

Constructor and Description
Model(String title, String description, ArrayList<ModelDimension> dimensions)

Method Summary

Modifier and Type	Method and Description
ChartRows	filterData(ArrayList<LinkedHashMap<String,Object>> data) This method filters a list of data rows, rewriting them into a list of transformed data rows.
Object[]	getDataOfDimensionAsObjectsByKey(String key, ChartRows filteredData)
ModelDimension	getDimensionByKey(String key) Provide a method to facilitate getting a dimension of this model by its key.
ChartExtent	getExtentFromDimensionGivenKey(String key, boolean lowerBoundIsZero, ChartRows filteredData)
ChartExtent	getExtentFromDimensionGivenKey(String key, boolean lowerBoundIsZero, ChartRows filteredData, double worldSpaceStart, double worldSpaceEnd)
ChartExtent	getExtentFromDimensionGivenKey(String key, boolean lowerBoundIsZero, ChartRows filteredData, double worldSpaceStart, double worldSpaceEnd, double defaultTickCount)
String	getInstruction()
Double	getMaximumDoubleFromDimensionGivenKey(String key, Double lowerLimit, ChartRows filteredData, IModulateValueDelegate<Double> valueHandler)
Integer	getMaximumIntegerFromDimensionGivenKey(String key, Integer lowerLimit, ChartRows filteredData, IModulateValueDelegate<Integer> valueHandler) Provide a way to get the maximum value of a sequence.
static Double	getNumberOfFiguresFromDouble(Double value)
static int	getNumberOfFiguresFromInteger(int n)
boolean	isValid()
boolean	setDimensionLookupKey(String dimensionKey, String dataKey)
boolean	setDimensionLookupKeys(String dimensionKey, Collection<String> dataKeys)

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

Dimensions

public ArrayList<ModelDimension> Dimensions

Constructor Detail

Model

public Model(String title,
             String description,
             ArrayList<ModelDimension> dimensions)

Parameters:

title -

description -

dimensions -

Method Detail

isValid

public boolean isValid()

getInstruction

public String getInstruction()

filterData

public ChartRows filterData(ArrayList<LinkedHashMap<String,Object>> data)

This method filters a list of data rows, rewriting them into a list of transformed data rows. The transformation goes from a string key to a model dimension key. Actual transformation is handled during ModelDimension.filterDataEntry.

Parameters:

data -

Returns:

getDimensionByKey

public ModelDimension getDimensionByKey(String key)

Provide a method to facilitate getting a dimension of this model by its key.

Parameters:

key -

Returns:

getDataOfDimensionAsObjectsByKey

public Object[] getDataOfDimensionAsObjectsByKey(String key,
                                                 ChartRows filteredData)

Parameters:

key -

filteredData -

Returns:

getMaximumIntegerFromDimensionGivenKey

public Integer getMaximumIntegerFromDimensionGivenKey(String key,
                                                      Integer lowerLimit,
                                                      ChartRows filteredData,
                                                      IModulateValueDelegate<Integer> valueHandler)

Provide a way to get the maximum value of a sequence. Includes ability to specify a lower limit. Includes ability to specify a per-row handler.

Parameters:

key -

lowerLimit -

filteredData -

valueHandler -

Returns:

getMaximumDoubleFromDimensionGivenKey

public Double getMaximumDoubleFromDimensionGivenKey(String key,
                                                    Double lowerLimit,
                                                    ChartRows filteredData,
                                                    IModulateValueDelegate<Double> valueHandler)

getExtentFromDimensionGivenKey

public ChartExtent getExtentFromDimensionGivenKey(String key,
                                                  boolean lowerBoundIsZero,
                                                  ChartRows filteredData)

getExtentFromDimensionGivenKey

public ChartExtent getExtentFromDimensionGivenKey(String key,
                                                  boolean lowerBoundIsZero,
                                                  ChartRows filteredData,
                                                  double worldSpaceStart,
                                                  double worldSpaceEnd)

getExtentFromDimensionGivenKey

public ChartExtent getExtentFromDimensionGivenKey(String key,
                                                  boolean lowerBoundIsZero,
                                                  ChartRows filteredData,
                                                  double worldSpaceStart,
                                                  double worldSpaceEnd,
                                                  double defaultTickCount)

setDimensionLookupKey

public boolean setDimensionLookupKey(String dimensionKey,
                                     String dataKey)

setDimensionLookupKeys

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

getNumberOfFiguresFromDouble

public static Double getNumberOfFiguresFromDouble(Double value)

getNumberOfFiguresFromInteger

public static int getNumberOfFiguresFromInteger(int n)