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

Class QueryBindingConfig

java.lang.Object

com.inductiveautomation.perspective.common.config.binding.QueryBindingConfig

public class QueryBindingConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	designerUseLimit
final boolean	enableValueCache
final QueryPathMode	mode
final Map<String,String>	parameters
final Map<String,QueryParameterMetadata>	parametersMeta
final PollingConfig	polling
final String	queryPath
final QueryReturnFormat	returnFormat

Constructor Summary

Constructors

Constructor	Description
QueryBindingConfig(String queryPath, QueryPathMode mode, Map<String,String> parameters, Map<String,QueryParameterMetadata> parametersMeta, QueryReturnFormat returnFormat, PollingConfig polling, boolean designerUseLimit, boolean enableValueCache)

Method Summary

Modifier and Type	Method	Description
static QueryBindingConfig	fromJson(com.inductiveautomation.ignition.common.gson.JsonObject object)	Interprets a JsonObject that represents a query binding configuration.
static boolean	readEnableValueCacheSetting(@Nullable com.inductiveautomation.ignition.common.gson.JsonObject object)

Methods inherited from class java.lang.Object

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

Field Details

queryPath

public final String queryPath

mode

public final QueryPathMode mode

returnFormat

public final QueryReturnFormat returnFormat

designerUseLimit

public final boolean designerUseLimit

enableValueCache

public final boolean enableValueCache

polling

public final PollingConfig polling

parameters

public final Map<String,String> parameters

parametersMeta

public final Map<String,QueryParameterMetadata> parametersMeta

Constructor Details

QueryBindingConfig

public QueryBindingConfig(String queryPath,
 QueryPathMode mode,
 Map<String,String> parameters,
 Map<String,QueryParameterMetadata> parametersMeta,
 QueryReturnFormat returnFormat,
 PollingConfig polling,
 boolean designerUseLimit,
 boolean enableValueCache)

Method Details

fromJson

public static QueryBindingConfig fromJson(com.inductiveautomation.ignition.common.gson.JsonObject object)
                                   throws ConfigurationException

Interprets a JsonObject that represents a query binding configuration.

Throws:

ConfigurationException - Will throw if anything in this object is incorrectly typed

readEnableValueCacheSetting

public static boolean readEnableValueCacheSetting(@Nullable com.inductiveautomation.ignition.common.gson.JsonObject object)