ResultNodeDefinition

java.lang.Object

com.inductiveautomation.historian.common.model.ResultNodeDefinition

public class ResultNodeDefinition extends Object

Represents a requested column in a historical query. This includes the path to the column, the aggregate to apply, and the fill mode to use.

ResultNodeDefinition is immutable and should be used as a key in a map or set.

Since it represents a requested column, it uses identity hashing and instance equality. It represents an Object, not a description.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ResultNodeDefinition.Builder
Method Summary

Modifier and Type

Method

Description

static ResultNodeDefinition

createCalculated(QualifiedPath path, Aggregate aggregate, FillMode fillMode)

static ResultNodeDefinition

createStandard(QualifiedPath path)

boolean

equals(Object o)

Optional<Aggregate>

getAggregate()

Optional<String>

getAliasName()

Optional<DataType>

getDataType()

Optional<FillMode>

getFillMode()

QualifiedPath

getPath()

int

hashCode()

static ResultNodeDefinition.Builder

newBuilder()

void

setAliasName(String aliasName)

void

setDataType(DataType dataType)

String

toString()

void

updatePath(QualifiedPath path)

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details
- getPath
  
  public QualifiedPath getPath()
- updatePath
  
  public void updatePath(QualifiedPath path)
- setAliasName
  
  public void setAliasName(@Nullable String aliasName)
- getAliasName
  
  public Optional<String> getAliasName()
- setDataType
  
  public void setDataType(@Nullable DataType dataType)
- getDataType
  
  public Optional<DataType> getDataType()
- getAggregate
  
  public Optional<Aggregate> getAggregate()
- getFillMode
  
  public Optional<FillMode> getFillMode()
- createStandard
  
  public static ResultNodeDefinition createStandard(QualifiedPath path)
- createCalculated
  
  public static ResultNodeDefinition createCalculated(QualifiedPath path, Aggregate aggregate, FillMode fillMode)
- newBuilder
  
  public static ResultNodeDefinition.Builder newBuilder()
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object