Package com.inductiveautomation.factorypmi.application.binding

Interface Adapter

All Known Subinterfaces:
PropertyAdapter, SearchablePropertyAdapter
All Known Implementing Classes:
AbstractPropertyAdapter, AbstractQueryAdapter, AbstractTagAdapter, ActionAdapter, CellUpdateAdapter, ExpressionPropertyAdapter, ExtensibleBinding, IndirectTagBindingAdapter, IndirectUDTTagAdapter, NamedQueryAdapter, SimpleBoundColorAdapter, SimpleBoundPropertyAdapter, SimpleBoundTagAdapter, SQLPropertyAdapter, TagHistoryAdapter, UDTTagAdapter
public interface Adapter
An adapter is essentially a rider on a component that affects or augments the component's normal behavior in some way. The two common types of adapters are PropertyAdapters and ActionAdapters. PropertyAdapters are associated with one property of the target component, usually setting it to the value of something else.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Adapter.ValueHolder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    connect(VisionClientContext appContext)
    Notifies the adapter that it should connect any listeners that it needs.
    void
    disconnect()
    Notifies the adapter that it should disconnect any listeners.
    InteractionDescriptor[]
    getInteractions()
    Retrieves an array of the interactions that this adapter depends on.
    Component
    getTarget()
    The target component is the component that this adapter serves.
    boolean
    isValid()
    Returns true if this adapter's configuration is valid.
    void
    setTarget(Component c)
     
    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.

  • Method Details

    • startup

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

    • shutdown

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

    • disconnect

      void disconnect()
      Notifies the adapter that it should disconnect any listeners.

    • connect

      void connect(VisionClientContext appContext)
      Notifies the adapter that it should connect any listeners that it needs. Adapters will remain connected throughout their lifetime, even when they are dormant

    • getInteractions

      InteractionDescriptor[] getInteractions()
      Retrieves an array of the interactions that this adapter depends on. An interaction descriptor describes an inter-component interaction.

    • getTarget

      Component getTarget()
      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.

    • setTarget

      void setTarget(Component c)

    • isValid

      boolean isValid()
      Returns true if this adapter's configuration is valid. This somewhat of a hack, to detect if something has gone wrong with the adapter (due do serialization, we think?)