Package com.inductiveautomation.ignition.common.script.adapters

Class PyDocumentObjectAdapter

java.lang.Object
org.python.core.PyObject
com.inductiveautomation.ignition.common.script.adapters.PyDocumentObjectAdapter
All Implemented Interfaces:
Serializable
public class PyDocumentObjectAdapter extends org.python.core.PyObject
A Jython wrapper for Ignition Document objects. It provides a dictionary-like interface in Python, allowing access to document fields via attributes or item lookups.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.python.core.PyObject

    org.python.core.PyObject.ConversionException

  • Field Summary

    Fields inherited from class org.python.core.PyObject

    attributes, gcMonitorGlobal, objtype, TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    PyDocumentObjectAdapter(Document object)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    __contains__(org.python.core.PyObject o)
     
    org.python.core.PyObject
    __findattr_ex__(String name)
     
    org.python.core.PyObject
    __finditem__(org.python.core.PyObject key)
     
    org.python.core.PyObject
    __iter__()
    Returns an iterator over the document's keys.
    org.python.core.PyObject
    get(org.python.core.PyObject key, org.python.core.PyObject defaultValue)
    Implementation of Python's dict.get(key, default).
    org.python.core.PyList
    items()
     
    org.python.core.PyObject
    iteritems()
    Returns an iterator yielding (key, value) tuples.
    org.python.core.PyObject
    iterkeys()
    Returns an iterator over the document's keys.
    org.python.core.PyObject
    itervalues()
    Returns an iterator over the document's values.
    org.python.core.PyList
    keys()
     
    org.python.core.PyObject
    toDict()
    Recursively converts this document and all its children into native Python PyDictionary and PyList objects.
    String
    toString()
     
    org.python.core.PyList
    values()
     

    Methods inherited from class org.python.core.PyObject

    __abs__, __add__, __and__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __cmp__, __coerce__, __coerce_ex__, __complex__, __delattr__, __delattr__, __delete__, __delitem__, __delitem__, __delslice__, __delslice__, __dir__, __div__, __divmod__, __ensure_finalizer__, __eq__, __findattr__, __findattr__, __finditem__, __finditem__, __float__, __floordiv__, __format__, __ge__, __get__, __getattr__, __getattr__, __getitem__, __getitem__, __getnewargs__, __getslice__, __getslice__, __gt__, __hash__, __hex__, __iadd__, __iand__, __idiv__, __idivmod__, __ifloordiv__, __ilshift__, __imod__, __imul__, __index__, __int__, __invert__, __ior__, __ipow__, __irshift__, __isub__, __iternext__, __itruediv__, __ixor__, __le__, __len__, __long__, __lshift__, __lt__, __mod__, __mul__, __ne__, __neg__, __nonzero__, __not__, __oct__, __or__, __pos__, __pow__, __pow__, __radd__, __rand__, __rawdir__, __rdiv__, __rdivmod__, __reduce__, __reduce_ex__, __reduce_ex__, __repr__, __rfloordiv__, __rlshift__, __rmod__, __rmul__, __ror__, __rpow__, __rrshift__, __rshift__, __rsub__, __rtruediv__, __rxor__, __set__, __setattr__, __setattr__, __setitem__, __setitem__, __setitem__, __setslice__, __setslice__, __str__, __sub__, __tojava__, __truediv__, __trunc__, __unicode__, __xor__, _add, _and, _callextra, _cmp, _div, _divmod, _doget, _doget, _doset, _eq, _floordiv, _ge, _gt, _iadd, _iand, _idiv, _idivmod, _ifloordiv, _ilshift, _imod, _imul, _in, _ior, _ipow, _irshift, _is, _isnot, _isub, _itruediv, _ixor, _jcall, _jcallexc, _jthrow, _le, _lshift, _lt, _mod, _mul, _ne, _notin, _or, _pow, _rshift, _sub, _truediv, _unsupportedop, _xor, adaptToCoerceTuple, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, dispatch__init__, equals, fastGetClass, fastGetDict, finalize, getDict, getJavaProxy, getType, hashCode, impAttr, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, isMappingType, isNumberType, isSequenceType, mergeClassDict, mergeDictAttr, mergeListAttr, noAttributeError, object___subclasshook__, readonlyAttributeError, runsupportedopMessage, setDict, setType, unsupportedopMessage

    Methods inherited from class java.lang.Object

    clone, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PyDocumentObjectAdapter

      public PyDocumentObjectAdapter(Document object)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class org.python.core.PyObject

    • __iter__

      public org.python.core.PyObject __iter__()
      Returns an iterator over the document's keys.
      Overrides:
      __iter__ in class org.python.core.PyObject

    • iterkeys

      public org.python.core.PyObject iterkeys()
      Returns an iterator over the document's keys.

    • iteritems

      public org.python.core.PyObject iteritems()
      Returns an iterator yielding (key, value) tuples.

    • itervalues

      public org.python.core.PyObject itervalues()
      Returns an iterator over the document's values.

    • __contains__

      public boolean __contains__(org.python.core.PyObject o)
      Overrides:
      __contains__ in class org.python.core.PyObject

    • items

      public org.python.core.PyList items()

    • keys

      public org.python.core.PyList keys()

    • values

      public org.python.core.PyList values()

    • get

      public org.python.core.PyObject get(org.python.core.PyObject key, org.python.core.PyObject defaultValue)
      Implementation of Python's dict.get(key, default).
      Parameters:
      key - The key to look up.
      defaultValue - The value to return if the key is not present.
      Returns:
      The value for the key, or defaultValue.

    • __findattr_ex__

      public org.python.core.PyObject __findattr_ex__(String name)
      Overrides:
      __findattr_ex__ in class org.python.core.PyObject

    • __finditem__

      public org.python.core.PyObject __finditem__(org.python.core.PyObject key)
      Overrides:
      __finditem__ in class org.python.core.PyObject

    • toDict

      public org.python.core.PyObject toDict()
      Recursively converts this document and all its children into native Python PyDictionary and PyList objects. This creates a snapshot copy of the data.