public class JDFQueue extends JDFAutoQueue
Modifier and Type | Class and Description |
---|---|
static class |
JDFQueue.CleanupCallback
callback class definition for cleaning up in cleanup called once for every qe that is removed
|
static class |
JDFQueue.ExecuteCallback
callback class definition for specifying whether a QE may execute
|
JDFAutoQueue.EnumQueueStatus
JDFElement.EnumBoolean, JDFElement.EnumNamedColor, JDFElement.EnumNodeStatus, JDFElement.EnumOrientation, JDFElement.EnumPoolType, JDFElement.EnumSeparation, JDFElement.EnumSettingsPolicy, JDFElement.EnumValidationLevel, JDFElement.EnumVersion, JDFElement.EnumXYRelation
KElement.SimpleElementNameComparator, KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator
firstChild, fNodeListCache, ownerDocument
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
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
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
Constructor and Description |
---|
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
String qualifiedName)
Constructor for JDFQueue
|
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
String myNamespaceURI,
String qualifiedName)
Constructor for JDFQueue
|
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
String myNamespaceURI,
String qualifiedName,
String myLocalName)
Constructor for JDFQueue
|
Modifier and Type | Method and Description |
---|---|
boolean |
canAccept()
if the incoming queue processor is accepting new entries
|
boolean |
canExecute()
if the outgoing device processor is accepting new entries
|
void |
cleanup()
remove all entries with Status=Removed and any entries over maxCompleted that are either aborted or completed @see
JDFQueueEntry .isCompleted() |
JDFAutoQueue.EnumQueueStatus |
closeQueue()
set the status as if a CloseQueue command has been sent
|
JDFQueue |
copyToResponse(JDFResponse resp,
JDFQueueFilter filter)
Deprecated.
use 3 parameter method
|
JDFQueue |
copyToResponse(JDFResponse resp,
JDFQueueFilter filter,
JDFQueue priorQueue)
copies this to the JDF Response resp, applying the filters defined in filter
|
JDFQueueEntry |
createQueueEntry(boolean bHeld)
create a queueEntry if this queue is accepting
|
VString |
findQueueEntries(String strJobID,
String strJobPartID,
VJDFAttributeMap vamParts,
JDFAutoQueueEntry.EnumQueueEntryStatus status)
Deprecated.
use getQueueEntryVector(map, partmapvector)
|
VElement |
flushQueue(JDFQueueFilter qf)
flush this queue according to the rules defined in qf
|
JDFQueueEntry |
getEntry(int i)
Deprecated.
use getQueueEntry(int)
|
JDFQueueEntry |
getEntry(String strQEntryID)
Deprecated.
use getQueueEntry(id)
|
int |
getEntryCount()
Method getEntryCount.
|
int |
getMaxCompletedEntries() |
int |
getMaxRunningEntries() |
JDFQueueEntry |
getNextExecutableQueueEntry() |
JDFQueueEntry |
getNextExecutableQueueEntry(JDFQueue.ExecuteCallback cb)
Get the next QueueEntry to be processed the first entry with highest priority gets selected if deviceID is specified, the entries with an explicit non
matching deviceID are ignored the status of the QueueEntry MUST be waiting
proxy and represents previously submitted jobs as waiting
|
JDFQueueEntry |
getQueueEntry(NodeIdentifier nodeID,
int nSkip)
Find a queueEntry by NodeIdentifier (jobid, jobpartid, part)
note that you may want to use the generic getChildByTagName with the appropriate attribute map, if you have more information available |
JDFQueueEntry |
getQueueEntry(String strQEntryID)
Find a queueEntry by QueueEntryID
note that you may want to use the generic getChildByTagName with the appropriate attribute map, if you have more information available |
Map<String,JDFQueueEntry> |
getQueueEntryIDMap()
get a map of queueentries that uses QueueEntryID as key
|
int |
getQueueEntryPos(String strQEntryID)
Find the position of a queueEntry by QueueEntryID
|
VElement |
getQueueEntryVector()
Get a vector of all queueentry elements
|
VElement |
getQueueEntryVector(JDFAttributeMap attMap,
VJDFAttributeMap parts)
Get a vector of queueentry elements with a given set of attributes and part maps
|
VElement |
getQueueEntryVector(NodeIdentifier nid)
Get a vector of queueentry elements that matches a given nodeidentifier
|
int |
getQueueSize()
get the queuesize attribute or if it does not exist, count queuentry elements
|
boolean |
hasFewerEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus,
int entries)
return true if the queue has less than entries elements
|
JDFAutoQueue.EnumQueueStatus |
holdQueue()
set the status as if a HoldQueue command has been sent
|
boolean |
isAutomated()
is this a smart queue when modifying queueentries
|
int |
numEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus)
return the number of entries
|
JDFAutoQueue.EnumQueueStatus |
openQueue()
set the status as if an OpenQueue command has been sent
|
JDFAutoQueue.EnumQueueStatus |
resumeQueue()
set the status as if a HoldQueue command has been sent
|
void |
setAutomated(boolean _automated)
make this a smart queue when modifying queueentries
|
void |
setCleanupCallback(JDFQueue.CleanupCallback _cleanupCallback) |
void |
setExecuteCallback(JDFQueue.ExecuteCallback _callback) |
void |
setMaxCompletedEntries(int _maxCompletedEntries)
set the maximum number of completed entries to keep also call cleanup if we are automated
|
void |
setMaxRunningEntries(int _maxRunningEntries) |
void |
setMaxWaitingEntries(int _maxWaitingEntries) |
void |
setQueueSorter(Comparator<KElement> _queueSorter) |
JDFAutoQueue.EnumQueueStatus |
setStatusFromEntries()
set the status of this queue based on the status values of the queueentries
|
void |
sortChild(JDFQueueEntry qe) |
void |
sortChildren()
sorts all child elements by alphabet
|
String |
toString()
toString()
|
appendDevice, appendQueueEntry, getAllDevice, getAllQueueEntry, getCreateDevice, getCreateQueueEntry, getDevice, getDeviceID, getQueueEntry, getQueueStatus, getTheAttributeInfo, getTheElementInfo, setDeviceID, setQueueSize, setQueueStatus
appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, 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, getLinkFromUserData, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, 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, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, isXJDF, 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, write2Dir
addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, 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_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getCreateChildWithAttribute, 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, getNonEmpty_KElement, getNonEmpty, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasNonEmpty_KElement, hasNonEmpty, hasXPathNode, includesAttribute, includesAttributes, init, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, 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, setNonEmpty, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, sortChildren, toDisplayXML, toXML, toXML, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix
getBaseURI, getLocalName, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setType, setValues
cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttributeNS, isEqualNode, reconcileDefaultAttributes, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren
getNextSibling, getParentNode, getPreviousSibling
addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setUserData, setUserData
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
public JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String qualifiedName)
myOwnerDocument
- qualifiedName
- public JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, String myNamespaceURI, String qualifiedName)
myOwnerDocument
- myNamespaceURI
- qualifiedName
- public JDFAutoQueue.EnumQueueStatus openQueue()
public JDFAutoQueue.EnumQueueStatus closeQueue()
public JDFAutoQueue.EnumQueueStatus holdQueue()
public JDFAutoQueue.EnumQueueStatus resumeQueue()
public String toString()
toString
in class JDFAutoQueue
Object.toString()
public int getEntryCount()
public VElement getQueueEntryVector()
public VElement getQueueEntryVector(JDFAttributeMap attMap, VJDFAttributeMap parts)
attMap
- parts
- public Map<String,JDFQueueEntry> getQueueEntryIDMap()
public VElement getQueueEntryVector(NodeIdentifier nid)
nid
- @Deprecated public JDFQueueEntry getEntry(int i)
i
- the index of the queueentrypublic JDFQueueEntry createQueueEntry(boolean bHeld)
bHeld
- , if true, set the qe Status to Heldpublic VElement flushQueue(JDFQueueFilter qf)
qf
- @Deprecated public VString findQueueEntries(String strJobID, String strJobPartID, VJDFAttributeMap vamParts, JDFAutoQueueEntry.EnumQueueEntryStatus status)
default: findQueueEntries(jobID, jobPartID, new VJDFAttributeMap(), null)
strJobID
- Job ID.strJobPartID
- Job part ID.vamParts
- Partition to execute, may not be nullstatus
- Queue Entry Status, null means any status.@Deprecated public JDFQueueEntry getEntry(String strQEntryID)
strQEntryID
- the QueueEntryID of the requeste QueueEntrypublic JDFQueueEntry getQueueEntry(String strQEntryID)
strQEntryID
- the QueueEntryID of the requeste QueueEntrypublic JDFQueueEntry getQueueEntry(NodeIdentifier nodeID, int nSkip)
nodeID
- the identifier - jobID, jobPartID, parts - of the qenSkip
- the number of nodes to skip, cout backwards if<0public int getQueueEntryPos(String strQEntryID)
strQEntryID
- the QueueEntryID of the requeste QueueEntrypublic JDFQueueEntry getNextExecutableQueueEntry()
public JDFQueueEntry getNextExecutableQueueEntry(JDFQueue.ExecuteCallback cb)
cb
- public boolean canExecute()
public boolean canAccept()
public void cleanup()
JDFQueueEntry
.isCompleted()@Deprecated public JDFQueue copyToResponse(JDFResponse resp, JDFQueueFilter filter)
resp
- the JDFResponse to copy this tofilter
- the QueueFilter that sets the queue sizepublic JDFQueue copyToResponse(JDFResponse resp, JDFQueueFilter filter, JDFQueue priorQueue)
resp
- the JDFResponse to copy this tofilter
- the QueueFilter that sets the queue sizepriorQueue
- the prior que to apply thr filter to incase updategranularity is incrementalpublic int numEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus)
qeStatus
- the queueentry status of the enries to count, if null, do not filterpublic boolean hasFewerEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus, int entries)
qeStatus
- the status of the JDFQueueEntry to countentries
- the number of entries after which we stop countingpublic void setAutomated(boolean _automated)
_automated
- automate if truepublic boolean isAutomated()
public int getQueueSize()
getQueueSize
in class JDFAutoQueue
public JDFAutoQueue.EnumQueueStatus setStatusFromEntries()
public void sortChildren()
sortChildren
in class KElement
public int getMaxCompletedEntries()
public void setMaxCompletedEntries(int _maxCompletedEntries)
_maxCompletedEntries
- the maxCompletedEntries to setpublic int getMaxRunningEntries()
public void setMaxRunningEntries(int _maxRunningEntries)
_maxRunningEntries
- the maxRunningEntries to setpublic void setMaxWaitingEntries(int _maxWaitingEntries)
_maxWaitingEntries
- the setMaxWaitingEntries to set, excluding held entriespublic void setCleanupCallback(JDFQueue.CleanupCallback _cleanupCallback)
_cleanupCallback
- the cleanupCallback to setpublic void setExecuteCallback(JDFQueue.ExecuteCallback _callback)
_callback
- the ExecuteCallback to setpublic void setQueueSorter(Comparator<KElement> _queueSorter)
_queueSorter
- the queueSorter to set sets the Comparator to sort this queuewithpublic void sortChild(JDFQueueEntry qe)
qe
- Copyright © 2018. All rights reserved.