Package com.ants.platform.client.resources.commons.types

Class CategoricalScore

java.lang.Object

com.ants.platform.client.resources.commons.types.CategoricalScore

All Implemented Interfaces:

IBaseScore, ICategoricalScore

public final class CategoricalScore
extends Object
implements ICategoricalScore, IBaseScore

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CategoricalScore._FinalStage
static final class	CategoricalScore.Builder
static interface	CategoricalScore.CreatedAtStage
static interface	CategoricalScore.IdStage
static interface	CategoricalScore.NameStage
static interface	CategoricalScore.SourceStage
static interface	CategoricalScore.StringValueStage
static interface	CategoricalScore.TimestampStage
static interface	CategoricalScore.UpdatedAtStage

Method Summary

Modifier and Type	Method	Description
static CategoricalScore.StringValueStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Optional<String>	getAuthorUserId()
Optional<String>	getComment()
Optional<String>	getConfigId()
OffsetDateTime	getCreatedAt()
Optional<String>	getDatasetRunId()
Optional<String>	getEnvironment()
String	getId()
Optional<Object>	getMetadata()
String	getName()
Optional<String>	getObservationId()
Optional<String>	getQueueId()
Optional<String>	getSessionId()
ScoreSource	getSource()
String	getStringValue()
OffsetDateTime	getTimestamp()
Optional<String>	getTraceId()
OffsetDateTime	getUpdatedAt()
Optional<Double>	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getValue

public Optional<Double> getValue()

Specified by:

getValue in interface ICategoricalScore

Returns:

Only defined if a config is linked. Represents the numeric category mapping of the stringValue

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface ICategoricalScore

Returns:

The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category

getId

public String getId()

Specified by:

getId in interface IBaseScore

getTraceId

public Optional<String> getTraceId()

Specified by:

getTraceId in interface IBaseScore

getSessionId

public Optional<String> getSessionId()

Specified by:

getSessionId in interface IBaseScore

getObservationId

public Optional<String> getObservationId()

Specified by:

getObservationId in interface IBaseScore

getDatasetRunId

public Optional<String> getDatasetRunId()

Specified by:

getDatasetRunId in interface IBaseScore

getName

public String getName()

Specified by:

getName in interface IBaseScore

getSource

public ScoreSource getSource()

Specified by:

getSource in interface IBaseScore

getTimestamp

public OffsetDateTime getTimestamp()

Specified by:

getTimestamp in interface IBaseScore

getCreatedAt

public OffsetDateTime getCreatedAt()

Specified by:

getCreatedAt in interface IBaseScore

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Specified by:

getUpdatedAt in interface IBaseScore

getAuthorUserId

public Optional<String> getAuthorUserId()

Specified by:

getAuthorUserId in interface IBaseScore

getComment

public Optional<String> getComment()

Specified by:

getComment in interface IBaseScore

getMetadata

public Optional<Object> getMetadata()

Specified by:

getMetadata in interface IBaseScore

getConfigId

public Optional<String> getConfigId()

Specified by:

getConfigId in interface IBaseScore

Returns:

Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

getQueueId

public Optional<String> getQueueId()

Specified by:

getQueueId in interface IBaseScore

Returns:

Reference an annotation queue on a score. Populated if the score was initially created in an annotation queue.

getEnvironment

public Optional<String> getEnvironment()

Specified by:

getEnvironment in interface IBaseScore

Returns:

The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'ants-platform'.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static CategoricalScore.StringValueStage builder()