com.inductiveautomation.factorypmi.application.binding

Class TagHistoryAdapter

java.lang.Object

com.inductiveautomation.factorypmi.application.binding.AbstractPropertyAdapter

com.inductiveautomation.factorypmi.application.binding.AbstractQueryAdapter

com.inductiveautomation.factorypmi.application.binding.TagHistoryAdapter

All Implemented Interfaces:

Adapter, Adapter.ValueHolder, SearchablePropertyAdapter, PropertyAdapter, IQueryResponseListener, InteractionListener

public class TagHistoryAdapter
extends AbstractQueryAdapter
implements IQueryResponseListener, InteractionListener, SearchablePropertyAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TagHistoryAdapter.HistoricalTagPath
static class	TagHistoryAdapter.RangeMode
static class	TagHistoryAdapter.ReturnMode

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.PropertyAdapter

PropertyAdapter.PAType

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

Adapter.ValueHolder

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
TagHistoryAdapter()

Method Summary

Modifier and Type	Method and Description
void	childInteractionUpdated()
AggregationMode	getAggregationMode()
BindingConfiguration	getBindingConfiguration()
PropertyListenerDescriptor	getEndDateListener()
InteractionDescriptor[]	getInteractions() Retrieves an array of the interactions that this adapter depends on.
PropertyListenerDescriptor	getIntervalLengthListener()
java.lang.Integer	getIntervalLengthLiteral()
TimeUnits	getIntervalUnits()
java.util.List<TagHistoryAdapter.HistoricalTagPath>	getPathList()
Flags	getQueryFlags()
PropertyListenerDescriptor	getRangeLengthListener()
java.lang.Integer	getRangeLengthLiteral()
TagHistoryAdapter.RangeMode	getRangeMode()
TimeUnits	getRangeUnit()
java.util.Map<java.lang.Integer,PropertyListenerDescriptor>	getReferences()
PropertyAdapter.PAType	getReferenceType()
ReturnFormat	getReturnFormat()
TagHistoryAdapter.ReturnMode	getReturnMode()
PropertyListenerDescriptor	getReturnSizeListener()
java.lang.Integer	getReturnSizeLiteral()
PropertyListenerDescriptor	getStartDateListener()
void	handleQueryReturnedError(java.lang.Exception error)
void	handleQueryReturnedNoRows()
void	handleQueryReturnedValue(java.lang.Object value)
void	notifyQueryRunning(boolean loading)
protected java.lang.Object	registerQuery(int updateRate, boolean runOnce)
void	setAggregationMode(AggregationMode aggregationMode)
void	setEndDateListener(PropertyListenerDescriptor endDateListener)
void	setIntervalLengthListener(PropertyListenerDescriptor intervalLengthListener)
void	setIntervalLengthLiteral(java.lang.Integer intervalLengthLiteral)
void	setIntervalUnits(TimeUnits intervalUnits)
void	setPathList(java.util.List<TagHistoryAdapter.HistoricalTagPath> paths)
void	setPaths(java.util.List<IndirectTagBindingAdapter.IndirectTagPathNode[]> paths) Deprecated.
void	setQueryFlags(Flags queryFlags)
void	setRangeLengthListener(PropertyListenerDescriptor rangeLengthListener)
void	setRangeLengthLiteral(java.lang.Integer rangeLengthLiteral)
void	setRangeMode(TagHistoryAdapter.RangeMode rangeMode)
void	setRangeUnit(TimeUnits rangeUnit)
void	setReferences(java.util.Map<java.lang.Integer,PropertyListenerDescriptor> references)
void	setReturnFormat(ReturnFormat format)
void	setReturnMode(TagHistoryAdapter.ReturnMode returnMode)
void	setReturnSize(int i) Deprecated.
void	setReturnSizeListener(PropertyListenerDescriptor returnSizeListener)
void	setReturnSizeLiteral(java.lang.Integer returnSize)
void	setStartDateListener(PropertyListenerDescriptor startDateListener)
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, connect, disconnect, getQValue, getTarget, getTargetDesc, getTargetFullPath, getTargetPropertyName, getValueClass, handleError, handleNullToPrimitive, initLogger, isDataUsed, isDataUsed, isOverlayOptOut, isTargetPropertyDynamic, isValid, 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.gateway.IQueryResponseListener

getTargetFullPath

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

getTargetPropertyName, setTargetPropertyName

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

connect, disconnect, getTarget, isValid, setTarget

Constructor Detail

TagHistoryAdapter

public TagHistoryAdapter()

Method Detail

