|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWQueueStats
public final class VWQueueStats
Use this class to encapsulate the statistical results for a queue. Instances of the class are created as a result of a request to the log manager to get a copy of the queue statistics. The instance of the class is used to retrieve the performance statistics on a queue.
VWRosterStats
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.Double |
getAverageProcessedWO()
Gets the ratio of the summation of sample counts of the processed work objects to the number of samples. |
java.lang.Double |
getAverageQueueDelay()
Gets the ratio of the total of the time periods (in the requested time units) work objects stayed in a queue, to the number of work objects dequeued during the evaluation period. |
java.lang.Double |
getAverageQueueDepth()
Gets the ratio of the summation of queue depths, summed over the sample periods, to the number of samples. |
java.lang.Double |
getAverageThroughput()
Gets the ratio of the number of work objects dequeued to the number of time units spanning the evaluation period. |
java.lang.Double |
getAverageWOLocked()
Gets a ratio of the summation of the sample counts of the locked work objects to the number of samples as a ratio. |
java.lang.Double |
getAverageWOProcessingTime()
Gets the per-time-unit average processing time for a work object. |
java.lang.String |
getClassName()
Provides the name of the class (Queue or Roster) whose statistics are to be retrieved. |
java.lang.Double |
getCurrentQueueDepth()
Gets a number representing the queue depth at a sample point, at the time the method is processed. |
java.lang.Double |
getCurrentWOLocked()
Gets a double-precision number that is the count of the number of work objects locked at the sample point. |
java.lang.Double |
getDequeuedRate()
Gets the ratio of the dequeued work objects to the number of time units in the evaluation period. |
java.util.Date |
getEndTime()
Gets the time the evaluated request completed on the server. |
java.util.Date |
getEvaluationTime()
Gets the time stamp for the time this request was evaluated on the server. |
java.lang.Double |
getInitialNumberOfQueued()
Gets the initial number of work objects in the queue at the beginning of the time evaluation period. |
java.lang.Double |
getNumberOfRemainingQueued()
Gets the final number of work objects in the queue. |
java.lang.Double |
getNumberOfSamples()
Gets a number that indicates the number of samples taken within the evaluation period. |
java.lang.Double |
getNumberOfUnitsInPeriod()
Gets a count that indicates the number of time units in the evaluation period. |
java.lang.Double |
getNumberOfWOLocked()
Gets the number of work objects locked during the evaluation period. |
java.lang.Double |
getNumberOfWOProcessed()
Gets the number of work objects processed during the evaluation period. |
java.lang.Double |
getQueuedRate()
Gets the ratio of the number of work objects queued to the number of time units in the evaluation period. |
java.lang.Double |
getQueueGrowthRate()
Gets the ratio of the queued work objects to the dequeued work objects over the evaluation period. |
java.lang.String |
getQueueName()
Gets the name of the queue for the statistics object. |
java.util.Date |
getRequestedEndTime()
Gets the time value the user specified as the end time for the queue statistics evaluation. |
java.util.Date |
getRequestedStartTime()
Gets the time value the user specified as the start time for the queue statistics evaluation. |
int |
getRequestedTimeUnit()
Gets the evaluation period unit of measure (or interval) specified by the user (for example, minutes, hours, days, etc.). |
java.util.Date |
getStartTime()
Gets the time the evaluated request began on the server. |
java.lang.Double |
getSummationDurationWOInQueue()
Gets the summation of the durations of work objects in the queue, summed over the samples in the evaluation period. |
java.lang.Double |
getSummationQueueDepth()
Gets a number representing the sum of all queue depths for the samples in the evaluation period. |
java.lang.Double |
getSummationWOLocked()
Gets a number representing the summation of the counts of all work objects locked in the queue for each sample, summed over the samples in the evaluation period. |
java.lang.Double |
getSummationWOProcessed()
Gets a number representing the sum of the counts of all work objects that have been advanced or updated for the samples in the evaluation period. |
java.lang.Double |
getTotalAbortedTime()
Gets a double-precision number indicating the total queue time (in the requested work units) taken by work objects that were unlocked and never processed. |
java.lang.Double |
getTotalServiceTime()
Gets a double-precision number indicating the total queue time (in the requested work units) taken by locked work objects until they are advanced or updated. |
java.lang.Double |
getTotalWOAborted()
Gets a number indicating the total number of the work objects that are locked and then unlocked without processing since the beginning of the time interval. |
java.lang.Double |
getTotalWODequeued()
Gets a number that indicates the count of all of the work objects dequeued since the beginning of the time interval. |
java.lang.Double |
getTotalWOQueued()
Gets a double-precision number that is the count of all work objects queued during the evaluation period. |
void |
setSession(filenet.vw.server.IPECommands sess)
Set the command session associated with this statistics object. |
java.lang.String |
toString()
Gets the queue name and the start and end times of the statistics in a string format. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.util.Date getEvaluationTime()
public java.util.Date getStartTime()
getEndTime()
,
getRequestedEndTime()
public java.util.Date getEndTime()
getStartTime()
,
getRequestedStartTime()
public java.util.Date getRequestedStartTime()
public java.util.Date getRequestedEndTime()
public int getRequestedTimeUnit()
VWTimeUnitType
public java.lang.Double getNumberOfUnitsInPeriod()
getRequestedTimeUnit()
public java.lang.Double getNumberOfSamples()
public java.lang.String getQueueName()
public java.lang.Double getInitialNumberOfQueued()
public java.lang.Double getNumberOfRemainingQueued()
public java.lang.Double getNumberOfWOProcessed()
public java.lang.Double getNumberOfWOLocked()
public java.lang.Double getAverageWOProcessingTime()
getRequestedTimeUnit()
,
getNumberOfWOProcessed()
public java.lang.Double getAverageThroughput()
getRequestedTimeUnit()
,
getTotalWODequeued()
public java.lang.Double getAverageQueueDelay()
getSummationDurationWOInQueue()
,
getTotalWODequeued()
,
getRequestedTimeUnit()
public java.lang.Double getTotalWODequeued()
public java.lang.Double getTotalWOQueued()
public java.lang.Double getTotalWOAborted()
public java.lang.Double getTotalServiceTime()
public java.lang.Double getTotalAbortedTime()
public java.lang.Double getDequeuedRate()
getTotalWODequeued()
public java.lang.Double getQueuedRate()
getTotalWOQueued()
public java.lang.Double getSummationDurationWOInQueue()
public java.lang.Double getQueueGrowthRate()
getTotalWOQueued()
,
getTotalWODequeued()
public java.lang.Double getAverageQueueDepth()
getSummationQueueDepth()
public java.lang.Double getAverageProcessedWO()
getNumberOfWOProcessed()
public java.lang.Double getAverageWOLocked()
getSummationWOLocked()
public java.lang.Double getSummationQueueDepth()
getAverageQueueDepth()
public java.lang.Double getSummationWOProcessed()
getAverageProcessedWO()
public java.lang.Double getSummationWOLocked()
getAverageWOLocked()
public java.lang.Double getCurrentQueueDepth()
public java.lang.Double getCurrentWOLocked()
public java.lang.String toString()
<QueueName> from <StartTime> to <EndTime>
toString
in class java.lang.Object
public java.lang.String getClassName()
public void setSession(filenet.vw.server.IPECommands sess) throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |