net.pricefx.server.dto.calculation

Class ResultMatrix

Object

ResultMatrix

All Implemented Interfaces:

Serializable, ComplexCalculationResult

public class ResultMatrix
extends Object
implements ComplexCalculationResult, Serializable

This class is used to transport a calculated matrix-style result It is basically a list of maps with the addition that the column names are clearly named and can have a format This means: - the UI knows exactly which columns to display (even if some maps do not have those as keys) - the entry maps can have more "columns" (or keys) than those that are displayed; maybe useful for calculation

Author:

cat

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ResultMatrix.AbstractResultMatrixCell
class	ResultMatrix.ResultMatrixImageCell
class	ResultMatrix.ResultMatrixLinkCell
class	ResultMatrix.ResultMatrixOnRowSelection
class	ResultMatrix.ResultMatrixStyledCell

Constructor Summary

Constructors

Constructor and Description
ResultMatrix()
ResultMatrix(Collection<String> columns) Creates a new matrix object with an initial set of columns
ResultMatrix(Map jsonMap)
ResultMatrix(String... columns) Creates a new matrix object with an initial set of columns

Method Summary

Modifier and Type	Method and Description
void	addColumn(String column) Adds a column to the existing set of columns
void	addColumns(Collection<String> columns) Adds columns to the existing set of columns
void	addRow(List<Object> row) Adds a data row.
void	addRow(Map<String,Object> row) Adds a data row.
void	addRow(Object... values) Adds a data row.
Map<String,Object>	findRow(String key, Object value) Retrieves a particular row based on a value check
Map<String,FieldFormatType>	getColumnFormats() Gets individual column formats (if specified)
List<String>	getColumns() Gets a list of defined columns
FieldFormatType	getDefaultFormat() Gets the default format
List<Map<String,Object>>	getEntries() Returns the current list entries as a list (=the rows) of maps (= the row content)
Map<String,Map<String,String>>	getOnRowSelectEvents()
String	getResultType()
ResultMatrix.ResultMatrixImageCell	imageCell(Object value) Creates an image cell that can then be added as row value.
boolean	isEnableClientFilter()
ResultMatrix.ResultMatrixImageCell	libraryImage(String mainName, String statusName)
ResultMatrix.ResultMatrixLinkCell	linkCell(Object value, String targetPage, String targetPageState)
ResultMatrix.ResultMatrixLinkCell	linkToPriceGrid(Object value, long priceGridID, Filter filter)
ResultMatrix.ResultMatrixLinkCell	linkToPriceList(Object value, long priceListID, Filter filter)
ResultMatrix.ResultMatrixOnRowSelection	onRowSelection() Configures a client-side UI event.
void	setColumnFormat(String column, FieldFormatType fft) Sets a column format for a specified column
void	setDefaultFormat(FieldFormatType fft) Sets a default column format
void	setEnableClientFilter(boolean enableClientFilter)
ResultMatrix.ResultMatrixStyledCell	styledCell(Object value) Creates a styled cell that can then be added as row value
ResultMatrix.ResultMatrixStyledCell	styledCell(Object value, String textColor, String bgColor) Creates a styled cell that can then be added as row value
ResultMatrix.ResultMatrixStyledCell	styledCell(Object value, String textColor, String bgColor, String weight) Creates a styled cell that can then be added as row value
ResultMatrix.ResultMatrixStyledCell	styledCell(Object value, String textColor, String bgColor, String weight, String alignment) Creates a styled cell that can then be added as row value
String	toString()

Methods inherited from class Object

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

Constructor Detail

ResultMatrix

public ResultMatrix()

ResultMatrix

public ResultMatrix(Map jsonMap)

ResultMatrix

public ResultMatrix(String... columns)

Creates a new matrix object with an initial set of columns

Parameters:

columns - The initial set of column names

ResultMatrix

public ResultMatrix(Collection<String> columns)

Creates a new matrix object with an initial set of columns

Parameters:

columns - Collection of column names

Method Detail

addColumn

public void addColumn(String column)

Adds a column to the existing set of columns

Parameters:

column - The columns name

addColumns

public void addColumns(Collection<String> columns)

Adds columns to the existing set of columns

Parameters:

columns - Collection of columns names

addRow

public void addRow(Map<String,Object> row)

Adds a data row. The keys of the row-map should match the column names defined earlier

Parameters:

row -

addRow

public void addRow(List<Object> row)

Adds a data row. The order of the values is assumed to be the same as the matrix column order.

Parameters:

row - Row as List

addRow

public void addRow(Object... values)

Adds a data row. The order of the values is assumed to be the same as the matrix column order.

Parameters:

row - Row as Array

getColumns

public List<String> getColumns()

Gets a list of defined columns

Returns:

The columns

getEntries

