Record Class SymbolAnalysisTrendSummaryDTO

java.lang.Object
java.lang.Record
com.bluebell.greenhouse.platform.models.api.dto.symbol.analysis.SymbolAnalysisTrendSummaryDTO
Record Components:
regime - regime
direction - direction
regimeConfidence - regime confidence
slopePercentPerBar - slope percent per bar
emaAlignmentScore - EMA alignment score
rangeCompressionScore - range compression score
shortTermSummary - short-term summary
longTermSummary - long-term summary
priceExpansionState - price expansion state
volumeExpansionState - volume expansion state
public record SymbolAnalysisTrendSummaryDTO(EnumDisplay regime, EnumDisplay direction, double regimeConfidence, double slopePercentPerBar, double emaAlignmentScore, double rangeCompressionScore, String shortTermSummary, String longTermSummary, EnumDisplay priceExpansionState, EnumDisplay volumeExpansionState) extends Record
Trend-summary DTO.
Version:
2.0.4
Author:
Stephen Prizio

  • Constructor Details

    • SymbolAnalysisTrendSummaryDTO

      public SymbolAnalysisTrendSummaryDTO(EnumDisplay regime, EnumDisplay direction, double regimeConfidence, double slopePercentPerBar, double emaAlignmentScore, double rangeCompressionScore, String shortTermSummary, String longTermSummary, EnumDisplay priceExpansionState, EnumDisplay volumeExpansionState)
      Creates an instance of a SymbolAnalysisTrendSummaryDTO record class.
      Parameters:
      regime - the value for the regime record component
      direction - the value for the direction record component
      regimeConfidence - the value for the regimeConfidence record component
      slopePercentPerBar - the value for the slopePercentPerBar record component
      emaAlignmentScore - the value for the emaAlignmentScore record component
      rangeCompressionScore - the value for the rangeCompressionScore record component
      shortTermSummary - the value for the shortTermSummary record component
      longTermSummary - the value for the longTermSummary record component
      priceExpansionState - the value for the priceExpansionState record component
      volumeExpansionState - the value for the volumeExpansionState record component

  • Method Details

    • empty

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

    • 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.

    • regime

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

    • direction

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

    • regimeConfidence

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

    • slopePercentPerBar

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

    • emaAlignmentScore

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

    • rangeCompressionScore

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

    • shortTermSummary

      public String shortTermSummary()
      Returns the value of the shortTermSummary record component.
      Returns:
      the value of the shortTermSummary record component

    • longTermSummary

      public String longTermSummary()
      Returns the value of the longTermSummary record component.
      Returns:
      the value of the longTermSummary 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