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, Element, 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:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.cip4.jdflib.auto.JDFAutoJobPhase

JDFAutoJobPhase.EnumActivation, JDFAutoJobPhase.EnumDeadLine

Nested classes/interfaces inherited from class org.cip4.jdflib.core.JDFElement

JDFElement.EnumBoolean, JDFElement.EnumNamedColor, JDFElement.EnumNodeStatus, JDFElement.EnumOrientation, JDFElement.EnumPoolType, JDFElement.EnumSeparation, JDFElement.EnumSettingsPolicy, JDFElement.EnumValidationLevel, JDFElement.EnumVersion, JDFElement.EnumXYRelation

Nested classes/interfaces inherited from class org.cip4.jdflib.core.KElement

KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator

Field Summary

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

JDFJobPhase(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
Constructor for JDFJobPhase

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

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

Method Summary

JDFNode	appendNode() append a node
void	applyNode(JDFNode node) apply all values of a JDF Node to this
JDFModuleStatus	createModuleStatusFromModulePhase(JDFModulePhase mp) creates a new ModuleStatus in this based on the values in mp generally used to create messages from audits
double	getAmountDifference(JDFJobPhase lastphase) return the differential amount produced between this phase and lastphase
JDFNode	getCreateNode() get a node, create if it doesn't exist
NodeIdentifier	getIdentifier() gets the NodeIdetifier that matches this
String	getJobID() Method getJobID.
String	getJobPartID() Method getJobID.
JDFNode	getNode() get node
VJDFAttributeMap	getPartMapVector() get part map vector
double	getPhaseAmount() returns the phase amount, defaults to amount if not specified
JDFDate	getPhaseStartTime() returns the phase starttime, defaults to starttime if not specified
double	getPhaseWaste() returns the phase waste amount, defaults to waste if not specified
String	getQueueEntryID() Method getQueueEntryID.
JDFAutoQueueEntry.EnumQueueEntryStatus	getQueueEntryStatus()
String	getStatusDetails() Returns detailed status information.
JDFStatusQuParams	getStatusQuParams() get the JDFStatusQuParams that apply to the jobphase
protected ElementInfo	getTheElementInfo()
double	getWasteDifference(JDFJobPhase lastphase) return the differential waste amount produced between this phase and lastphase
boolean	hasPartMap(JDFAttributeMap mPart) check whether the part defined in mPart is included
boolean	isSamePhase(JDFJobPhase lastphase, boolean bExact) returns true if this is the same phase, i.e. the
boolean	mergeLastPhase(JDFJobPhase lastphase) creates a new phasetime that spans lastphase and this phase assume that amounts are correctly handled id starttimes are identical
void	removePartMap(JDFAttributeMap mPart) remove the part defined in mPart
void	setIdentifier(NodeIdentifier ni)
void	setPartMap(JDFAttributeMap mPart) set part to the one defined in mPart
void	setPartMapVector(VJDFAttributeMap vParts) set all parts to those defined in vParts
String	toString() toString()

Methods inherited from class org.cip4.jdflib.auto.JDFAutoJobPhase

appendCostCenter, appendMISDetails, appendModuleStatus, appendPart, getActivation, getAllModuleStatus, getAllPart, getAmount, getCostCenter, getCreateCostCenter, getCreateMISDetails, getCreateModuleStatus, getCreatePart, getDeadLine, getMISDetails, getModuleStatus, getPart, getPercentCompleted, getRestTime, getSpeed, getStartTime, getTheAttributeInfo, getTotalAmount, getURL, getWaste, setActivation, setAmount, setDeadLine, setJobID, setJobPartID, setPercentCompleted, setPhaseAmount, setPhaseStartTime, setPhaseWaste, setQueueEntryID, setRestTime, setSpeed, setStartTime, setStatusDetails, setTotalAmount, setURL, setWaste

Methods inherited from class org.cip4.jdflib.core.JDFElement

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyInto, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, removeRefElement, removeSettingsPolicy, replaceChild, requiredAttributes, requiredElements, requiredLevel, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNameTimeStamp, setAttributes, setBestEffortExceptions, setCommentURL, setDefaultJDFVersion, setDescriptiveName, setDirty, setEnumerationsAttribute, setGeneralID, setLongID, setMustHonorExceptions, setOperatorInterventionExceptions, setSettingsPolicy, setStatus, setVersion, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version

Methods inherited from class org.cip4.jdflib.core.KElement

addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildXPath, buildXPath, buildXPath, clone, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeMap, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getID, getIDPrefix, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasXPathNode, includesAttribute, includesAttributes, init, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildText, removeExtensions, removeFromAttribute, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setAttributeNSRaw, setAttributeRaw, setAttributes, setAttributes, setAttributes, setAttributesRaw, setBoolAttribute, setDirty, setID, setIntAttribute, setNamespaceURI, setNodeValue, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, toDisplayXML, toXML, toXML, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getBaseURI, getLocalName, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setType, setValues

Methods inherited from class org.apache.xerces.dom.ElementImpl

cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttributeNS, isEqualNode, reconcileDefaultAttributes, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setUserData, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Element

getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData

Constructor Detail

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 Detail

toString

public String toString()

toString()

Overrides:

toString in class JDFAutoJobPhase

Returns:

String

See Also:

JDFAutoJobPhase.toString()

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

setPartMapVector

public void setPartMapVector(VJDFAttributeMap vParts)

set all parts to those defined in vParts

Overrides:

setPartMapVector in class JDFElement

Parameters:

vParts - vector of attribute maps for the parts

setPartMap

public void setPartMap(JDFAttributeMap mPart)

set part to the one defined in mPart

Overrides:

setPartMap in class JDFElement

Parameters:

mPart - attribute map for the part to set

removePartMap

public void removePartMap(JDFAttributeMap mPart)

remove the part defined in mPart

Overrides:

removePartMap in class JDFElement

Parameters:

mPart - attribute map for the part to remove

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:

INodeIdentifiable.setIdentifier(org.cip4.jdflib.node.NodeIdentifier)

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