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

Record Class MetadataPoint

java.lang.Object

java.lang.Record

com.inductiveautomation.historian.common.model.data.MetadataPoint

All Implemented Interfaces:

ComplexPoint<PropertySet>, TemporalPoint<PropertySet,ComplexPointType>, Comparable<TemporalPoint<PropertySet,ComplexPointType>>

public record MetadataPoint(PropertySet value, QualityCode quality, Instant timestamp, QualifiedPath source)
extends Record
implements ComplexPoint<PropertySet>

Represents a metadata point in the historian system.

This record encapsulates the value, quality, timestamp, and source of a metadata point. It implements the ComplexPoint interface with PropertySet as the type parameter.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
MetadataPoint(PropertySet value, QualityCode quality, Instant timestamp, QualifiedPath source)	Constructs a MetadataPoint with null checks and default values.

Method Summary

Modifier and Type	Method	Description
static MetadataPoint.Builder	builder()	Creates a new MetadataPoint.Builder for constructing MetadataPoint instances.
static MetadataPoint.Builder	builder(MetadataPoint metadataPoint)	Creates a new MetadataPoint.Builder initialized with the values of the given MetadataPoint.
static MetadataPoint	empty(QualifiedPath source)	Creates an empty MetadataPoint with the given source.
boolean	equals(Object o)	Checks if this metadata point is equal to another object.
static MetadataPoint	from(PropertySet value, QualifiedPath source)	Creates a new MetadataPoint from the given value and source.
int	hashCode()	Computes the hash code for this metadata point.
QualityCode	quality()	Returns the value of the quality record component.
QualifiedPath	source()	Returns the value of the source record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.
StandardComplexPointType	type()	Retrieves the type of this metadata point.
PropertySet	value()	Returns the value of the value record component.
MetadataPoint	withSource(QualifiedPath source)	Creates a new MetadataPoint 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

MetadataPoint

public MetadataPoint(PropertySet value,
 QualityCode quality,
 Instant timestamp,
 QualifiedPath source)

Constructs a MetadataPoint with null checks and default values.

Ensures that the source is not null, and assigns default values for the other fields if they are null.

Parameters:

value - The property set value, defaults to PropertySet.EMPTY if null.

quality - The quality code, defaults to QualityCode.Good if null.

timestamp - The timestamp, defaults to the current time if null.

source - The source path, must not be null.

Method Details

from

public static MetadataPoint from(PropertySet value,
 QualifiedPath source)

Creates a new MetadataPoint from the given value and source.

Parameters:

value - The property set value.

source - The source path.

Returns:

A new MetadataPoint instance.

empty

public static MetadataPoint empty(QualifiedPath source)

Creates an empty MetadataPoint with the given source.

Parameters:

source - The source path.

Returns:

A new MetadataPoint instance with an empty value.

type

public StandardComplexPointType type()

Retrieves the type of this metadata point.

Specified by:

type in interface ComplexPoint<PropertySet>

Specified by:

type in interface TemporalPoint<PropertySet,ComplexPointType>

Returns:

The type of the metadata point, which is StandardComplexPointType.METADATA.

equals

public boolean equals(Object o)

Checks if this metadata point is equal to another object.

Specified by:

equals in class Record

Parameters:

o - The object to compare.

Returns:

true if the objects are equal, false otherwise.

hashCode

public int hashCode()

Computes the hash code for this metadata point.

Specified by:

hashCode in class Record

Returns:

The hash code.

withSource

public MetadataPoint withSource(QualifiedPath source)

Creates a new MetadataPoint with the specified source.

Parameters:

source - The new source path.

Returns:

A new MetadataPoint instance with the updated source.

builder

public static MetadataPoint.Builder builder()

Creates a new MetadataPoint.Builder for constructing MetadataPoint instances.

Returns:

A new MetadataPoint.Builder.

builder

public static MetadataPoint.Builder builder(MetadataPoint metadataPoint)

Creates a new MetadataPoint.Builder initialized with the values of the given MetadataPoint.

Parameters:

metadataPoint - The metadata point to copy values from.

Returns:

A new MetadataPoint.Builder.

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

value

public PropertySet value()

Returns the value of the value record component.

Specified by:

value in interface TemporalPoint<PropertySet,ComplexPointType>

Returns:

the value of the value record component

quality

public QualityCode quality()

Returns the value of the quality record component.

Returns:

the value of the quality record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface TemporalPoint<PropertySet,ComplexPointType>

Returns:

the value of the timestamp record component

source

public QualifiedPath source()

Returns the value of the source record component.

Specified by:

source in interface TemporalPoint<PropertySet,ComplexPointType>

Returns:

the value of the source record component