Record Class SymbolAnalysisOverviewDTO

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.api.dto.symbol.analysis.SymbolAnalysisOverviewDTO
Record Components:
latestClose - latest close
periodReturnPercent - period return percent
medianClose - median close
medianReturnPercent - median return percent
meanReturnPercent - mean return percent
realizedVolatilityPercent - realized volatility percent
annualizedVolatilityPercent - annualized volatility percent
historicalSharpeRatio - historical Sharpe ratio
averageBarMovePercent - average bar move percent
averageTrueRangePercent - average true range percent
priceExpansionState - price expansion state
volumeExpansionState - volume expansion state
barsUsed - bars used
public record SymbolAnalysisOverviewDTO(double latestClose, double periodReturnPercent, double medianClose, double medianReturnPercent, double meanReturnPercent, double realizedVolatilityPercent, double annualizedVolatilityPercent, double historicalSharpeRatio, double averageBarMovePercent, double averageTrueRangePercent, EnumDisplay priceExpansionState, EnumDisplay volumeExpansionState, int barsUsed) extends Record
Overview-statistics DTO.
Version:
2.0.4
Author:
Stephen Prizio

  • Constructor Details

    • SymbolAnalysisOverviewDTO

      public SymbolAnalysisOverviewDTO(double latestClose, double periodReturnPercent, double medianClose, double medianReturnPercent, double meanReturnPercent, double realizedVolatilityPercent, double annualizedVolatilityPercent, double historicalSharpeRatio, double averageBarMovePercent, double averageTrueRangePercent, EnumDisplay priceExpansionState, EnumDisplay volumeExpansionState, int barsUsed)
      Creates an instance of a SymbolAnalysisOverviewDTO record class.
      Parameters:
      latestClose - the value for the latestClose record component
      periodReturnPercent - the value for the periodReturnPercent record component
      medianClose - the value for the medianClose record component
      medianReturnPercent - the value for the medianReturnPercent record component
      meanReturnPercent - the value for the meanReturnPercent record component
      realizedVolatilityPercent - the value for the realizedVolatilityPercent record component
      annualizedVolatilityPercent - the value for the annualizedVolatilityPercent record component
      historicalSharpeRatio - the value for the historicalSharpeRatio record component
      averageBarMovePercent - the value for the averageBarMovePercent record component
      averageTrueRangePercent - the value for the averageTrueRangePercent record component
      priceExpansionState - the value for the priceExpansionState record component
      volumeExpansionState - the value for the volumeExpansionState record component
      barsUsed - the value for the barsUsed record component

  • Method Details

    • empty

      public static SymbolAnalysisOverviewDTO empty()
      Creates an empty DTO shell.
      Returns:
      SymbolAnalysisOverviewDTO

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • latestClose

      public double latestClose()
      Returns the value of the latestClose record component.
      Returns:
      the value of the latestClose record component

    • periodReturnPercent

      public double periodReturnPercent()
      Returns the value of the periodReturnPercent record component.
      Returns:
      the value of the periodReturnPercent record component

    • medianClose

      public double medianClose()
      Returns the value of the medianClose record component.
      Returns:
      the value of the medianClose record component

    • medianReturnPercent

      public double medianReturnPercent()
      Returns the value of the medianReturnPercent record component.
      Returns:
      the value of the medianReturnPercent record component

    • meanReturnPercent

      public double meanReturnPercent()
      Returns the value of the meanReturnPercent record component.
      Returns:
      the value of the meanReturnPercent record component

    • realizedVolatilityPercent

      public double realizedVolatilityPercent()
      Returns the value of the realizedVolatilityPercent record component.
      Returns:
      the value of the realizedVolatilityPercent record component

    • annualizedVolatilityPercent

      public double annualizedVolatilityPercent()
      Returns the value of the annualizedVolatilityPercent record component.
      Returns:
      the value of the annualizedVolatilityPercent record component

    • historicalSharpeRatio

      public double historicalSharpeRatio()
      Returns the value of the historicalSharpeRatio record component.
      Returns:
      the value of the historicalSharpeRatio record component

    • averageBarMovePercent

      public double averageBarMovePercent()
      Returns the value of the averageBarMovePercent record component.
      Returns:
      the value of the averageBarMovePercent record component

    • averageTrueRangePercent

      public double averageTrueRangePercent()
      Returns the value of the averageTrueRangePercent record component.
      Returns:
      the value of the averageTrueRangePercent record component

    • priceExpansionState

      public EnumDisplay priceExpansionState()
      Returns the value of the priceExpansionState record component.
      Returns:
      the value of the priceExpansionState record component

    • volumeExpansionState

      public EnumDisplay volumeExpansionState()
      Returns the value of the volumeExpansionState record component.
      Returns:
      the value of the volumeExpansionState record component

    • barsUsed

      public int barsUsed()
      Returns the value of the barsUsed record component.
      Returns:
      the value of the barsUsed record component