org.cip4.jdflib.util
Class StatusUtil

java.lang.Object
  extended by org.cip4.jdflib.util.StatusUtil

Deprecated. - use StatusCounter

@Deprecated
public class StatusUtil
extends Object

Utility class for status JDF and JMF

Author:
prosirai

Nested Class Summary
 class StatusUtil.AmountBag
          Deprecated. container class to set amounts and waste in phaseTime
 
Field Summary
protected  VJDFAttributeMap m_vPartMap
          Deprecated.  
 
Constructor Summary
StatusUtil(JDFNode node, VJDFAttributeMap vPartMap, VElement vResLinks)
          Deprecated. construct a StatusUtil for a node n
 
Method Summary
static StatusUtil.AmountBag getBag(String refID, StatusUtil.AmountBag[] bags)
          Deprecated. get the matching AmountBag out of an array
 String getDeviceID()
          Deprecated.  
 JDFDoc getDocJMFPhaseTime()
          Deprecated.  
 JDFDoc getDocJMFResource()
          Deprecated.  
 String getFirstRefID()
          Deprecated. get the refID of the first resource, i.e. the Resource that is being tracked in status messages
 org.cip4.jdflib.util.StatusUtil.LinkAmount getLinkAmount(String refID)
          Deprecated. get the matching LinkAmount out of this
 void setCopyResInResInfo(JDFResourceLink rl, boolean b)
          Deprecated. set copying the resource into resourceInfo on or off for the resourcelink rl
 void setDeviceID(String deviceid)
          Deprecated.  
 void setPhase(JDFElement.EnumNodeStatus nodeStatus, String nodeStatusDetails, JDFAutoDeviceInfo.EnumDeviceStatus deviceStatus, String deviceStatusDetails, StatusUtil.AmountBag[] amounts)
          Deprecated. Set the Status and StatusDetails of this node update the PhaseTime audit or append a new phasetime as appropriate also prepare a status JMF
 JDFProcessRun setProcessResult(JDFElement.EnumNodeStatus endStatus)
          Deprecated.  
 JDFResourceAudit setResourceAudit(StatusUtil.AmountBag bag, JDFAutoResourceAudit.EnumReason reason)
          Deprecated.  
 void setTrackWaste(JDFResourceLink rl, boolean b)
          Deprecated. set waste tracking on or off for the resourcelink rl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_vPartMap

protected VJDFAttributeMap m_vPartMap
Deprecated. 
Constructor Detail

StatusUtil

public StatusUtil(JDFNode node,
                  VJDFAttributeMap vPartMap,
                  VElement vResLinks)
Deprecated. 
construct a StatusUtil for a node n

Parameters:
node - the JDFNode that is being processed
vPartMap - the map of Parts that is being processed excluding the waste partition
vResLinks - the reslinks that are tracked for amount handling
Method Detail

getBag

public static StatusUtil.AmountBag getBag(String refID,
                                          StatusUtil.AmountBag[] bags)
Deprecated. 
get the matching AmountBag out of an array

Parameters:
refID - the refID of the bag - this MUST match the refID of a ResourceLink
bags - the array of bags to search in
Returns:
the AmountBag with matching refID, null if none found or bags is null

getLinkAmount

public org.cip4.jdflib.util.StatusUtil.LinkAmount getLinkAmount(String refID)
Deprecated. 
get the matching LinkAmount out of this

Parameters:
refID - the refID of the bag - this MUST match the refID of a ResourceLink
Returns:
the LinkAmount with matching refID, null if none found or bags is null

getFirstRefID

public String getFirstRefID()
Deprecated. 
get the refID of the first resource, i.e. the Resource that is being tracked in status messages

Returns:
the rRef of the prime resource link

setPhase

public void setPhase(JDFElement.EnumNodeStatus nodeStatus,
                     String nodeStatusDetails,
                     JDFAutoDeviceInfo.EnumDeviceStatus deviceStatus,
                     String deviceStatusDetails,
                     StatusUtil.AmountBag[] amounts)
Deprecated. 
Set the Status and StatusDetails of this node update the PhaseTime audit or append a new phasetime as appropriate also prepare a status JMF

Parameters:
nodeStatus - the new status of the node
nodeStatusDetails - the new statusDetails of the node
deviceStatus - the new status of the device
deviceStatusDetails - the new statusDetails of the device
amounts -

getDocJMFPhaseTime

public JDFDoc getDocJMFPhaseTime()
Deprecated. 
Returns:
the docJMFPhaseTime

getDocJMFResource

public JDFDoc getDocJMFResource()
Deprecated. 
Returns:
the docJMFResource

getDeviceID

public String getDeviceID()
Deprecated. 
Returns:
the m_deviceID

setDeviceID

public void setDeviceID(String deviceid)
Deprecated. 
Parameters:
deviceid - the deviceID to set

setTrackWaste

public void setTrackWaste(JDFResourceLink rl,
                          boolean b)
Deprecated. 
set waste tracking on or off for the resourcelink rl

Parameters:
rl - the resourcelink to the resource to track
b - tracking on or off

setCopyResInResInfo

public void setCopyResInResInfo(JDFResourceLink rl,
                                boolean b)
Deprecated. 
set copying the resource into resourceInfo on or off for the resourcelink rl

Parameters:
rl - the resourcelink to the resource to copy
b - tracking on or off

setResourceAudit

public JDFResourceAudit setResourceAudit(StatusUtil.AmountBag bag,
                                         JDFAutoResourceAudit.EnumReason reason)
Deprecated. 
Parameters:
bag -
reason -
Returns:
JDFResourceAudit the generated audit

setProcessResult

public JDFProcessRun setProcessResult(JDFElement.EnumNodeStatus endStatus)
Deprecated. 
Parameters:
endStatus -
Returns:


Copyright © 2013. All Rights Reserved.