public List<Map<String,Object>> getEntries()

Returns the current list entries as a list (=the rows) of maps (= the row content)

Returns:

List of maps

findRow

public Map<String,Object> findRow(String key,
                                  Object value)

Retrieves a particular row based on a value check

Parameters:

key - The column name to search on

value - The value to match the row's column value to

Returns:

The row

setDefaultFormat

public void setDefaultFormat(FieldFormatType fft)

Sets a default column format

Parameters:

fft -

getDefaultFormat

public FieldFormatType getDefaultFormat()

Gets the default format

Returns:

Default format

getColumnFormats

public Map<String,FieldFormatType> getColumnFormats()

Gets individual column formats (if specified)

Returns:

A Map with column name and format

getOnRowSelectEvents

public Map<String,Map<String,String>> getOnRowSelectEvents()

setColumnFormat

public void setColumnFormat(String column,
                            FieldFormatType fft)

Sets a column format for a specified column

Parameters:

column - The column name

fft - The format

isEnableClientFilter

public boolean isEnableClientFilter()

setEnableClientFilter

public void setEnableClientFilter(boolean enableClientFilter)

styledCell

public ResultMatrix.ResultMatrixStyledCell styledCell(Object value)

Creates a styled cell that can then be added as row value

Parameters:

value - The value of the cell

Returns:

The styled cell object that can then be further styled with e.g. the flow pattern .withXXX() methods

styledCell

public ResultMatrix.ResultMatrixStyledCell styledCell(Object value,
                                                      String textColor,
                                                      String bgColor)

Creates a styled cell that can then be added as row value

Parameters:

value - The value of the cell

textColor - The text color of the cell

bgColor - The background color of the cell (HTML hex value)

Returns:

The styled cell object

styledCell

public ResultMatrix.ResultMatrixStyledCell styledCell(Object value,
                                                      String textColor,
                                                      String bgColor,
                                                      String weight)

Creates a styled cell that can then be added as row value

Parameters:

value - The value of the cell

textColor - The text color of the cell

bgColor - The background color of the cell (HTML hex value)

weight - The font weight

Returns:

The styled cell object

styledCell

public ResultMatrix.ResultMatrixStyledCell styledCell(Object value,
                                                      String textColor,
                                                      String bgColor,
                                                      String weight,
                                                      String alignment)

Creates a styled cell that can then be added as row value

Parameters:

value - The value of the cell

textColor - The text color of the cell

bgColor - The background color of the cell (HTML hex value)

weight - The font weight

alignment - Cell alignement value (valid CSS)

Returns:

The styled cell object

imageCell

public ResultMatrix.ResultMatrixImageCell imageCell(Object value)

Creates an image cell that can then be added as row value. Value should be a valid image URL

Parameters:

value - The image URL

Returns:

The image cell object

libraryImage

public ResultMatrix.ResultMatrixImageCell libraryImage(String mainName,
                                                       String statusName)

linkToPriceGrid

public ResultMatrix.ResultMatrixLinkCell linkToPriceGrid(Object value,
                                                         long priceGridID,
                                                         Filter filter)

linkToPriceList

public ResultMatrix.ResultMatrixLinkCell linkToPriceList(Object value,
                                                         long priceListID,
                                                         Filter filter)

linkCell

public ResultMatrix.ResultMatrixLinkCell linkCell(Object value,
                                                  String targetPage,
                                                  String targetPageState)

onRowSelection

public ResultMatrix.ResultMatrixOnRowSelection onRowSelection()

Configures a client-side UI event. Use case is usually a refresh of some sort when a result matrix row is selected Example code:

 matrix.onRowSelection().triggerEvent(api.dashboardWideEvent("CustomerIdChanged-ED")).withColValueAsEventDataAttr("CustomerID", "customerId")
 

The embedded dashboard that receives the event could then look like:

  return api.dashboard("EmbeddedDashboard")

    // Here the user can assign values to the embedded
    // dashboard inputs common to all three modes
    .setParam("Customer Id", api.input("Customer Id"))
    .setParam("Year", api.input("Year"))

    // Show the dashboard embedded ...
    .showEmbedded()
    // ... and reevaluate it on "CustomerIdChanged-ED"
    // Note: "dashboardWideEvent()" fce makes the event local
    // to the containing dashboard instance
    .andRecalculateOn(api.dashboardWideEvent("CustomerIdChanged-ED"))
    // Pull the "customerId" attribute out of the event payload and expose it
    // as the "Customer Id" input to the embedded dashboard
    .withEventDataAttr("customerId").asParam("Customer Id")
 

Returns:

The selection event to further configure it in a flow pattern

toString

public String toString()

Overrides:

toString in class Object

getResultType

public String getResultType()

Specified by:

getResultType in interface ComplexCalculationResult