ParameterMetadata (OpenGamma Strata)

All Superinterfaces:

org.joda.beans.Bean, org.joda.beans.ImmutableBean

All Known Subinterfaces:

DatedParameterMetadata, TenoredParameterMetadata

All Known Implementing Classes:

FxVolatilitySurfaceYearFractionParameterMetadata, GenericVolatilitySurfacePeriodParameterMetadata, GenericVolatilitySurfaceYearFractionParameterMetadata, LabelDateParameterMetadata, LabelParameterMetadata, ResolvedTradeParameterMetadata, SimpleCurveParameterMetadata, SimpleSurfaceParameterMetadata, SwaptionSurfaceExpirySimpleMoneynessParameterMetadata, SwaptionSurfaceExpiryStrikeParameterMetadata, SwaptionSurfaceExpiryTenorParameterMetadata, TenorDateParameterMetadata, TenorParameterMetadata, TenorTenorParameterMetadata, YearMonthDateParameterMetadata
```
public interface ParameterMetadata
extends org.joda.beans.ImmutableBean
```
Information about a single parameter.
Implementations of this interface are used to store metadata about a parameter. Parameters are an abstraction over curves, surfaces and other types of data.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static ParameterMetadata`	`empty()`	Gets an empty metadata instance.
`Object`	`getIdentifier()`	Returns an object used to identify the parameter.
`String`	`getLabel()`	Gets the label that describes the parameter.
`static List<ParameterMetadata>`	`listOfEmpty(int size)`	Gets a list of empty metadata instances.

Methods inherited from interface org.joda.beans.Bean
metaBean, property, propertyNames

- Method Detail
  - empty
```
static ParameterMetadata empty()
```
    Gets an empty metadata instance.
    This is used when the actual metadata is not known.
    
    Returns:
    
    the empty instance
  - listOfEmpty
```
static List<ParameterMetadata> listOfEmpty(int size)
```
    Gets a list of empty metadata instances.
    This is used when there the actual metadata is not known.
    
    Parameters:
    
    size - the size of the resulting list
    
    Returns:
    
    the empty instance
  - getLabel
```
String getLabel()
```
    Gets the label that describes the parameter.
    It is intended that the label is relatively short, however there is no formal restriction.
    
    Returns:
    
    the label
  - getIdentifier
```
Object getIdentifier()
```
    Returns an object used to identify the parameter.
    A good choice of identifier is one that makes sense to the user and can easily be created as part of a scenario definition. For example, many nodes types are naturally identified by a tenor.
    The identifier must satisfy the following criteria:
    
    It must be non-null
    
    It should be unique within a single data set
    
    It should have a sensible implementation of hashCode() and equals().
    
    Otherwise the choice of identifier is free and the system makes no assumptions about it.
    Returns:
    
    an object used to uniquely identify the parameter within the data