Package com.uc4.api.systemoverview

Class CacheListItem

  • public class CacheListItem
extends java.lang.Object
    One row of the cache list.

    • Constructor Summary

      Constructors 
      Constructor Description
      CacheListItem​(org.w3c.dom.Element row)
      Constructs a CacheListItem from a XML element.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getCalls()
      Number of input buffer calls.
      int getCurrentSize()
      Currently used cache size.
      java.lang.String getHitRatio()
      Hits of the primary work processIt is responsible for the execution of Automation Engine internal tasks and work processes.
      int getHits()
      Number of entries found in the cache.
      int getItems()
      Number of all cache entries.
      java.lang.String getName()
      Area of the Server input buffer: SCRIPT - for Script VARA - for UC4 Variable MQMEM - for message queues ODOC and XREQ - for UserInterfaces USER - for users who use an Automation Engine system.
      int getThresholdValue()
      Deprecated.
      please use getThresholdValueLong() with long return value
      long getThresholdValueLong()
      Limit for the cache's memory release.
      java.lang.String getTimeUsed()
      Total time consumed by the work processes for calling the cache.
      boolean isActive()
      If the cache is active.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • CacheListItem

        public CacheListItem​(org.w3c.dom.Element row)
        Constructs a CacheListItem from a XML element.
        Parameters:
        row - Element

    • Method Detail

      • getName

        public java.lang.String getName()
        Area of the Server input buffer: SCRIPT - for Script VARA - for UC4 Variable MQMEM - for message queues ODOC and XREQ - for UserInterfaces USER - for users who use an Automation Engine system. OBJECT_IDNR - ID of the object OBJECT_NAME - for object names
        Returns:
        Name

      • getThresholdValue

        @Deprecated
public int getThresholdValue()
        Deprecated.
        please use getThresholdValueLong() with long return value
        Limit for the cache's memory release. To be specified in the Server properties. Data is stored in the cache until its maximum size has been reached. Only in this case, the Server deletes entries that are no longer required. The cache's maximum size is ignored if it is not possible to remove data.
        Returns:
        Clean Up Limit

      • getThresholdValueLong

        public long getThresholdValueLong()
        Limit for the cache's memory release. To be specified in the Server properties. Data is stored in the cache until its maximum size has been reached. Only in this case, the Server deletes entries that are no longer required. The cache's maximum size is ignored if it is not possible to remove data.
        Returns:
        Clean Up Limit

      • getCurrentSize

        public int getCurrentSize()
        Currently used cache size.
        Returns:
        Current size

      • getItems

        public int getItems()
        Number of all cache entries.
        Returns:
        Cache items

      • isActive

        public boolean isActive()
        If the cache is active.
        Returns:
        true if active

      • getCalls

        public int getCalls()
        Number of input buffer calls.
        Returns:
        Calls

      • getHits

        public int getHits()
        Number of entries found in the cache.
        Returns:
        Hits

      • getHitRatio

        public java.lang.String getHitRatio()
        Hits of the primary work processIt is responsible for the execution of Automation Engine internal tasks and work processes.
        Returns:
        Hit ratio in percent

      • getTimeUsed

        public java.lang.String getTimeUsed()
        Total time consumed by the work processes for calling the cache.
        Returns:
        Time

      • toString

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