FieldName (OpenGamma Strata Data)

java.lang.Object
- com.opengamma.strata.collect.TypedString<FieldName>
- - com.opengamma.strata.data.FieldName

All Implemented Interfaces:

Named, Serializable, Comparable<FieldName>
```
public final class FieldName
extends TypedString<FieldName>
```
The name of a field in a market data record.
Market data is typically provided as a record containing multiple fields. Each field contains an item of data. The record is identified by a unique ID and the fields are identified by name. Therefore an item of market data is uniquely identified by the combination its ID and field name.
Different market data providers use different sets of field names. The names in this class are not specific to any provider, and are mapped to the provider field names by the market data system. This allows calculations to request an item of data using its field name, such as "closing price", without having to know which data provider it is coming from.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static FieldName`	`CLEAN_NOMINAL_PRICE` The field name for the clean nominal price of a capital indexed bond.
`static FieldName`	`CLEAN_PRICE` The field name for the clean price of a coupon bond.
`static FieldName`	`CLEAN_REAL_PRICE` The field name for the clean real price of a capital indexed bond.
`static FieldName`	`DIRTY_PRICE` The field name for the dirty price of a coupon bond.
`static FieldName`	`MARKET_VALUE` The field name for the market value - 'MarketValue'.
`static FieldName`	`NOMINAL_YIELD_TO_MATURITY` The field name for the nominal yield.
`static FieldName`	`PAR_YIELD` The field name for the par yield.
`static FieldName`	`REAL_YIELD_TO_MATURITY` The field name for the real yield.
`static FieldName`	`SETTLEMENT_PRICE` The field name for the settlement price - 'SettlementPrice'.
`static FieldName`	`VOLATILITY` The field name for the volatility of an asset.
`static FieldName`	`YIELD_TO_MATURITY` The field name for the yield to maturity.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static FieldName of(String name)
Obtains an instance from the specified name.
- Methods inherited from class com.opengamma.strata.collect.TypedString
  compareTo, equals, getName, hashCode, toString
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait
- Methods inherited from interface com.opengamma.strata.collect.named.Named
  of

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static FieldName`	`of(String name)` Obtains an instance from the specified name.

- Field Detail
  - MARKET_VALUE
```
public static final FieldName MARKET_VALUE
```
    The field name for the market value - 'MarketValue'.
    This is used to refer to the standard market quote for the identifier. It is typically used as the default when no field name is specified.
  - SETTLEMENT_PRICE
```
public static final FieldName SETTLEMENT_PRICE
```
    The field name for the settlement price - 'SettlementPrice'.
    This is used to refer to the daily settlement price used in margining.
  - CLEAN_PRICE
```
public static final FieldName CLEAN_PRICE
```
    The field name for the clean price of a coupon bond.
    The clean price does not include the accrued interest.
  - CLEAN_REAL_PRICE
```
public static final FieldName CLEAN_REAL_PRICE
```
    The field name for the clean real price of a capital indexed bond.
    The clean real price does not include the accrued interest.
  - CLEAN_NOMINAL_PRICE
```
public static final FieldName CLEAN_NOMINAL_PRICE
```
    The field name for the clean nominal price of a capital indexed bond.
    The clean nominal price does not include the accrued interest.
  - DIRTY_PRICE
```
public static final FieldName DIRTY_PRICE
```
    The field name for the dirty price of a coupon bond.
    The dirty price includes the accrued interest.
  - VOLATILITY
```
public static final FieldName VOLATILITY
```
    The field name for the volatility of an asset.
  - YIELD_TO_MATURITY
```
public static final FieldName YIELD_TO_MATURITY
```
    The field name for the yield to maturity.
    This is used to refer to the yield of a coupon bond or bill.
  - REAL_YIELD_TO_MATURITY
```
public static final FieldName REAL_YIELD_TO_MATURITY
```
    The field name for the real yield.
    This is used to refer to the real yield of a capital indexed bond.
  - NOMINAL_YIELD_TO_MATURITY
```
public static final FieldName NOMINAL_YIELD_TO_MATURITY
```
    The field name for the nominal yield.
    This is used to refer to the yield of a coupon bond or bill.
  - PAR_YIELD
```
public static final FieldName PAR_YIELD
```
    The field name for the par yield.
    This is used to refer to the par yield of a coupon bond or bill.
- Method Detail
  - of
```
public static FieldName of(String name)
```
    Obtains an instance from the specified name.
    Field names may contain any character, but must not be empty.
    
    Parameters:
    
    name - the name of the field
    
    Returns:
    
    a field with the specified name

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class FieldName

Field Summary

Method Summary

Methods inherited from class com.opengamma.strata.collect.TypedString

Methods inherited from class java.lang.Object

Methods inherited from interface com.opengamma.strata.collect.named.Named

Field Detail

MARKET_VALUE

SETTLEMENT_PRICE

CLEAN_PRICE

CLEAN_REAL_PRICE

CLEAN_NOMINAL_PRICE

DIRTY_PRICE

VOLATILITY

YIELD_TO_MATURITY

REAL_YIELD_TO_MATURITY

NOMINAL_YIELD_TO_MATURITY

PAR_YIELD

Method Detail

of