Package com.inductiveautomation.factorypmi.application.binding

Class NamedQueryAdapter

java.lang.Object

com.inductiveautomation.factorypmi.application.binding.AbstractPropertyAdapter

com.inductiveautomation.factorypmi.application.binding.AbstractQueryAdapter

com.inductiveautomation.factorypmi.application.binding.NamedQueryAdapter

All Implemented Interfaces:

Adapter, Adapter.ValueHolder, SearchablePropertyAdapter, PropertyAdapter, IQueryResponseListener, PropertyChangeListener, EventListener

public class NamedQueryAdapter
extends AbstractQueryAdapter
implements SearchablePropertyAdapter, IQueryResponseListener, PropertyChangeListener

Hooks into the QueryManager for polling

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.factorypmi.application.binding.AbstractPropertyAdapter

AbstractPropertyAdapter.EdtUpdateValue

Nested classes/interfaces inherited from interface com.inductiveautomation.factorypmi.application.binding.Adapter

Adapter.ValueHolder

Nested classes/interfaces inherited from interface com.inductiveautomation.factorypmi.application.binding.PropertyAdapter

PropertyAdapter.PAType

Field Summary

Fields inherited from class com.inductiveautomation.factorypmi.application.binding.AbstractPropertyAdapter

appContext, isTargetPropertyDynamic, log, overlayOptOut, target, targetPropertyName, value, valueClass

Constructor Summary

Constructors

Constructor	Description
NamedQueryAdapter()

Method Summary

Modifier and Type	Method	Description
void	connect(VisionClientContext appContext)	Calls connect() on all interaction descriptors
void	disconnect()	Calls disconnect() on all interaction descriptors
BindingConfiguration	getBindingConfiguration()
String	getEffectivePushPath()	Convenience method taking into account the legacy push path field
InteractionDescriptor[]	getInteractions()	Retrieves an array of the interactions that this adapter depends on.
Map<String,Object>	getPullArguments()
Map<String,Object>	getPullArgumentsUnbound()
Map<String,BoundValueHolder>	getPullBoundArguments()
String	getPullPath()
Map<String,Object>	getPushArguments()
Map<String,Object>	getPushArgumentsUnbound()
Map<String,BoundValueHolder>	getPushBoundArguments()
String	getPushPath()	Deprecated. Kept for backwards compatibility.
String	getPushPath2()
PropertyAdapter.PAType	getReferenceType()
void	handleQueryReturnedError(Exception error)
void	handleQueryReturnedNoRows()
void	handleQueryReturnedValue(Object value)
boolean	isPushEnabled()
void	notifyQueryRunning(boolean loading)
void	propertyChange(PropertyChangeEvent evt)
protected Object	registerQuery(int updateRate, boolean runOnce)
void	setPullArguments(Map<String,Object> pullArguments)
void	setPullBoundArguments(Map<String,BoundValueHolder> pullBoundArguments)
void	setPullPath(String pullPath)
void	setPushArguments(Map<String,Object> pushArguments)
void	setPushBoundArguments(Map<String,BoundValueHolder> pushBoundArguments)
void	setPushEnabled(boolean pushEnabled)
void	setPushPath(String pushPath)	Deprecated. Kept for backwards compatibility.
void	setPushPath2(String pushPath2)
void	shutdown()	Notifies the adapter that it is becoming inactive, and should cease any polling/threaded activities.
void	startup()	Notifies the adapter that it is becoming active, and should start any polling/threaded activities.

Methods inherited from class com.inductiveautomation.factorypmi.application.binding.AbstractQueryAdapter

getPollingConfig, getPollingMode, getUpdateRate, isSerializableDataset, restartQuery, setPollingMode, setQValue, setSerializableDataset, setUpdateRate, shutdownQuery, startupQuery

Methods inherited from class com.inductiveautomation.factorypmi.application.binding.AbstractPropertyAdapter

getQValue, getTarget, getTargetDesc, getTargetFullPath, getTargetPropertyName, getValueClass, handleError, handleNullToPrimitive, initLogger, isDataUsed, isDataUsed, isOverlayOptOut, isTargetPropertyDynamic, isValid, isValueClassPrimitive, setOverlayOptOut, setSetterMethodName, setTarget, setTargetPropertyDynamic, setTargetPropertyName, setValue, setValueClass, toString, updateQuality, updateTarget, updateValue, useQuality

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.factorypmi.application.binding.Adapter

