Interface Measure

  • All Superinterfaces:
    Named
    All Known Implementing Classes:
    ImmutableMeasure

    public interface Measure
    extends Named
    Identifies a measure that can be produced by the system.

    A measure identifies the calculation result that is required. For example present value, par rate or spread.

    Some measures represent aspects of the calculation target rather than a calculation. For example, the target identifier, counterparty and trade date.

    Note that not all measures will be available for all targets.

    • Method Detail

      • of

        static Measure of​(java.lang.String uniqueName)
        Obtains an instance from the specified unique name.
        Parameters:
        uniqueName - the unique name
        Returns:
        the measure
        Throws:
        java.lang.IllegalArgumentException - if the name is not known
      • extendedEnum

        static ExtendedEnum<Measure> extendedEnum()
        Gets the extended enum helper.

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

        Returns:
        the extended enum helper
      • getName

        java.lang.String getName()
        Gets the name that uniquely identifies this measure.

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

        Specified by:
        getName in interface Named
        Returns:
        the unique name
      • isCurrencyConvertible

        boolean isCurrencyConvertible()
        Flag indicating whether measure values should be automatically converted to the reporting currency.
        Returns:
        true if measure values should be automatically converted to the reporting currency