Package com.inductiveautomation.factorypmi.application.binding

Class AbstractPropertyAdapter

    • Field Detail

      • target

        protected java.awt.Component target

      • targetPropertyName

        protected java.lang.String targetPropertyName

      • valueClass

        protected java.lang.Class valueClass

      • isTargetPropertyDynamic

        protected boolean isTargetPropertyDynamic

      • overlayOptOut

        protected boolean overlayOptOut
        Overlay opt out notifies the adapter that this binding's quality shouldn't affect the overlay system

    • Constructor Detail

      • AbstractPropertyAdapter

        protected AbstractPropertyAdapter()

    • Method Detail

      • isDataUsed

        public static boolean isDataUsed​(QualifiedValue qv,
                                 java.lang.Class<?> targetType)
        Returns whether or not the data portion of the qualified value should be used, or whether only the quality portion should be used instead.

      • isDataUsed

        protected boolean isDataUsed​(QualifiedValue qv)
        Returns whether or not the data portion of the qualified value should be used, or whether only the quality portion should be used instead.

      • initLogger

        protected LoggerEx initLogger()

      • 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

      • 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

      • disconnect

        public void disconnect()
        Calls disconnect() on all interaction descriptors
        Specified by:
        disconnect in interface Adapter

      • getTargetDesc

        protected java.lang.String getTargetDesc()

      • isValid

        public boolean isValid()
        Returns true if the target isn't null and the target has a parent.
        Specified by:
        isValid in interface Adapter

      • getTargetFullPath

        public java.lang.String getTargetFullPath()
        Returns the full path to the target component

      • getTarget

        public java.awt.Component getTarget()
        Description copied from interface: Adapter
        The target component is the component that this adapter serves. This means it is the target of a property adapter or the source of events for an action adapter.
        Specified by:
        getTarget in interface Adapter

      • setTarget

        public void setTarget​(java.awt.Component component)
        Specified by:
        setTarget in interface Adapter

      • setSetterMethodName

        @Deprecated
public void setSetterMethodName​(java.lang.String string)
        Deprecated.
        This is no longer used, but is here for serialization. The setter is now looked up dynamically based on the target property name.

      • setValue

        @Deprecated
public void setValue​(java.lang.Object value)
        Deprecated.
        Use setQValue() instead. Kept for serialization.

      • setQValue

        public void setQValue​(QualifiedValue qualifiedValue)
        Sets this adapter's value. Doesn't push the value to the target or update the quality if the target is a quality monitor. For that, use updateValue()
        Specified by:
        setQValue in interface Adapter.ValueHolder

      • updateQuality

        protected void updateQuality​(QualityCode quality)

      • useQuality

        protected boolean useQuality()
        Called to determine whether or not to push qualities to the target. Default implementation is: 

         return !isOverlayOptOut() && target instanceof QualityMonitor;

        If overridden, make sure that you AND-in super().

      • updateValue

        protected void updateValue​(QualifiedValue qv)
        Sets the property adapter value to the given QualifiedValue, and updates the data quality, then calls updateTarget().

        This function is Non-EDT safe. It will re-call itself on the EDT if not called on EDT.

      • updateTarget

        protected void updateTarget()
        Sets the target property to the value. If a problem occurs, the problem is displayed, not thrown. Note that updateValue() is probably a better bet, as it updates both value and quality.

      • handleNullToPrimitive

        protected void handleNullToPrimitive()

      • handleError

        protected void handleError​(java.lang.Exception ex,
                           QualityCode quality)

      • isValueClassPrimitive

        protected boolean isValueClassPrimitive()

      • getValueClass

        public java.lang.Class getValueClass()

      • setValueClass

        public void setValueClass​(java.lang.Class class1)

      • isTargetPropertyDynamic

        public boolean isTargetPropertyDynamic()

      • setTargetPropertyDynamic

        public void setTargetPropertyDynamic​(boolean b)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isOverlayOptOut

        public boolean isOverlayOptOut()

      • setOverlayOptOut

        public void setOverlayOptOut​(boolean overlayOptOut)