getTarget, isValid, setTarget

Methods inherited from interface com.inductiveautomation.factorypmi.application.gateway.IQueryResponseListener

getTargetFullPath

Methods inherited from interface com.inductiveautomation.factorypmi.application.binding.PropertyAdapter

getTargetPropertyName, setTargetPropertyName

Constructor Details

NamedQueryAdapter

public NamedQueryAdapter()

Method Details

getBindingConfiguration

public BindingConfiguration getBindingConfiguration()

Specified by:

getBindingConfiguration in interface SearchablePropertyAdapter

getReferenceType

public PropertyAdapter.PAType getReferenceType()

Specified by:

getReferenceType in interface PropertyAdapter

getInteractions

public InteractionDescriptor[] getInteractions()

Description copied from interface: Adapter

Retrieves an array of the interactions that this adapter depends on. An interaction descriptor describes an inter-component interaction.

Specified by:

getInteractions in interface Adapter

getPullPath

public String getPullPath()

setPullPath

public void setPullPath(String pullPath)

getPushPath

@Deprecated
public String getPushPath()

Deprecated.

Kept for backwards compatibility. Use getPushPath2()

setPushPath

@Deprecated
public void setPushPath(String pushPath)

Deprecated.

Kept for backwards compatibility. Use setPushPath2(String)

getPushPath2

public String getPushPath2()

setPushPath2

public void setPushPath2(String pushPath2)

getEffectivePushPath

public String getEffectivePushPath()

Convenience method taking into account the legacy push path field

Returns:

The effective push path

getPullArguments

public Map<String,Object> getPullArguments()

setPullArguments

public void setPullArguments(Map<String,Object> pullArguments)

getPullBoundArguments

public Map<String,BoundValueHolder> getPullBoundArguments()

getPushBoundArguments

public Map<String,BoundValueHolder> getPushBoundArguments()

setPushBoundArguments

public void setPushBoundArguments(Map<String,BoundValueHolder> pushBoundArguments)

getPushArguments

public Map<String,Object> getPushArguments()

setPushArguments

public void setPushArguments(Map<String,Object> pushArguments)

isPushEnabled

public boolean isPushEnabled()

setPushEnabled

public void setPushEnabled(boolean pushEnabled)

getPullArgumentsUnbound

public Map<String,Object> getPullArgumentsUnbound()

Returns:

all arguments, where the bound arguments are their binding string representation

getPushArgumentsUnbound

public Map<String,Object> getPushArgumentsUnbound()

setPullBoundArguments

public void setPullBoundArguments(Map<String,BoundValueHolder> pullBoundArguments)

Parameters:

pullBoundArguments - the query's bound parameters, already parsed

startup

public void startup()

Description copied from interface: Adapter

Notifies the adapter that it is becoming active, and should start any polling/threaded activities.

Specified by:

startup in interface Adapter

Overrides:

startup in class AbstractPropertyAdapter

shutdown

public void shutdown()

Description copied from interface: Adapter

Notifies the adapter that it is becoming inactive, and should cease any polling/threaded activities.

Specified by:

shutdown in interface Adapter

Overrides:

shutdown in class AbstractPropertyAdapter

connect

public void connect(VisionClientContext appContext)

Description copied from class: AbstractPropertyAdapter

Calls connect() on all interaction descriptors

Specified by:

connect in interface Adapter

Overrides:

connect in class AbstractPropertyAdapter

disconnect

public void disconnect()

Description copied from class: AbstractPropertyAdapter

Calls disconnect() on all interaction descriptors

Specified by:

disconnect in interface Adapter

Overrides:

disconnect in class AbstractPropertyAdapter

registerQuery

protected Object registerQuery(int updateRate,
 boolean runOnce)

Specified by:

registerQuery in class AbstractQueryAdapter

handleQueryReturnedValue

public void handleQueryReturnedValue(Object value)

Specified by:

handleQueryReturnedValue in interface IQueryResponseListener

handleQueryReturnedNoRows

public void handleQueryReturnedNoRows()

Specified by:

handleQueryReturnedNoRows in interface IQueryResponseListener

handleQueryReturnedError

public void handleQueryReturnedError(Exception error)

Specified by:

handleQueryReturnedError in interface IQueryResponseListener

notifyQueryRunning

public void notifyQueryRunning(boolean loading)

Specified by:

notifyQueryRunning in interface IQueryResponseListener

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener