Package com.inductiveautomation.perspective.common.config.binding

Record Class QueryParameterMetadata

java.lang.Object
java.lang.Record
com.inductiveautomation.perspective.common.config.binding.QueryParameterMetadata
Record Components:
type - The parameter type (e.g., "Parameter", "In", "Out", "InOut")
datatype - The datatype (e.g., "String", "Int4", "Boolean")
public record QueryParameterMetadata(String type, String datatype) extends Record
Represents parameter metadata (type and datatype) for query binding parameters. This record is used to persist and restore parameter configuration details for expression mode query bindings. The actual parameter name and value are stored separately in the parameters map.

  • Constructor Summary

    Constructors
    Constructor
    Description
    QueryParameterMetadata(String type, String datatype)
    Creates an instance of a QueryParameterMetadata record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    datatype()
    Returns the value of the datatype record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @Nullable QueryParameterMetadata
    fromJson(@Nullable com.inductiveautomation.ignition.common.gson.JsonObject json)
    Creates parameter metadata from JSON.
    final int
    hashCode()
    Returns a hash code value for this object.
    com.inductiveautomation.ignition.common.gson.JsonObject
    toJson()
    Converts this parameter metadata to JSON format.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • QueryParameterMetadata

      public QueryParameterMetadata(String type, String datatype)
      Creates an instance of a QueryParameterMetadata record class.
      Parameters:
      type - the value for the type record component
      datatype - the value for the datatype record component

  • Method Details

    • fromJson

      public static @Nullable QueryParameterMetadata fromJson(@Nullable com.inductiveautomation.ignition.common.gson.JsonObject json)
      Creates parameter metadata from JSON.
      Parameters:
      json - The JSON object containing parameter metadata
      Returns:
      A QueryParameterMetadata instance, or null if JSON is invalid

    • toJson

      public com.inductiveautomation.ignition.common.gson.JsonObject toJson()
      Converts this parameter metadata to JSON format.
      Returns:
      A JsonObject representing this parameter metadata

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

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • datatype

      public String datatype()
      Returns the value of the datatype record component.
      Returns:
      the value of the datatype record component