Record Class SymbolAnalysisSnapshotDTO

java.lang.Object

java.lang.Record

com.bluebell.greenhouse.platform.models.api.dto.symbol.analysis.SymbolAnalysisSnapshotDTO

Record Components:

context - context

overview - overview

priceSeries - price series

sentimentComparison - sentiment comparison

returnDistribution - return distribution

moveProfile - move profile

signalSummary - signal summary

trendSummary - trend summary

eventSummary - event summary

insights - insights

dataState - data state

public record SymbolAnalysisSnapshotDTO(SymbolAnalysisContextDTO context, SymbolAnalysisOverviewDTO overview, SymbolAnalysisPriceSeriesDTO priceSeries, SymbolAnalysisSentimentComparisonDTO sentimentComparison, SymbolAnalysisReturnDistributionDTO returnDistribution, SymbolAnalysisMoveProfileDTO moveProfile, SymbolAnalysisSignalSummaryDTO signalSummary, SymbolAnalysisTrendSummaryDTO trendSummary, SymbolAnalysisEventSummaryDTO eventSummary, List<SymbolAnalysisInsightDTO> insights, SymbolAnalysisDataStateDTO dataState)
extends Record

Aggregate symbol-analysis DTO.

Version:

2.0.4

Author:

Stephen Prizio

Constructor Summary

Constructors

Constructor

Description

SymbolAnalysisSnapshotDTO(SymbolAnalysisContextDTO context, SymbolAnalysisOverviewDTO overview, SymbolAnalysisPriceSeriesDTO priceSeries, SymbolAnalysisSentimentComparisonDTO sentimentComparison, SymbolAnalysisReturnDistributionDTO returnDistribution, SymbolAnalysisMoveProfileDTO moveProfile, SymbolAnalysisSignalSummaryDTO signalSummary, SymbolAnalysisTrendSummaryDTO trendSummary, SymbolAnalysisEventSummaryDTO eventSummary, List<SymbolAnalysisInsightDTO> insights, SymbolAnalysisDataStateDTO dataState)

Creates an instance of a SymbolAnalysisSnapshotDTO record class.

Method Summary

Modifier and Type	Method	Description
SymbolAnalysisContextDTO	context()	Returns the value of the context record component.
SymbolAnalysisDataStateDTO	dataState()	Returns the value of the dataState record component.
static SymbolAnalysisSnapshotDTO	empty()	Creates an empty DTO shell.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
SymbolAnalysisEventSummaryDTO	eventSummary()	Returns the value of the eventSummary record component.
final int	hashCode()	Returns a hash code value for this object.
List<SymbolAnalysisInsightDTO>	insights()	Returns the value of the insights record component.
SymbolAnalysisMoveProfileDTO	moveProfile()	Returns the value of the moveProfile record component.
SymbolAnalysisOverviewDTO	overview()	Returns the value of the overview record component.
SymbolAnalysisPriceSeriesDTO	priceSeries()	Returns the value of the priceSeries record component.
SymbolAnalysisReturnDistributionDTO	returnDistribution()	Returns the value of the returnDistribution record component.
SymbolAnalysisSentimentComparisonDTO	sentimentComparison()	Returns the value of the sentimentComparison record component.
SymbolAnalysisSignalSummaryDTO	signalSummary()	Returns the value of the signalSummary record component.
final String	toString()	Returns a string representation of this record class.
SymbolAnalysisTrendSummaryDTO	trendSummary()	Returns the value of the trendSummary record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SymbolAnalysisSnapshotDTO

public SymbolAnalysisSnapshotDTO(SymbolAnalysisContextDTO context,
 SymbolAnalysisOverviewDTO overview,
 SymbolAnalysisPriceSeriesDTO priceSeries,
 SymbolAnalysisSentimentComparisonDTO sentimentComparison,
 SymbolAnalysisReturnDistributionDTO returnDistribution,
 SymbolAnalysisMoveProfileDTO moveProfile,
 SymbolAnalysisSignalSummaryDTO signalSummary,
 SymbolAnalysisTrendSummaryDTO trendSummary,
 SymbolAnalysisEventSummaryDTO eventSummary,
 List<SymbolAnalysisInsightDTO> insights,
 SymbolAnalysisDataStateDTO dataState)

Creates an instance of a SymbolAnalysisSnapshotDTO record class.

Parameters:

context - the value for the context record component

overview - the value for the overview record component

priceSeries - the value for the priceSeries record component

sentimentComparison - the value for the sentimentComparison record component

returnDistribution - the value for the returnDistribution record component

moveProfile - the value for the moveProfile record component

signalSummary - the value for the signalSummary record component

trendSummary - the value for the trendSummary record component

eventSummary - the value for the eventSummary record component

insights - the value for the insights record component

dataState - the value for the dataState record component

Method Details

empty

public static SymbolAnalysisSnapshotDTO empty()

Creates an empty DTO shell.

Returns:

SymbolAnalysisSnapshotDTO

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

context

public SymbolAnalysisContextDTO context()

Returns the value of the context record component.

Returns:

the value of the context record component

overview

public SymbolAnalysisOverviewDTO overview()

Returns the value of the overview record component.

Returns:

the value of the overview record component

priceSeries

public SymbolAnalysisPriceSeriesDTO priceSeries()

Returns the value of the priceSeries record component.

Returns:

the value of the priceSeries record component

sentimentComparison

public SymbolAnalysisSentimentComparisonDTO sentimentComparison()

Returns the value of the sentimentComparison record component.

Returns:

the value of the sentimentComparison record component

returnDistribution

public SymbolAnalysisReturnDistributionDTO returnDistribution()

Returns the value of the returnDistribution record component.

Returns:

the value of the returnDistribution record component

moveProfile

public SymbolAnalysisMoveProfileDTO moveProfile()

Returns the value of the moveProfile record component.

Returns:

the value of the moveProfile record component

signalSummary

public SymbolAnalysisSignalSummaryDTO signalSummary()

Returns the value of the signalSummary record component.

Returns:

the value of the signalSummary record component

trendSummary

public SymbolAnalysisTrendSummaryDTO trendSummary()

Returns the value of the trendSummary record component.

Returns:

the value of the trendSummary record component

eventSummary

public SymbolAnalysisEventSummaryDTO eventSummary()

Returns the value of the eventSummary record component.

Returns:

the value of the eventSummary record component

insights

public List<SymbolAnalysisInsightDTO> insights()

Returns the value of the insights record component.

Returns:

the value of the insights record component

dataState

public SymbolAnalysisDataStateDTO dataState()

Returns the value of the dataState record component.

Returns:

the value of the dataState record component