Package org.cip4.jdflib.jmf

Class JDFJobPhase

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.cip4.jdflib.core.KElement
org.cip4.jdflib.core.JDFElement
org.cip4.jdflib.auto.JDFAutoJobPhase
org.cip4.jdflib.jmf.JDFJobPhase
All Implemented Interfaces:
Serializable, Cloneable, INodeIdentifiable, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFJobPhase extends JDFAutoJobPhase implements INodeIdentifiable
describes the actual status of jobs in a device Note that the old EnumStatus local class has been move to @see JDFNode.EnumNodeStatus
See Also:

  • Constructor Details

    • JDFJobPhase

      public JDFJobPhase(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
      Constructor for JDFJobPhase
      Parameters:
      myOwnerDocument -
      qualifiedName -

    • JDFJobPhase

      public JDFJobPhase(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
      Constructor for JDFJobPhase
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -

    • JDFJobPhase

      public JDFJobPhase(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
      Constructor for JDFJobPhase
      Parameters:
      myOwnerDocument -
      myNamespaceURI -
      qualifiedName -
      myLocalName -

  • Method Details

    • toString

      public String toString()
      toString()
      Overrides:
      toString in class KElement
      Returns:
      String
      See Also:

    • getTheElementInfo

      protected ElementInfo getTheElementInfo()
      Overrides:
      getTheElementInfo in class JDFAutoJobPhase
      Returns:
      the elementinfo

    • getStatusDetails

      public String getStatusDetails()
      Returns detailed status information.
      Overrides:
      getStatusDetails in class JDFAutoJobPhase
      Returns:
      String

    • getQueueEntryID

      public String getQueueEntryID()
      Method getQueueEntryID.
      Overrides:
      getQueueEntryID in class JDFAutoJobPhase
      Returns:
      String

    • getJobID

      public String getJobID()
      Method getJobID.
      Overrides:
      getJobID in class JDFAutoJobPhase
      Returns:
      String

    • getJobPartID

      public String getJobPartID()
      Method getJobID.
      Overrides:
      getJobPartID in class JDFAutoJobPhase
      Returns:
      String

    • getPartMapVector

      public VJDFAttributeMap getPartMapVector()
      get part map vector
      Overrides:
      getPartMapVector in class JDFElement
      Returns:
      VJDFAttributeMap: vector of attribute maps, one for each part

    • getPartMapArray

      public JDFAttributeMapArray getPartMapArray()
      get part map array
      Overrides:
      getPartMapArray in class JDFElement
      Returns:
      array of attribute, one for each part

    • setPartMap

      public void setPartMap(JDFAttributeMap m)
      set part to the one defined in mPart
      Overrides:
      setPartMap in class JDFElement
      Parameters:
      m - attribute map for the part to set

    • removePartMap

      public void removePartMap(JDFAttributeMap mP)
      remove the part defined in mPart
      Overrides:
      removePartMap in class JDFElement
      Parameters:
      mP - attribute map for the part to remove

    • setPartMapVector

      public void setPartMapVector(VJDFAttributeMap vP)
      set all parts to those defined in vParts
      Overrides:
      setPartMapVector in class JDFElement
      Parameters:
      vP - vector of attribute maps for the parts

    • hasPartMap

      public boolean hasPartMap(JDFAttributeMap mPart)
      check whether the part defined in mPart is included
      Overrides:
      hasPartMap in class JDFElement
      Parameters:
      mPart - attribute map for the part to remove
      Returns:
      boolean - returns true if the part exists

    • getCreateNode

      public JDFNode getCreateNode()
      get a node, create if it doesn't exist
      Returns:
      the node

    • appendNode

      public JDFNode appendNode()
      append a node
      Returns:
      the appended node

    • applyNode

      public void applyNode(JDFNode node)
      apply all values of a JDF Node to this
      Parameters:
      node - the node to apply

    • getNode

      public JDFNode getNode()
      get node
      Returns:
      the node

    • getStatusQuParams

      public JDFStatusQuParams getStatusQuParams()
      get the JDFStatusQuParams that apply to the jobphase
      Returns:

    • getIdentifier

      public NodeIdentifier getIdentifier()
      gets the NodeIdetifier that matches this
      Specified by:
      getIdentifier in interface INodeIdentifiable
      Returns:

    • setIdentifier

      public void setIdentifier(NodeIdentifier ni)
      Specified by:
      setIdentifier in interface INodeIdentifiable
      Parameters:
      ni -
      See Also:

    • createModuleStatusFromModulePhase

      public JDFModuleStatus createModuleStatusFromModulePhase(JDFModulePhase mp)
      creates a new ModuleStatus in this based on the values in mp generally used to create messages from audits
      Parameters:
      mp - the modulephase to copy
      Returns:
      the new ModuleStatus element

    • getAmountDifference

      public double getAmountDifference(JDFJobPhase lastphase)
      return the differential amount produced between this phase and lastphase
      Parameters:
      lastphase - the phase
      Returns:

    • getWasteDifference

      public double getWasteDifference(JDFJobPhase lastphase)
      return the differential waste amount produced between this phase and lastphase
      Parameters:
      lastphase -
      Returns:

    • isSamePhase

      public boolean isSamePhase(JDFJobPhase lastphase, boolean bExact)
      returns true if this is the same phase, i.e. the
      Parameters:
      lastphase - the phase to compare with
      bExact - if true, use startTime as hook, else compare stati
      Returns:

    • mergeLastPhase

      public boolean mergeLastPhase(JDFJobPhase lastphase)
      creates a new phasetime that spans lastphase and this phase
      assume that amounts are correctly handled id starttimes are identical
      Parameters:
      lastphase - the phase to merge
      Returns:
      true if successful

    • getPhaseAmount

      public double getPhaseAmount()
      returns the phase amount, defaults to amount if not specified
      Overrides:
      getPhaseAmount in class JDFAutoJobPhase
      Returns:
      double the value of the attribute

    • getPhaseStartTime

      public JDFDate getPhaseStartTime()
      returns the phase starttime, defaults to starttime if not specified
      Overrides:
      getPhaseStartTime in class JDFAutoJobPhase
      Returns:
      JDFDate the value of the attribute

    • getPhaseWaste

      public double getPhaseWaste()
      returns the phase waste amount, defaults to waste if not specified
      Overrides:
      getPhaseWaste in class JDFAutoJobPhase
      Returns:
      double the value of the attribute

    • getQueueEntryStatus

      public JDFAutoQueueEntry.EnumQueueEntryStatus getQueueEntryStatus()
      Returns:
      the queueentry status that corresponds to the status of this

    • getSpeed

      public double getSpeed()
      also checks parent deviceinfo if empty
      Overrides:
      getSpeed in class JDFAutoJobPhase
      Returns:
      double the value of the attribute
      See Also:

    • setPercentCompleted

      public void setPercentCompleted(double value)
      Description copied from class: JDFAutoJobPhase
      (36) set attribute PercentCompleted
      Overrides:
      setPercentCompleted in class JDFAutoJobPhase
      Parameters:
      value - the value to set the attribute to