Package com.inductiveautomation.historian.common.model.options

Class ResultWriterOptions.Builder

java.lang.Object

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

Enclosing class:

ResultWriterOptions

public static class ResultWriterOptions.Builder
extends Object

A builder class for constructing instances of ResultWriterOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ResultWriterOptions.Builder	addHeaderAlias(String header, String alias)	Adds a header alias to the query result.
ResultWriterOptions.Builder	addHeaderAliases(Map<String,String> aliases)	Adds multiple header aliases to the query result.
ResultWriterOptions	build()	Builds and returns a new ResultWriterOptions instance.
ResultWriterOptions.Builder	objectType(ResultWriterOptions.ObjectType objectType)	Sets the object type for the query result.
ResultWriterOptions.Builder	objectType(String resultType)	Sets the object type for the query result using a string.
ResultWriterOptions.Builder	resultFormat(ResultWriterOptions.ResultFormat resultFormat)	Sets the format of the query result.
ResultWriterOptions.Builder	resultFormat(String resultFormat)	Sets the format of the query result using a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

objectType

public ResultWriterOptions.Builder objectType(ResultWriterOptions.ObjectType objectType)

Sets the object type for the query result.

Parameters:

objectType - The ResultWriterOptions.ObjectType to set.

Returns:

This Builder instance for method chaining.

objectType

public ResultWriterOptions.Builder objectType(String resultType)

Sets the object type for the query result using a string.

Parameters:

resultType - The string representation of the object type.

Returns:

This Builder instance for method chaining.

resultFormat

public ResultWriterOptions.Builder resultFormat(ResultWriterOptions.ResultFormat resultFormat)

Sets the format of the query result.

Parameters:

resultFormat - The ResultWriterOptions.ResultFormat to set.

Returns:

This Builder instance for method chaining.

resultFormat

public ResultWriterOptions.Builder resultFormat(String resultFormat)

Sets the format of the query result using a string.

Parameters:

resultFormat - The string representation of the result format.

Returns:

This Builder instance for method chaining.

addHeaderAlias

public ResultWriterOptions.Builder addHeaderAlias(String header,
 String alias)

Adds a header alias to the query result.

Parameters:

header - The original header name.

alias - The alias for the header.

Returns:

This Builder instance for method chaining.

addHeaderAliases

public ResultWriterOptions.Builder addHeaderAliases(Map<String,String> aliases)

Adds multiple header aliases to the query result.

Parameters:

aliases - A Map of header names to aliases.

Returns:

This Builder instance for method chaining.

build

public ResultWriterOptions build()

Builds and returns a new ResultWriterOptions instance.

Returns:

A new ResultWriterOptions.

Throws:

IllegalArgumentException - if the object type is RAW and the result format is not NONE.