getBindingConfiguration

public BindingConfiguration getBindingConfiguration()

Specified by:

getBindingConfiguration in interface SearchablePropertyAdapter

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

registerQuery

protected java.lang.Object registerQuery(int updateRate,
                                         boolean runOnce)

Specified by:

registerQuery in class AbstractQueryAdapter

notifyQueryRunning

public void notifyQueryRunning(boolean loading)

Specified by:

notifyQueryRunning in interface IQueryResponseListener

handleQueryReturnedValue

public void handleQueryReturnedValue(java.lang.Object value)

Specified by:

handleQueryReturnedValue in interface IQueryResponseListener

handleQueryReturnedError

public void handleQueryReturnedError(java.lang.Exception error)

Specified by:

handleQueryReturnedError in interface IQueryResponseListener

handleQueryReturnedNoRows

public void handleQueryReturnedNoRows()

Specified by:

handleQueryReturnedNoRows in interface IQueryResponseListener

childInteractionUpdated

public void childInteractionUpdated()

Specified by:

childInteractionUpdated in interface InteractionListener

getReferenceType

public PropertyAdapter.PAType getReferenceType()

Specified by:

getReferenceType in interface PropertyAdapter

getReferences

public java.util.Map<java.lang.Integer,PropertyListenerDescriptor> getReferences()

setReferences

public void setReferences(java.util.Map<java.lang.Integer,PropertyListenerDescriptor> references)

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

Returns:

getPathList

public java.util.List<TagHistoryAdapter.HistoricalTagPath> getPathList()

setPathList

public void setPathList(java.util.List<TagHistoryAdapter.HistoricalTagPath> paths)

getQueryFlags

public Flags getQueryFlags()

setQueryFlags

public void setQueryFlags(Flags queryFlags)

setPaths

@Deprecated
public void setPaths(java.util.List<IndirectTagBindingAdapter.IndirectTagPathNode[]> paths)

Deprecated.

getStartDateListener

public PropertyListenerDescriptor getStartDateListener()

setStartDateListener

public void setStartDateListener(PropertyListenerDescriptor startDateListener)

getEndDateListener

public PropertyListenerDescriptor getEndDateListener()

setEndDateListener

public void setEndDateListener(PropertyListenerDescriptor endDateListener)

getRangeMode

public TagHistoryAdapter.RangeMode getRangeMode()

setRangeMode

public void setRangeMode(TagHistoryAdapter.RangeMode rangeMode)

getRangeUnit

public TimeUnits getRangeUnit()

setRangeUnit

public void setRangeUnit(TimeUnits rangeUnit)

getRangeLengthLiteral

public java.lang.Integer getRangeLengthLiteral()

setRangeLengthLiteral

public void setRangeLengthLiteral(java.lang.Integer rangeLengthLiteral)

getRangeLengthListener

public PropertyListenerDescriptor getRangeLengthListener()

setRangeLengthListener

public void setRangeLengthListener(PropertyListenerDescriptor rangeLengthListener)

getIntervalUnits

public TimeUnits getIntervalUnits()

setIntervalUnits

public void setIntervalUnits(TimeUnits intervalUnits)

getIntervalLengthListener

public PropertyListenerDescriptor getIntervalLengthListener()

setIntervalLengthListener

public void setIntervalLengthListener(PropertyListenerDescriptor intervalLengthListener)

getReturnSizeListener

public PropertyListenerDescriptor getReturnSizeListener()

setReturnSizeListener

public void setReturnSizeListener(PropertyListenerDescriptor returnSizeListener)

getReturnMode

public TagHistoryAdapter.ReturnMode getReturnMode()

getIntervalLengthLiteral

public java.lang.Integer getIntervalLengthLiteral()

setIntervalLengthLiteral

public void setIntervalLengthLiteral(java.lang.Integer intervalLengthLiteral)

setReturnMode

public void setReturnMode(TagHistoryAdapter.ReturnMode returnMode)

getReturnSizeLiteral

public java.lang.Integer getReturnSizeLiteral()

setReturnSizeLiteral

public void setReturnSizeLiteral(java.lang.Integer returnSize)

setReturnSize

@Deprecated
public void setReturnSize(int i)

Deprecated.

For backwards compatibility

Parameters:

i -

getAggregationMode

public AggregationMode getAggregationMode()

setAggregationMode

public void setAggregationMode(AggregationMode aggregationMode)

getReturnFormat

public ReturnFormat getReturnFormat()

setReturnFormat

public void setReturnFormat(ReturnFormat format)