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
,java.beans.PropertyChangeListener
,java.util.EventListener
public class NamedQueryAdapter extends AbstractQueryAdapter implements SearchablePropertyAdapter, IQueryResponseListener, java.beans.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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
connect(VisionClientContext appContext)
Calls connect() on all interaction descriptorsvoid
disconnect()
Calls disconnect() on all interaction descriptorsBindingConfiguration
getBindingConfiguration()
java.lang.String
getEffectivePushPath()
Convenience method taking into account the legacy push path fieldInteractionDescriptor[]
getInteractions()
Retrieves an array of the interactions that this adapter depends on.java.util.Map<java.lang.String,java.lang.Object>
getPullArguments()
java.util.Map<java.lang.String,java.lang.Object>
getPullArgumentsUnbound()
java.util.Map<java.lang.String,BoundValueHolder>
getPullBoundArguments()
java.lang.String
getPullPath()
java.util.Map<java.lang.String,java.lang.Object>
getPushArguments()
java.util.Map<java.lang.String,java.lang.Object>
getPushArgumentsUnbound()
java.util.Map<java.lang.String,BoundValueHolder>
getPushBoundArguments()
java.lang.String
getPushPath()
Deprecated.Kept for backwards compatibility.java.lang.String
getPushPath2()
PropertyAdapter.PAType
getReferenceType()
void
handleQueryReturnedError(java.lang.Exception error)
void
handleQueryReturnedNoRows()
void
handleQueryReturnedValue(java.lang.Object value)
boolean
isPushEnabled()
void
notifyQueryRunning(boolean loading)
void
propertyChange(java.beans.PropertyChangeEvent evt)
protected java.lang.Object
registerQuery(int updateRate, boolean runOnce)
void
setPullArguments(java.util.Map<java.lang.String,java.lang.Object> pullArguments)
void
setPullBoundArguments(java.util.Map<java.lang.String,BoundValueHolder> pullBoundArguments)
void
setPullPath(java.lang.String pullPath)
void
setPushArguments(java.util.Map<java.lang.String,java.lang.Object> pushArguments)
void
setPushBoundArguments(java.util.Map<java.lang.String,BoundValueHolder> pushBoundArguments)
void
setPushEnabled(boolean pushEnabled)
void
setPushPath(java.lang.String pushPath)
Deprecated.Kept for backwards compatibility.void
setPushPath2(java.lang.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
canUpdate, 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
-
-
-
-
Method Detail
-
getBindingConfiguration
public BindingConfiguration getBindingConfiguration()
- Specified by:
getBindingConfiguration
in interfaceSearchablePropertyAdapter
-
getReferenceType
public PropertyAdapter.PAType getReferenceType()
- Specified by:
getReferenceType
in interfacePropertyAdapter
-
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 interfaceAdapter
-
getPullPath
public java.lang.String getPullPath()
-
setPullPath
public void setPullPath(java.lang.String pullPath)
-
getPushPath
@Deprecated public java.lang.String getPushPath()
Deprecated.Kept for backwards compatibility. UsegetPushPath2()
-
setPushPath
@Deprecated public void setPushPath(java.lang.String pushPath)
Deprecated.Kept for backwards compatibility. UsesetPushPath2(String)
-
getPushPath2
public java.lang.String getPushPath2()
-
setPushPath2
public void setPushPath2(java.lang.String pushPath2)
-
getEffectivePushPath
public java.lang.String getEffectivePushPath()
Convenience method taking into account the legacy push path field- Returns:
- The effective push path
-
getPullArguments
public java.util.Map<java.lang.String,java.lang.Object> getPullArguments()
-
setPullArguments
public void setPullArguments(java.util.Map<java.lang.String,java.lang.Object> pullArguments)
-
getPullBoundArguments
public java.util.Map<java.lang.String,BoundValueHolder> getPullBoundArguments()
-
getPushBoundArguments
public java.util.Map<java.lang.String,BoundValueHolder> getPushBoundArguments()
-
setPushBoundArguments
public void setPushBoundArguments(java.util.Map<java.lang.String,BoundValueHolder> pushBoundArguments)
-
getPushArguments
public java.util.Map<java.lang.String,java.lang.Object> getPushArguments()
-
setPushArguments
public void setPushArguments(java.util.Map<java.lang.String,java.lang.Object> pushArguments)
-
isPushEnabled
public boolean isPushEnabled()
-
setPushEnabled
public void setPushEnabled(boolean pushEnabled)
-
getPullArgumentsUnbound
public java.util.Map<java.lang.String,java.lang.Object> getPullArgumentsUnbound()
- Returns:
- all arguments, where the bound arguments are their binding string representation
-
getPushArgumentsUnbound
public java.util.Map<java.lang.String,java.lang.Object> getPushArgumentsUnbound()
-
setPullBoundArguments
public void setPullBoundArguments(java.util.Map<java.lang.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 interfaceAdapter
- Overrides:
startup
in classAbstractPropertyAdapter
-
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 interfaceAdapter
- Overrides:
shutdown
in classAbstractPropertyAdapter
-
connect
public void connect(VisionClientContext appContext)
Description copied from class:AbstractPropertyAdapter
Calls connect() on all interaction descriptors- Specified by:
connect
in interfaceAdapter
- Overrides:
connect
in classAbstractPropertyAdapter
-
disconnect
public void disconnect()
Description copied from class:AbstractPropertyAdapter
Calls disconnect() on all interaction descriptors- Specified by:
disconnect
in interfaceAdapter
- Overrides:
disconnect
in classAbstractPropertyAdapter
-
registerQuery
protected java.lang.Object registerQuery(int updateRate, boolean runOnce)
- Specified by:
registerQuery
in classAbstractQueryAdapter
-
handleQueryReturnedValue
public void handleQueryReturnedValue(java.lang.Object value)
- Specified by:
handleQueryReturnedValue
in interfaceIQueryResponseListener
-
handleQueryReturnedNoRows
public void handleQueryReturnedNoRows()
- Specified by:
handleQueryReturnedNoRows
in interfaceIQueryResponseListener
-
handleQueryReturnedError
public void handleQueryReturnedError(java.lang.Exception error)
- Specified by:
handleQueryReturnedError
in interfaceIQueryResponseListener
-
notifyQueryRunning
public void notifyQueryRunning(boolean loading)
- Specified by:
notifyQueryRunning
in interfaceIQueryResponseListener
-
propertyChange
public void propertyChange(java.beans.PropertyChangeEvent evt)
- Specified by:
propertyChange
in interfacejava.beans.PropertyChangeListener
-
-