org.bimserver.charting.Dimensions

Class ModelDimension

java.lang.Object

org.bimserver.charting.Dimensions.ModelDimension

public class ModelDimension
extends Object

Provides a class that consumes 1 or more keys in a data entry, yielding a correctly named entry. This class does not store data. In densitydesign/raw, objects of the analogous class are used directly as functions, like: dimensionObject(fullDataEntryInSet). After the use, the data is translated into just the applicable data. So, the first element of [{'A': 1, 'B': '2', 'C': 3}, ...] pushed into some dimension, "X", that looks for key "A" would yield the value: 1. In this version, this functionality is covered by ModelDimension.filterDataEntry.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	AllowMultipleValues
int	DataSetMustContainAtLeastXDimensions
static ArrayList<Class>	DatesOnly Dates (java.util.Date) only.
static ArrayList<Class>	DefaultTypes Non-primitive numbers, strings, and dates (java.util.Date).
String	Description
ArrayList<String>	KeysToBeFiltered
static ArrayList<Class>	NumbersAndDatesOnly Non-primitive numbers and dates (java.util.Date).
static ArrayList<Class>	NumbersOnly Non-primitive numbers only.
String	StoreAsKey
static ArrayList<Class>	TextOnly Strings only.
String	Title
ArrayList<Class>	Types

Constructor Summary

Constructors

Constructor and Description
ModelDimension(String title, String storeAsKey, String description, ArrayList<Class> types, int dataSetMustContainAtLeastXDimensions, boolean allowMultipleValues)
ModelDimension(String title, String storeAsKey, String description, ArrayList<Class> types, int dataSetMustContainAtLeastXDimensions, boolean allowMultipleValues, ArrayList<String> keysToBeFiltered) Construct a completely explicit definition of this object.

Method Summary

Modifier and Type	Method and Description
boolean	addLookupKey(String key)
boolean	canBeMultidimensional()
static int	compareNatural(String s1, String s2)
ArrayList<Object>	filterDataEntry(HashMap<String,Object> dataRow) Filter data entry such that a data row's data will be rewritten to just a standard list of values.
int	getCurrentDataKeyConsumptionCount()
int	getLength()
boolean	hasEnoughData()

Methods inherited from class java.lang.Object

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

Field Detail

NumbersOnly

public static final ArrayList<Class> NumbersOnly

Non-primitive numbers only.

TextOnly

public static final ArrayList<Class> TextOnly

Strings only.

DatesOnly

public static final ArrayList<Class> DatesOnly

Dates (java.util.Date) only.

NumbersAndDatesOnly

public static final ArrayList<Class> NumbersAndDatesOnly

Non-primitive numbers and dates (java.util.Date).

DefaultTypes

public static final ArrayList<Class> DefaultTypes

Non-primitive numbers, strings, and dates (java.util.Date).

Title

public String Title

StoreAsKey

public String StoreAsKey

Description

public String Description

Types

public ArrayList<Class> Types

DataSetMustContainAtLeastXDimensions

public int DataSetMustContainAtLeastXDimensions

AllowMultipleValues

public boolean AllowMultipleValues

KeysToBeFiltered

public ArrayList<String> KeysToBeFiltered

Constructor Detail

ModelDimension

public ModelDimension(String title,
                      String storeAsKey,
                      String description,
                      ArrayList<Class> types,
                      int dataSetMustContainAtLeastXDimensions,
                      boolean allowMultipleValues,
                      ArrayList<String> keysToBeFiltered)

Construct a completely explicit definition of this object.

Parameters:

title -

storeAsKey -

description -

types -

dataSetMustContainAtLeastXDimensions -

allowMultipleValues -

keysToBeFiltered -

ModelDimension

public ModelDimension(String title,
                      String storeAsKey,
                      String description,
                      ArrayList<Class> types,
                      int dataSetMustContainAtLeastXDimensions,
                      boolean allowMultipleValues)

Parameters:

title -

storeAsKey -

description -

types -

dataSetMustContainAtLeastXDimensions -

allowMultipleValues -

Method Detail

compareNatural

public static final int compareNatural(String s1,
                                       String s2)

getLength

public int getLength()

hasEnoughData

public boolean hasEnoughData()

getCurrentDataKeyConsumptionCount

public int getCurrentDataKeyConsumptionCount()

canBeMultidimensional

public boolean canBeMultidimensional()

filterDataEntry

public ArrayList<Object> filterDataEntry(HashMap<String,Object> dataRow)

Filter data entry such that a data row's data will be rewritten to just a standard list of values. These values are used as the values accessible via this ModelDimension object, as put together by Model.filterData.

Parameters:

dataRow -

Returns:

addLookupKey

public boolean addLookupKey(String key)