ResultWriterOptions

java.lang.Object

com.inductiveautomation.historian.common.model.options.ResultWriterOptions

public class ResultWriterOptions extends Object

Represents the options for writing query results.

This class provides configuration for the format and structure of query results, including object types, result formats, and header alias mappings.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ResultWriterOptions.Builder

A builder class for constructing instances of ResultWriterOptions.

static enum

ResultWriterOptions.ObjectType

Enum representing the type of object for the query result.

static enum

ResultWriterOptions.ResultFormat

Enum representing the format of the query result.
Method Summary

Modifier and Type

Method

Description

static ResultWriterOptions.Builder

builder()

Creates a new ResultWriterOptions.Builder instance for constructing ResultWriterOptions.

Map<String,String>

getHeaderAliasMap()

Retrieves the header alias map for the query result.

String

getHeaderAliasOrDefault(String header, String defaultValue)

Retrieves the alias for a given header, using case-insensitive matching.

ResultWriterOptions.ResultFormat

getResultFormat()

Retrieves the format of the query result.

ResultWriterOptions.ObjectType

getResultObjectType()

Retrieves the object type of the query result.

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

Method Details
- getResultObjectType
  
  public ResultWriterOptions.ObjectType getResultObjectType()
  
  Retrieves the object type of the query result.
  
  Returns:
  
  The ResultWriterOptions.ObjectType of the query result.
- getResultFormat
  
  public ResultWriterOptions.ResultFormat getResultFormat()
  
  Retrieves the format of the query result.
  
  Returns:
  
  The ResultWriterOptions.ResultFormat of the query result.
- getHeaderAliasMap
  
  public Map<String,String> getHeaderAliasMap()
  
  Retrieves the header alias map for the query result. Note: Keys in this map are stored in lowercase to support case-insensitive lookups. Consider using getHeaderAliasOrDefault(String, String) for lookups instead.
  
  Returns:
  
  A Map of header aliases, or an empty map if none are defined.
- getHeaderAliasOrDefault
  
  public String getHeaderAliasOrDefault(String header, String defaultValue)
  
  Retrieves the alias for a given header, using case-insensitive matching.
  
  Parameters:
  
  header - The header name to look up.
  
  defaultValue - The value to return if no alias is found.
  
  Returns:
  
  The alias if found, otherwise the default value.
- builder
  
  public static ResultWriterOptions.Builder builder()
  
  Creates a new ResultWriterOptions.Builder instance for constructing ResultWriterOptions.
  
  Returns:
  
  A new ResultWriterOptions.Builder.