org.cip4.jdflib.jmf

Class JDFQueue

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.JDFAutoQueue

org.cip4.jdflib.jmf.JDFQueue

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IStreamWriter, org.w3c.dom.Element, org.w3c.dom.ElementTraversal, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList, org.w3c.dom.TypeInfo

public class JDFQueue
extends JDFAutoQueue

The JDF Queue

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

JDFAutoQueue.EnumQueueStatus

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.SimpleElementNameComparator, 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

Constructors

Constructor and Description
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String qualifiedName) Constructor for JDFQueue
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName) Constructor for JDFQueue
JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName, java.lang.String myLocalName) Constructor for JDFQueue

Method Summary

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(java.lang.String strJobID, java.lang.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(java.lang.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(java.lang.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
java.util.Map<java.lang.String,JDFQueueEntry>	getQueueEntryIDMap() get a map of queueentries that uses QueueEntryID as key
int	getQueueEntryPos(java.lang.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	setAutomated(boolean _automated, boolean recalc) 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(java.util.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
java.lang.String	toString() toString()

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

appendDevice, appendQueueEntry, getAllDevice, getAllQueueEntry, getCreateDevice, getCreateQueueEntry, getDevice, getDeviceID, getMaxQueueSize, getQueueEntry, getQueueStatus, getTheAttributeInfo, getTheElementInfo, setDeviceID, setMaxQueueSize, setQueueSize, setQueueStatus

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

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyChildren, copyInto, createRoot, createRoot, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentText, getCommentURL, getCreateComment, getCreateComment, getCreateElement_JDFElement, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementInfo, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDListMap, 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, getPartMapArray, 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, init, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, isDirty, isInAnyJDFNameSpaceStatic, isInAnyJDFNameSpaceStatic, 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, setCommentText, setCommentText, 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

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

addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendAttributes, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, buildXPath, buildXPath, buildXPath, clearNSMap, clone, copyAttribute, copyAttribute, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, ensureCase, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeArray_KElement, getAttributeIgnoreCase, getAttributeMap_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildArray_KElement, getChildArray, getChildArrayByClass_KElement, getChildArrayByClass, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildList, getChildList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenByTagName, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getChildWithAttribute, getChildWithAttribute, 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, getIgnoreCase_KElement, getIgnoreCase, 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, getTree, getTreeByClass, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasNonEmpty_KElement, hasNonEmpty, hasXPathNode, includesAttribute, includesAttributes, insertAt, insertBefore, isAncestor, isEqual, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveArray, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, numSiblingElements, parseFile, parseStream, parseString, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeIgnoreCase_KElement, removeIgnoreCase, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, 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, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, sortChildren, toDisplayXML, toValueString, toXML, toXML, uniqueID, uniqueID, write2File, write2File, write2Stream, writeStream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix

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

getLocalName, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setType

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

cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, 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

JDFQueue

public JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                java.lang.String qualifiedName)

Constructor for JDFQueue

Parameters:

myOwnerDocument -

qualifiedName -

JDFQueue

public JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                java.lang.String myNamespaceURI,
                java.lang.String qualifiedName)

Constructor for JDFQueue

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFQueue

public JDFQueue(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                java.lang.String myNamespaceURI,
                java.lang.String qualifiedName,
                java.lang.String myLocalName)

Constructor for JDFQueue

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

openQueue

public JDFAutoQueue.EnumQueueStatus openQueue()

set the status as if an OpenQueue command has been sent

Returns:

closeQueue

public JDFAutoQueue.EnumQueueStatus closeQueue()

set the status as if a CloseQueue command has been sent

Returns:

holdQueue

public JDFAutoQueue.EnumQueueStatus holdQueue()

set the status as if a HoldQueue command has been sent

Returns:

resumeQueue

public JDFAutoQueue.EnumQueueStatus resumeQueue()

set the status as if a HoldQueue command has been sent

Returns:

toString

public java.lang.String toString()

toString()

Overrides:

toString in class KElement

Returns:

String

See Also:

Object.toString()

getEntryCount

public int getEntryCount()

Method getEntryCount.

Returns:

int quantity of QueueEntry children

getQueueEntryVector

public VElement getQueueEntryVector()

Get a vector of all queueentry elements

Returns:

VElement: the vector of queue entries

getQueueEntryVector

public VElement getQueueEntryVector(JDFAttributeMap attMap,
                                    VJDFAttributeMap parts)

Get a vector of queueentry elements with a given set of attributes and part maps

Parameters:

attMap -

parts -

Returns:

VElement: the vector of queue entries

getQueueEntryIDMap

public java.util.Map<java.lang.String,JDFQueueEntry> getQueueEntryIDMap()

get a map of queueentries that uses QueueEntryID as key

Returns:

the map, null if this is empty

getQueueEntryVector

public VElement getQueueEntryVector(NodeIdentifier nid)

Get a vector of queueentry elements that matches a given nodeidentifier

Parameters:

nid -

Returns:

VElement: the vector of queue entries

getEntry

@Deprecated
public JDFQueueEntry getEntry(int i)

Deprecated. use getQueueEntry(int)

Method getEntry: find a queuentry by position

Parameters:

i - the index of the queueentry

Returns:

JDFQueueEntry

createQueueEntry

public JDFQueueEntry createQueueEntry(boolean bHeld)

create a queueEntry if this queue is accepting

Parameters:

bHeld - , if true, set the qe Status to Held

Returns:

the newly created queueEntry, null if failed

flushQueue

public VElement flushQueue(JDFQueueFilter qf)

flush this queue according to the rules defined in qf

Parameters:

qf -

Returns:

null if none were removed, else vector of removed queuentries

findQueueEntries

@Deprecated
public VString findQueueEntries(java.lang.String strJobID,
                                            java.lang.String strJobPartID,
                                            VJDFAttributeMap vamParts,
                                            JDFAutoQueueEntry.EnumQueueEntryStatus status)

Deprecated. use getQueueEntryVector(map, partmapvector)

Method findQueueEntries

default: findQueueEntries(jobID, jobPartID, new VJDFAttributeMap(), null)

Parameters:

strJobID - Job ID.

strJobPartID - Job part ID.

vamParts - Partition to execute, may not be null

status - Queue Entry Status, null means any status.

Returns:

VString: vector of QueueEntry IDs

getEntry

@Deprecated
public JDFQueueEntry getEntry(java.lang.String strQEntryID)

Deprecated. use getQueueEntry(id)

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

Parameters:

strQEntryID - the QueueEntryID of the requeste QueueEntry

Returns:

the QueueEntry with QueueEntryID=strQEntryID, null if strQEntryID is null or empty string or the queueentry does not exist

getQueueEntry

public JDFQueueEntry getQueueEntry(java.lang.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

Parameters:

strQEntryID - the QueueEntryID of the requeste QueueEntry

Returns:

the QueueEntry with QueueEntryID=strQEntryID, null if strQEntryID is null or empty string or the queueentry does not exist

getQueueEntry

public 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

Parameters:

nodeID - the identifier - jobID, jobPartID, parts - of the qe

nSkip - the number of nodes to skip, cout backwards if<0

Returns:

the QueueEntry with matching jobID, jobPartID, parts, null if nodeID is null or empty string or the queueentry does not exist

getQueueEntryPos

public int getQueueEntryPos(java.lang.String strQEntryID)

Find the position of a queueEntry by QueueEntryID

Parameters:

strQEntryID - the QueueEntryID of the requeste QueueEntry

Returns:

the position in the queue, -1 if not there

getNextExecutableQueueEntry

public JDFQueueEntry getNextExecutableQueueEntry()

Returns:

getNextExecutableQueueEntry

public 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

Parameters:

cb -

Returns:

the executable queueEntry, null if none is available

canExecute

public boolean canExecute()

if the outgoing device processor is accepting new entries

Returns:

true, if new entries are accepted

canAccept

public boolean canAccept()

if the incoming queue processor is accepting new entries

Returns:

true, if new entries are accepted

cleanup

public void cleanup()

remove all entries with Status=Removed and any entries over maxCompleted that are either aborted or completed @see JDFQueueEntry .isCompleted()

Overrides:

cleanup in class KElement

copyToResponse

@Deprecated
public JDFQueue copyToResponse(JDFResponse resp,
                                           JDFQueueFilter filter)

Deprecated. use 3 parameter method

copies this to the JDF Response resp, applying the filters defined in filter

Parameters:

resp - the JDFResponse to copy this to

filter - the QueueFilter that sets the queue size

Returns:

the copied queue

copyToResponse

public JDFQueue copyToResponse(JDFResponse resp,
                               JDFQueueFilter filter,
                               JDFQueue priorQueue)

copies this to the JDF Response resp, applying the filters defined in filter

Parameters:

resp - the JDFResponse to copy this to

filter - the QueueFilter that sets the queue size

priorQueue - the prior que to apply thr filter to incase updategranularity is incremental

Returns:

the copied queue

numEntries

public int numEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus)

return the number of entries

Parameters:

qeStatus - the queueentry status of the enries to count, if null, do not filter

Returns:

the number of active processors

hasFewerEntries

public boolean hasFewerEntries(JDFAutoQueueEntry.EnumQueueEntryStatus qeStatus,
                               int entries)

return true if the queue has less than entries elements

Parameters:

qeStatus - the status of the JDFQueueEntry to count

entries - the number of entries after which we stop counting

Returns:

true if the queue has < entries entries with a given QE Status

setAutomated

public void setAutomated(boolean _automated)

make this a smart queue when modifying queueentries

Parameters:

_automated - automate if true

setAutomated

public void setAutomated(boolean _automated,
                         boolean recalc)

make this a smart queue when modifying queueentries

Parameters:

_automated - automate if true

isAutomated

public boolean isAutomated()

is this a smart queue when modifying queueentries

Returns:

true if this is automated

getQueueSize

public int getQueueSize()

get the queuesize attribute or if it does not exist, count queuentry elements

Overrides:

getQueueSize in class JDFAutoQueue

Returns:

the size of the queue

setStatusFromEntries

public JDFAutoQueue.EnumQueueStatus setStatusFromEntries()

set the status of this queue based on the status values of the queueentries

Returns:

the newly set Status, null if not modified

sortChildren

public void sortChildren()

sorts all child elements by alphabet

Overrides:

sortChildren in class KElement

getMaxCompletedEntries

public int getMaxCompletedEntries()

Returns:

the maxCompletedEntries

setMaxCompletedEntries

public void setMaxCompletedEntries(int _maxCompletedEntries)

set the maximum number of completed entries to keep also call cleanup if we are automated

Parameters:

_maxCompletedEntries - the maxCompletedEntries to set

getMaxRunningEntries

public int getMaxRunningEntries()

Returns:

the maxRunningEntries

setMaxRunningEntries

public void setMaxRunningEntries(int _maxRunningEntries)

Parameters:

_maxRunningEntries - the maxRunningEntries to set

setMaxWaitingEntries

public void setMaxWaitingEntries(int _maxWaitingEntries)

Parameters:

_maxWaitingEntries - the setMaxWaitingEntries to set, excluding held entries

setCleanupCallback

public void setCleanupCallback(JDFQueue.CleanupCallback _cleanupCallback)

Parameters:

_cleanupCallback - the cleanupCallback to set

setExecuteCallback

public void setExecuteCallback(JDFQueue.ExecuteCallback _callback)

Parameters:

_callback - the ExecuteCallback to set

setQueueSorter

public void setQueueSorter(java.util.Comparator<KElement> _queueSorter)

Parameters:

_queueSorter - the queueSorter to set sets the Comparator to sort this queuewith

sortChild

public void sortChild(JDFQueueEntry qe)

Parameters:

qe -