Package com.inductiveautomation.historian.common.model.data

Record Class AnnotationPoint

java.lang.Object

java.lang.Record

com.inductiveautomation.historian.common.model.data.AnnotationPoint

Record Components:

identifier - A unique UUID identifying the annotation point. Must not be null.

source - The QualifiedPath representing the source of the annotation. Must not be null.

value - The Annotation value of the annotation point. Must not be null.

startTime - The Instant representing the start time of the annotation. Must not be null.

endTime - An Optional containing the end time of the annotation, if available.

lastUpdated - An Optional containing the last updated time of the annotation, if available.

All Implemented Interfaces:

ComplexPoint<Annotation>, TemporalPoint<Annotation,ComplexPointType>, Comparable<TemporalPoint<Annotation,ComplexPointType>>

public record AnnotationPoint(UUID identifier, QualifiedPath source, Annotation value, Instant startTime, Optional<Instant> endTime, Optional<Instant> lastUpdated)
extends Record
implements ComplexPoint<Annotation>

Represents an annotation point in the historian system.

This record implements ComplexPoint with a value type of Annotation. It encapsulates metadata and temporal information about an annotation, including its identifier, source, value, start time, optional end time, and optional last updated time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationPoint.Builder	A builder class for constructing AnnotationPoint instances.

Constructor Summary

Constructors

Constructor	Description
AnnotationPoint(UUID identifier, QualifiedPath source, Annotation value, Instant startTime, Optional<Instant> endTime, Optional<Instant> lastUpdated)	Constructs an AnnotationPoint instance.

Method Summary

Modifier and Type	Method	Description
static AnnotationPoint.Builder	builder()	Creates a new AnnotationPoint.Builder instance for constructing AnnotationPoint objects.
Optional<Instant>	endTime()	Returns the value of the endTime record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
UUID	identifier()	Returns the value of the identifier record component.
Optional<Instant>	lastUpdated()	Returns the value of the lastUpdated record component.
QualifiedPath	source()	Returns the value of the source record component.
Instant	startTime()	Returns the value of the startTime record component.
Instant	timestamp()	Retrieves the timestamp of the annotation point.
final String	toString()	Returns a string representation of this record class.
StandardComplexPointType	type()	Retrieves the type of the annotation point.
Annotation	value()	Returns the value of the value record component.
AnnotationPoint	withSource(QualifiedPath source)	Creates a new AnnotationPoint with the specified source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.historian.common.model.data.TemporalPoint

compareTo

Constructor Details

AnnotationPoint

public AnnotationPoint(UUID identifier,
 QualifiedPath source,
 Annotation value,
 Instant startTime,
 Optional<Instant> endTime,
 Optional<Instant> lastUpdated)

Constructs an AnnotationPoint instance.

Validates that the required fields are not null and ensures that the end time, if present, is not before the start time.

Throws:

NullPointerException - If any required field is null.

IllegalArgumentException - If the end time is before the start time.

Method Details

builder

public static AnnotationPoint.Builder builder()

Creates a new AnnotationPoint.Builder instance for constructing AnnotationPoint objects.

Returns:

A new AnnotationPoint.Builder.

withSource

public AnnotationPoint withSource(QualifiedPath source)

Creates a new AnnotationPoint with the specified source.

If the source is the same as the current source, the existing instance is returned.

Parameters:

source - The new QualifiedPath source.

Returns:

A new AnnotationPoint with the updated source, or the current instance if unchanged.

timestamp

public Instant timestamp()

Retrieves the timestamp of the annotation point.

Specified by:

timestamp in interface TemporalPoint<Annotation,ComplexPointType>

Returns:

The Instant representing the start time of the annotation.

type

public StandardComplexPointType type()

Retrieves the type of the annotation point.

By default, this method returns StandardComplexPointType.ANNOTATION.

Specified by:

type in interface ComplexPoint<Annotation>

Specified by:

type in interface TemporalPoint<Annotation,ComplexPointType>

Returns:

The StandardComplexPointType of the annotation point.

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.

identifier

public UUID identifier()

Returns the value of the identifier record component.

Returns:

the value of the identifier record component

source

public QualifiedPath source()

Returns the value of the source record component.

Specified by:

source in interface TemporalPoint<Annotation,ComplexPointType>

Returns:

the value of the source record component

value

public Annotation value()

Returns the value of the value record component.

Specified by:

value in interface TemporalPoint<Annotation,ComplexPointType>

Returns:

the value of the value record component

startTime

public Instant startTime()

Returns the value of the startTime record component.

Returns:

the value of the startTime record component

endTime

public Optional<Instant> endTime()

Returns the value of the endTime record component.

Returns:

the value of the endTime record component

lastUpdated

public Optional<Instant> lastUpdated()

Returns the value of the lastUpdated record component.

Returns:

the value of the lastUpdated record component