Share (Apache UIMA DUCC: uima-ducc-rm 1.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.uima.ducc.rm.scheduler
Class Share

java.lang.Object
  org.apache.uima.ducc.rm.scheduler.Share

All Implemented Interfaces:: SchedConstants

public class Share
extends Object
implements SchedConstants
extends Object
implements SchedConstants

This may more correctly thought of as representing a Process. A share is ALWAYS associated with a Machine.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.uima.ducc.rm.scheduler.SchedConstants
`SchedConstants.EvictionPolicy, SchedConstants.Policy`

Field Summary

Fields inherited from interface org.apache.uima.ducc.rm.scheduler.SchedConstants
`COMPONENT_NAME, DEFAULT_INIT_STABILITY_COUNT, DEFAULT_INSTANCES, DEFAULT_MAX_INSTANCES, DEFAULT_MAX_PROCESSES, DEFAULT_NODE_METRICS_RATE, DEFAULT_PRIORITY, DEFAULT_PROCESSES, DEFAULT_SCHEDULING_RATE, DEFAULT_SCHEDULING_RATIO, DEFAULT_SHARE_WEIGHT, DEFAULT_STABILITY_COUNT`

Constructor Summary
`Share(org.apache.uima.ducc.common.utils.id.DuccId id, Machine machine, IRmJob job, int share_order)` This constructor is used during recovery ONLY.
`Share(Machine machine, IRmJob job, int share_order)` Normal constructor.

Method Summary
`boolean`	`equals(Object o)`
`org.apache.uima.ducc.common.utils.id.DuccId`	`getId()`
`long`	`getInitializationTime()` Returns only initialization time.
`IRmJob`	`getJob()`
`org.apache.uima.ducc.common.Node`	`getNode()`
`org.apache.uima.ducc.common.NodeIdentity`	`getNodeIdentity()`
`org.apache.uima.ducc.rm.scheduler.NodePool`	`getNodepool()`
`int`	`getNodepoolDepth()`
`String`	`getNodepoolId()`
`int`	`getShareOrder()` The order of the share itself.
`int`	`hashCode()`
`boolean`	`isPurged()`
`void`	`setFixed()`
`void`	`setInitializationTime(long millis)`
`String`	`toString()`
`boolean`	`update(org.apache.uima.ducc.common.utils.id.DuccId jobid, long mem, org.apache.uima.ducc.transport.event.common.IProcessState.ProcessState state, org.apache.uima.ducc.transport.event.common.ITimeWindow init_time, org.apache.uima.ducc.transport.event.common.ITimeWindow run_time, String pid)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

public Share(org.apache.uima.ducc.common.utils.id.DuccId id,
             Machine machine,
             IRmJob job,
             int share_order)

This constructor is used during recovery ONLY.

public Share(Machine machine,
             IRmJob job,
             int share_order)

Normal constructor.

Method Detail

getNodepool

public org.apache.uima.ducc.rm.scheduler.NodePool getNodepool()

getNodepoolDepth

public int getNodepoolDepth()

getNodepoolId

public String getNodepoolId()

getJob

public IRmJob getJob()

getId

public org.apache.uima.ducc.common.utils.id.DuccId getId()

getNodeIdentity

public org.apache.uima.ducc.common.NodeIdentity getNodeIdentity()

getNode

public org.apache.uima.ducc.common.Node getNode()

getShareOrder

public int getShareOrder()

The order of the share itself.

update

public boolean update(org.apache.uima.ducc.common.utils.id.DuccId jobid,
                      long mem,
                      org.apache.uima.ducc.transport.event.common.IProcessState.ProcessState state,
                      org.apache.uima.ducc.transport.event.common.ITimeWindow init_time,
                      org.apache.uima.ducc.transport.event.common.ITimeWindow run_time,
                      String pid)

getInitializationTime

public long getInitializationTime()

Returns only initialization time. Eventually getInvestment() may take other things into consideration so we separate these two (even though currently they do the same thing.)

setInitializationTime

public void setInitializationTime(long millis)

setFixed

public void setFixed()

isPurged

public boolean isPurged()

hashCode

public int hashCode()

Overrides:: hashCode in class Object

equals

public boolean equals(Object o)

Overrides:: equals in class Object

toString

public String toString()

Overrides:: toString in class Object