com.inductiveautomation.factorypmi.application.gateway

Class NQuery

java.lang.Object

com.inductiveautomation.factorypmi.application.gateway.NQuery

All Implemented Interfaces:

IQuery

public class NQuery
extends java.lang.Object
implements IQuery

Like a SQLQuery, except for named queries. Used by the NamedQueryAdapter and the NamedQueryTagBinding to execute the actual query via RPC and return a dataset of the results.

Constructor Summary

Constructors

Constructor and Description
NQuery(java.lang.String queryPath, java.util.Map<java.lang.String,java.lang.Object> paramValues, VisionClientContext context)

Method Summary

Modifier and Type	Method and Description
Dataset	execute(GatewayInterface ifc) Executes the query and returns a dataset of the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

NQuery

public NQuery(@Nullable
              java.lang.String queryPath,
              @Nullable
              java.util.Map<java.lang.String,java.lang.Object> paramValues,
              @Nonnull
              VisionClientContext context)

Method Detail

execute

public Dataset execute(GatewayInterface ifc)
                throws GatewayException

Executes the query and returns a dataset of the result.

Specified by:

execute in interface IQuery

Parameters:

ifc - Unused, may be null

Returns:

A Dataset of the result (may be empty)

Throws:

GatewayException - If there was an error executing the query, the exception thrown will be converted to a GatewayException