org.cip4.jdflib.pool
Class JDFAuditPool

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.cip4.jdflib.core.KElement
                          extended by org.cip4.jdflib.core.JDFElement
                              extended by org.cip4.jdflib.pool.JDFPool
                                  extended by org.cip4.jdflib.pool.JDFAuditPool
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class JDFAuditPool
extends JDFPool

This class represents a JDF-AuditPool

See Also:
Serialized Form

Nested Class Summary
 
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
JDFAuditPool(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
          Constructor for JDFAuditPool
JDFAuditPool(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
          Constructor for JDFAuditPool
JDFAuditPool(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName, String myLocalName)
          Constructor for JDFAuditPool
 
Method Summary
 JDFAudit addAudit(JDFAudit.EnumAuditType typ, String by)
          add an audit, called internally by the specialized functions
 JDFCreated addCreated(String by, KElement createdElem)
          Append a Created audit element, if createdElem==null only add if it is not yet there
 JDFDeleted addDeleted(String by, KElement deletedElem)
          Append a Deleted audit element
 JDFAudit addEvent(String by, JDFAudit.EnumSeverity s)
          add a Notification Audit
 JDFMerged addMerged(JDFNode merged, VString rRefsOverwritten, String by, VJDFAttributeMap vmParts)
          Append a Merged audit element
 JDFModified addModified(String by, KElement modifiedElem)
          Append a Modified audit element
 JDFNotification addNotification(JDFAutoNotification.EnumClass severity, String by, VJDFAttributeMap vmParts)
          Append a Notification audit element with a Class attribute of Severity
 JDFPhaseTime addPhaseTime(JDFElement.EnumNodeStatus phase, String by, VJDFAttributeMap vmParts)
          Append a PhaseTime audit element
 JDFProcessRun addProcessRun(JDFElement.EnumNodeStatus s, String by)
          Deprecated. use addProcessRun(JDFElement.EnumNodeStatus s, JDFConstants.EMPTYSTRING, new VJDFAttributeMap())
 JDFProcessRun addProcessRun(JDFElement.EnumNodeStatus s, String by, VJDFAttributeMap vmParts)
          Add a ProcessRun Audit
 JDFResourceAudit addResourceAudit(String by)
          append a ResourceAudit audit element
 JDFSpawned addSpawned(JDFNode spawned, VString rRefsRO, VString rRefsRW, String by, VJDFAttributeMap vmParts)
          Append a Spawned audit element
 void appendUnique(JDFAudit p)
          Append a new child if no identical child exists
 void appendUnique(JDFAuditPool p)
          Append all children of p for which no identical child exists
 void cleanUpMerge(JDFNode.EnumCleanUpMerge cleanPolicy, String spawnID)
          Deprecated. use JDFMerge.cleanUpMerge
 JDFProcessRun createSubmitProcessRun(JDFQueueEntry qe)
          creates a ProcessRun when this is submitted should be called by the receiving device when it initially receives and enqueues the JDF
 void ensureCreated()
           
 JDFAudit getAudit(int index, JDFAudit.EnumAuditType typ, JDFAttributeMap mAttributes)
          Deprecated. use 4 parameter version
 JDFAudit getAudit(int index, JDFAudit.EnumAuditType typ, JDFAttributeMap mAttributes, VJDFAttributeMap vParts)
          get the index'th audit of the given typ
 VElement getAudits(JDFAudit.EnumAuditType typ, JDFAttributeMap mAttributes)
          Deprecated. use getAudits(null, null, null)
 VElement getAudits(JDFAudit.EnumAuditType typ, JDFAttributeMap mAttributes, VJDFAttributeMap vParts)
          } getAudits - get all audits with attributes and partMap
 JDFPhaseTime getLastPhase()
          Deprecated. use getLastPhase(VJDFAttributeMap)
 JDFPhaseTime getLastPhase(VJDFAttributeMap vPartMap)
          Deprecated. use getLastPhase(vPartMap, null)
 JDFPhaseTime getLastPhase(VJDFAttributeMap vPartMap, String moduleID)
          getLastPhase - get the most recent PhaseTime audit in this pool
 VElement getLinkedResources(JDFAttributeMap mResAtt, boolean bFollowRefs)
          get the linked resources matching some conditions
 VElement getLinks(JDFAttributeMap mLinkAtt)
          Deprecated. 060216 - this seams to have accidentally been added default: getLinks(null)
 VElement getPoolChildren(String strName, JDFAttributeMap mAttrib)
          gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool
 VElement getResourceAudits(String id, VJDFAttributeMap vPartMap)
          getResourceAudits - get the resourceAudits for a given Resource
protected  ElementInfo getTheElementInfo()
           
 JDFPhaseTime setPhase(JDFElement.EnumNodeStatus status, String statusDetails, VJDFAttributeMap vmParts)
          Deprecated. use the 4 parameter version
 JDFPhaseTime setPhase(JDFElement.EnumNodeStatus status, String statusDetails, VJDFAttributeMap vmParts, VElement employees)
          Create or modify a PhaseTime Audit and fill it If the phase is identical to the prior phase that has been set, the existing PhaseTime is modified otherwise an existing phaseTime is closed and a new phaseTime is appended Phasetime elements with different Parts are treated independently
 VElement setPhase(JDFJMF jmf)
          finds all status messages in a jmf and fills the phaseTime with the appropriate data
 String toString()
          toString
 
Methods inherited from class org.cip4.jdflib.pool.JDFPool
appendUniqueGeneric, appendUniqueGeneric, getPoolChildGeneric, getPoolChildrenGeneric
 
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, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheAttributeInfo, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, 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, removePartMap, 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, setPartMap, setPartMapVector, 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

JDFAuditPool

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

Parameters:
myOwnerDocument - -
qualifiedName - -

JDFAuditPool

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

Parameters:
myOwnerDocument - -
myNamespaceURI - -
qualifiedName - -

JDFAuditPool

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

Parameters:
myOwnerDocument - -
myNamespaceURI - -
qualifiedName - -
myLocalName - -
Method Detail

getTheElementInfo

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

toString

public String toString()
toString

Overrides:
toString in class JDFPool
Returns:
String
See Also:
Object.toString()

ensureCreated

public void ensureCreated()

addProcessRun

@Deprecated
public JDFProcessRun addProcessRun(JDFElement.EnumNodeStatus s,
                                              String by)
Deprecated. use addProcessRun(JDFElement.EnumNodeStatus s, JDFConstants.EMPTYSTRING, new VJDFAttributeMap())

Add a ProcessRun Audit

Parameters:
s - the node status at this time
by - the author keyword
Returns:
JDFProcessRun the newly created ProcessRun audit default: addProcessRun(s, JDFConstants.EMPTYSTRING)

addProcessRun

public JDFProcessRun addProcessRun(JDFElement.EnumNodeStatus s,
                                   String by,
                                   VJDFAttributeMap vmParts)
Add a ProcessRun Audit

Parameters:
s - the node status at this time
by - the author keyword
vmParts - the vector of parts that tis processrun applies to
Returns:
the newly created ProcessRun audit default: AddProcessRun(s, JDFConstants.EMPTYSTRING)

addAudit

public JDFAudit addAudit(JDFAudit.EnumAuditType typ,
                         String by)
add an audit, called internally by the specialized functions

Parameters:
typ - audit type
by - the author keyword
Returns:
JDFAudit default: AddAudit(typ, JDFConstants.EMPTYSTRING)

addCreated

public JDFCreated addCreated(String by,
                             KElement createdElem)
Append a Created audit element, if createdElem==null only add if it is not yet there

Parameters:
by - the author keyword
createdElem - the created element
Returns:
the newly created Created audit default: AddCreated(by, null)

addModified

public JDFModified addModified(String by,
                               KElement modifiedElem)
Append a Modified audit element

Parameters:
by - the author keyword
modifiedElem - the modified element default: AddModified(by, null)
Returns:
the modified audit

addDeleted

public JDFDeleted addDeleted(String by,
                             KElement deletedElem)
Append a Deleted audit element

Parameters:
by - the author keyword
deletedElem - the deleted element
Returns:
JDFDeleted the newly created Deleted audit default: AddDeleted(null, null)

addResourceAudit

public JDFResourceAudit addResourceAudit(String by)
append a ResourceAudit audit element

Parameters:
by - the author keyword
Returns:
JDFResourceAudit - the newly created ResourceAudit audit, null if an error occured

addEvent

public JDFAudit addEvent(String by,
                         JDFAudit.EnumSeverity s)
add a Notification Audit

Parameters:
by - the author keyword
s - severity of the event
Returns:
JDFAudit - the newly created Notification Audit TODO replace with addNotification

addPhaseTime

public JDFPhaseTime addPhaseTime(JDFElement.EnumNodeStatus phase,
                                 String by,
                                 VJDFAttributeMap vmParts)
Append a PhaseTime audit element

Parameters:
phase - the node status at this time
by - the author keyword
vmParts - defines a vector of map of parts for which the Spawned is valid
Returns:
the newly created PhaseTime audit default: AddPhaseTime(phase, JDFConstants.EMPTYSTRING, new VJDFAttributeMap())

addSpawned

public JDFSpawned addSpawned(JDFNode spawned,
                             VString rRefsRO,
                             VString rRefsRW,
                             String by,
                             VJDFAttributeMap vmParts)
Append a Spawned audit element

Parameters:
spawned - the spawned node
rRefsRO - a vector of rRefs that are spawned read-only
rRefsRW - a vector of rRefs that are spawned read-write
by - the author keyword
vmParts - the vector of parts
Returns:
JDFAudit - the newly created Spawned audit default: AddSpawned(spawned, new Vector(), new Vector(), JDFConstants.EMPTYSTRING, new VJDFAttributeMap())

addMerged

public JDFMerged addMerged(JDFNode merged,
                           VString rRefsOverwritten,
                           String by,
                           VJDFAttributeMap vmParts)
Append a Merged audit element

Parameters:
merged - the merged node
rRefsOverwritten - a vector of rRefs that are overwritten
by - the author keyword
vmParts - the vector of parts
Returns:
JDFMerged - the newly created Merged audit default: AddMerged(merged, rRefsOverwritten, JDFConstants.EMPTYSTRING, null)

addNotification

public JDFNotification addNotification(JDFAutoNotification.EnumClass severity,
                                       String by,
                                       VJDFAttributeMap vmParts)
Append a Notification audit element with a Class attribute of Severity

Parameters:
by - the author keyword
severity - the severity
vmParts - the vector of parts
Returns:
JDFAudit - the newly created Notification audit

getLastPhase

@Deprecated
public JDFPhaseTime getLastPhase()
Deprecated. use getLastPhase(VJDFAttributeMap)

getLastPhase - get the most recent PhaseTime audit in this pool

Returns:
JDFAudit - the last PhaseTime audit

getLastPhase

@Deprecated
public JDFPhaseTime getLastPhase(VJDFAttributeMap vPartMap)
Deprecated. use getLastPhase(vPartMap, null)

getLastPhase - get the most recent PhaseTime audit in this pool

Parameters:
vPartMap - the list of matching partMaps
Returns:
JDFAudit - the last PhaseTime audit

getResourceAudits

public VElement getResourceAudits(String id,
                                  VJDFAttributeMap vPartMap)
getResourceAudits - get the resourceAudits for a given Resource

Parameters:
vPartMap - the list of matching partMaps
id - the id of the resource
Returns:
VElement - the vector of res audits, null if none found

getLastPhase

public JDFPhaseTime getLastPhase(VJDFAttributeMap vPartMap,
                                 String moduleID)
getLastPhase - get the most recent PhaseTime audit in this pool

Parameters:
vPartMap - the list of matching partMaps
moduleID - the module to restrict the search to, null if any
Returns:
JDFAudit - the last PhaseTime audit

getAudits

@Deprecated
public VElement getAudits(JDFAudit.EnumAuditType typ,
                                     JDFAttributeMap mAttributes)
Deprecated. use getAudits(null, null, null)

getAudits - get all audits with attributes and partMap

Parameters:
typ - type of the audit to take
mAttributes - attribute map to filter the audits
Returns:
VElement - all elements, that matches the filter default: getAudits(null, null)

getAudits

public VElement getAudits(JDFAudit.EnumAuditType typ,
                          JDFAttributeMap mAttributes,
                          VJDFAttributeMap vParts)
} getAudits - get all audits with attributes and partMap

