com.opengamma.strata.basics.index

Interface PriceIndex

All Superinterfaces:

Index, Named

All Known Implementing Classes:

ImmutablePriceIndex

public interface PriceIndex
extends Index, Named

An index of prices.

A price index is a normalized average of the prices of goods and/or services. Well-known price indices are published by Governments, such as the Consumer Price Index. The annualized percentage change in the index is a measure of inflation.

This interface represents a price index for a specific region. The index is typically published monthly in arrears, however some regions choose quarterly publication.

The most common implementations are provided in PriceIndices.

All implementations of this interface must be immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
static ExtendedEnum<PriceIndex>	extendedEnum() Gets the extended enum helper.
Currency	getCurrency() Gets the currency of the index.
FloatingRateName	getFloatingRateName() Gets the floating rate name for this index.
String	getName() Gets the name that uniquely identifies this index.
Frequency	getPublicationFrequency() Gets the frequency that the index is published.
Country	getRegion() Gets the region that the index is defined for.
boolean	isActive() Gets whether the index is active.
static PriceIndex	of(String uniqueName) Obtains an instance from the specified unique name.

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

of

Method Detail

of

static PriceIndex of(String uniqueName)

Obtains an instance from the specified unique name.

Parameters:

uniqueName - the unique name

Returns:

the index

Throws:

IllegalArgumentException - if the name is not known

extendedEnum

static ExtendedEnum<PriceIndex> extendedEnum()

Gets the extended enum helper.

This helper allows instances of the index to be looked up. It also provides the complete set of available instances.

Returns:

the extended enum helper

getRegion

Country getRegion()

Gets the region that the index is defined for.

Returns:

the region of the index

getCurrency

Currency getCurrency()

Gets the currency of the index.

Returns:

the currency of the index

isActive

boolean isActive()

Gets whether the index is active.

Over time some indices become inactive and are no longer produced. If this occurs, this method will return false.

Returns:

true if the index is active, false if inactive

getPublicationFrequency

Frequency getPublicationFrequency()

Gets the frequency that the index is published.

Most price indices are published monthly, but some are published quarterly.

Returns:

the frequency of publication of the index

getFloatingRateName

FloatingRateName getFloatingRateName()

Gets the floating rate name for this index.

Returns:

the floating rate name

getName

String getName()

Gets the name that uniquely identifies this index.

This name is used in serialization and can be parsed using of(String).

Specified by:

getName in interface Named

Returns:

the unique name