Package com.opengamma.strata.calc

Class Column.Builder

java.lang.Object

org.joda.beans.impl.direct.DirectFieldsBeanBuilder<Column>

com.opengamma.strata.calc.Column.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<Column>

Enclosing class:

Column

public static final class Column.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<Column>

The bean-builder for Column.

Method Summary

Modifier and Type	Method	Description
Column	build()
Object	get(String propertyName)
Column.Builder	measure(Measure measure)	Sets the measure to be calculated.
Column.Builder	name(ColumnName name)	Sets the column name.
Column.Builder	parameters(CalculationParameters parameters)	Sets the calculation parameters that apply to this column, used to control the how the calculation is performed.
Column.Builder	reportingCurrency(ReportingCurrency reportingCurrency)	Sets the reporting currency, used to control currency conversion, optional.
Column.Builder	set(String propertyName, Object newValue)
Column.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
String	toString()

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder

get

Methods inherited from class java.lang.Object

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

Method Detail

get

public Object get(String propertyName)

Specified by:

get in interface org.joda.beans.BeanBuilder<Column>

Overrides:

get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<Column>

set

public Column.Builder set(String propertyName,
                          Object newValue)

set

public Column.Builder set(org.joda.beans.MetaProperty<?> property,
                          Object value)

Specified by:

set in interface org.joda.beans.BeanBuilder<Column>

Overrides:

set in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<Column>

build

public Column build()

name

public Column.Builder name(ColumnName name)

Sets the column name.

This is the name of the column, and should be unique in a list of columns.

Parameters:

name - the new value, not null

Returns:

this, for chaining, not null

measure

public Column.Builder measure(Measure measure)

Sets the measure to be calculated.

This defines the calculation being performed, such as 'PresentValue' or 'ParRate'.

Parameters:

measure - the new value, not null

Returns:

this, for chaining, not null

reportingCurrency

public Column.Builder reportingCurrency(ReportingCurrency reportingCurrency)

Sets the reporting currency, used to control currency conversion, optional.

This is used to specify the currency that the result should be reporting in. If the result is not associated with a currency, such as for "par rate", then the reporting currency will effectively be ignored.

If empty, the reporting currency from CalculationRules will be used.

Parameters:

reportingCurrency - the new value

Returns:

this, for chaining, not null

parameters

public Column.Builder parameters(CalculationParameters parameters)

Sets the calculation parameters that apply to this column, used to control the how the calculation is performed.

The parameters from CalculationRules and Column are combined. If a parameter is defined here and in the rules with the same query type, then the column parameter takes precedence.

When building, these will default to be empty.

Parameters:

parameters - the new value

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<Column>