Parameters:
typ - type of the audit to take
mAttributes - attribute map to filter the audits
vParts - the partmap vector - note that not all audits legally have parts
Returns:
VElement - all elements, that matches the filter default: getAudits(null, null, null)

getAudit

@Deprecated
public JDFAudit getAudit(int index,
                                    JDFAudit.EnumAuditType typ,
                                    JDFAttributeMap mAttributes)
Deprecated. use 4 parameter version

get the index'th audit of the given typ

Parameters:
index - index of the audit negativ values are possible and will be substracted from the vector size. For example, your given Filter returns a Vector of 10 Posible Elements and your index is -7 you will get 10 - 7 = Element Number 3
typ - type of the audit to take
mAttributes - attribute map to filter the audits
Returns:
an Audit that matches the filers default: getAudit(index, typ, null)

getAudit

public JDFAudit getAudit(int index,
                         JDFAudit.EnumAuditType typ,
                         JDFAttributeMap mAttributes,
                         VJDFAttributeMap vParts)
get the index'th audit of the given typ

Parameters:
index - index of the audit negativ values are possible and will be substracted from the vector size. For example,your given Filter returns a Vector of 10 Posible Elements and your index is -7 you will get 10 - 7 = Element Number 3
typ - type of the audit to take
mAttributes - attribute map to filter the audits
vParts - the partmap vector - note that not all audits legally have parts
Returns:
an Audit that matches the filers default: getAudit(index, typ, null)

