net.pricefx.formulaengine

Interface DatamartQueryResult

public interface DatamartQueryResult

Provides access to a QueryResult in a formula context. A query result may be obtained by - executing a Query in the DatamartContext - calling the DatamartQuery function, or equivalent SandboxAPI api.datamartQuery() - both deprecated!

Method Summary

Modifier and Type	Method and Description
void	calculateSummaryStatistics() Calculates basic summary statistics on the query result data: Sum, Avg, Mean, Min, Max, Std and quantiles Q.05, Q.1, Q.2, Q.25, Q.4, Q.5, Q.6, Q.7, Q.75, Q.8, Q.8, Q.95.
void	determineDistinctValues(String projAlias, String additionalProjAliases) Adds the set of distinct values for the specified projections to the Summary map, in summary.distinctValuesFor_.
Matrix2D	getData() Retreives the query result data.
Map<String,Serializable>	getSummary() Additional query summary information,
void	runRegression(String dependentProjAlias, String independentProjAlias, String... additionaDependentProjAliases) Runs a linear and exponential regression on the data set in the query result.

Method Detail

getData

Matrix2D getData()

Retreives the query result data. .

Returns:

The query result data in Matrix format. All data rows are included in this matrix. The matrix rows represent data rows, while the columns represent the query projections. Return null if the maximum number of rows is exceeded. This max is set through Price f(x) instance parameter 'datamart.query.externalRowsLimit', with a typical value of 100k rows.

getSummary

Map<String,Serializable> getSummary()

Additional query summary information,

Returns:

A map of maps with (key,value) pairs.

runRegression

void runRegression(String dependentProjAlias,
                   String independentProjAlias,
                   String... additionaDependentProjAliases)

Runs a linear and exponential regression on the data set in the query result. The LR coefficients are added to the query's Summary map. The coefficient for a given independent variable is in summary.projections..LRb (ERb for the exponential regression). The intersect on the dependent variable axis is in summary.projections..LRa (ERa).

Parameters:

dependentProjAlias - The dependent variable, identified by the alias of a query projection

independentProjAlias - The independent variable, identified by the alias of a query projection

additionaDependentProjAliases - Optional additional independent variables, identified by the alias of a query projection(s)

calculateSummaryStatistics

void calculateSummaryStatistics()

Calculates basic summary statistics on the query result data: Sum, Avg, Mean, Min, Max, Std and quantiles Q.05, Q.1, Q.2, Q.25, Q.4, Q.5, Q.6, Q.7, Q.75, Q.8, Q.8, Q.95.

determineDistinctValues

void determineDistinctValues(String projAlias,
                             String additionalProjAliases)

Adds the set of distinct values for the specified projections to the Summary map, in summary.distinctValuesFor_.

Parameters:

projAlias -

additionalProjAliases -