Package com.inductiveautomation.historian.gateway.api.query.processor

Record Class DefaultProcessingContext<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.processor.DefaultProcessingContext<K,T>
Type Parameters:
K - The type of query key, which extends QueryKey.
T - The type of temporal point type, which extends both TemporalPointType and QueryablePointType.
All Implemented Interfaces:
ProcessingContext<K,T>
public record DefaultProcessingContext<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>(Map<K extends QueryKey<T>,PropertySet> properties) extends Record implements ProcessingContext<K,T>
Base implementation of ProcessingContext that maintains properties for query keys.

This record provides a concrete implementation of the ProcessingContext interface, storing a mapping of query keys to their associated PropertySet instances. It ensures the immutability of the property map and provides utility methods for accessing and manipulating context values.

  • Constructor Details

    • DefaultProcessingContext

      public DefaultProcessingContext(Map<K,PropertySet> properties)
      Constructs a new DefaultProcessingContext with the specified properties.

      Ensures that the provided properties map is not null and creates an immutable copy of it.

      Parameters:
      properties - A map of query keys to their associated property sets.
      Throws:
      NullPointerException - if the properties map is null.

  • Method Details

    • builder

      public static <K extends QueryKey<T>, T extends TemporalPointType & QueryablePointType<T>> DefaultProcessingContext.Builder<K,T> builder()
      Creates a new builder for constructing DefaultProcessingContext instances.
      Type Parameters:
      K - The type of query key.
      T - The type of temporal point type.
      Returns:
      A new DefaultProcessingContext.Builder instance.

    • getContextValue

      public <V> Optional<V> getContextValue(K queryKey, Property<V> property)
      Retrieves a property value associated with a specific query key.

      This method allows querying for a property value based on the provided query key and property key.

      Specified by:
      getContextValue in interface ProcessingContext<K extends QueryKey<T>,T extends TemporalPointType & QueryablePointType<T>>
      Type Parameters:
      V - The type of the property value.
      Parameters:
      queryKey - The query key to retrieve the property for.
      property - The property key to identify the desired value.
      Returns:
      An Optional containing the property value if it exists, or an empty Optional if not.

    • 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.

    • properties

      public Map<K,PropertySet> properties()
      Returns the value of the properties record component.
      Returns:
      the value of the properties record component