setPhase

public VElement setPhase(JDFJMF jmf)
finds all status messages in a jmf and fills the phaseTime with the appropriate data

Parameters:
jmf - the jmf that contains Status messages to apply to this
Returns:
vector the vector of all modified phasetime elements

setPhase

@Deprecated
public JDFPhaseTime setPhase(JDFElement.EnumNodeStatus status,
                                        String statusDetails,
                                        VJDFAttributeMap vmParts)
Deprecated. use the 4 parameter version

Create or modify a PhaseTime Audit and fill it If the phase is identical to the prior phase that has been set, the existing PhaseTime is modified otherwise an existing phaseTime is closed and a new phaseTime is appended Phasetime elements with different Parts are treated independently

Parameters:
status - the node status at this time
statusDetails - details of this status
vmParts - defines a vector of map of parts for which the PhaseTime is valid
Returns:
JDFPhaseTime the newly created PhaseTime audit default: SetPhase(status, null,null,null)

setPhase

public JDFPhaseTime setPhase(JDFElement.EnumNodeStatus status,
                             String statusDetails,
                             VJDFAttributeMap vmParts,
                             VElement employees)
Create or modify a PhaseTime Audit and fill it If the phase is identical to the prior phase that has been set, the existing PhaseTime is modified otherwise an existing phaseTime is closed and a new phaseTime is appended Phasetime elements with different Parts are treated independently

Parameters:
status - the node status at this time
statusDetails - details of this status
vmParts - defines a vector of map of parts for which the PhaseTime is valid
employees - Vector of employees that are currently registered for this job
Returns:
JDFPhaseTime the newly created PhaseTime audit default: SetPhase(status, null,null,null)

getLinkedResources

public VElement getLinkedResources(JDFAttributeMap mResAtt,
                                   boolean bFollowRefs)
get the linked resources matching some conditions

Parameters:
mResAtt - map of Resource attributes to search for
bFollowRefs - true if internal references shall be followed
Returns:
VElement vector with all elements matching the conditions default: getLinkedResources(null, true)

getLinks

@Deprecated
public VElement getLinks(JDFAttributeMap mLinkAtt)
Deprecated. 060216 - this seams to have accidentally been added default: getLinks(null)

getLinks - get the links matching mLinkAtt out of the resource pool

Parameters:
mLinkAtt - the attribute to search for
Returns:
VElement - vector all all elements matching the condition mLinkAtt

appendUnique

public void appendUnique(JDFAudit p)
Append a new child if no identical child exists

Parameters:
p - the Child to add to the element

appendUnique

public void appendUnique(JDFAuditPool p)
Append all children of p for which no identical child exists

Parameters:
p - the Child to add to the element

getPoolChildren

public VElement getPoolChildren(String strName,
                                JDFAttributeMap mAttrib)
gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool

Parameters:
strName - name of the Child
mAttrib - an attribute to search for
Returns:
VElement: a vector with all elements in the pool matching the conditions default: getPoolChildren(null,null)

cleanUpMerge

@Deprecated
public void cleanUpMerge(JDFNode.EnumCleanUpMerge cleanPolicy,
                                    String spawnID)
                  throws NoSuchMethodException
Deprecated. use JDFMerge.cleanUpMerge

Parameters:
cleanPolicy - .
spawnID - .
Throws:
NoSuchMethodException

createSubmitProcessRun

public JDFProcessRun createSubmitProcessRun(JDFQueueEntry qe)
creates a ProcessRun when this is submitted should be called by the receiving device when it initially receives and enqueues the JDF

Parameters:
qe - the queuentry element to copy information from, if null parameters will be genrated on the fly
Returns:
the newly created processRun


Copyright © 2013. All Rights Reserved.