org.cip4.jdflib.jmf
Class JDFQueueFilter

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.JDFAutoQueueFilter
                                  org.cip4.jdflib.jmf.JDFQueueFilter

All Implemented Interfaces:

Serializable, Cloneable, INodeIdentifiable, Element, EventTarget, Node, NodeList, TypeInfo

public class JDFQueueFilter
extends JDFAutoQueueFilter
implements INodeIdentifiable

See Also:

Serialized Form

Nested Class Summary

protected class

JDFQueueFilter.QueueEntryMatcher

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

JDFAutoQueueFilter.EnumPreviewUsages, JDFAutoQueueFilter.EnumQueueEntryDetails, JDFAutoQueueFilter.EnumStatusList, JDFAutoQueueFilter.EnumUpdateGranularity

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

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

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

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

Method Summary

JDFDevice	appendDevice(String deviceID) append a Device element with @DeviceID
JDFQueueEntryDef	appendQueueEntryDef(String queueEntryID)
JDFQueue	apply(JDFQueue theQueue, JDFQueue lastQueue) Deprecated. - use copyTo modifies queue to match this filter by removing all non-matching entries make sure that this is a copy of any original queue as the incoming queue itself is not cloned
JDFQueue	copy(JDFQueue theQueue, JDFQueue lastQueue, KElement resp) copy theQueue to newParent while applying the filter
Set<String>	getDeviceIDSet() get the list of Device/@DeviceIDs strings as a set
NodeIdentifier	getIdentifier()
VJDFAttributeMap	getPartMapVector() GetPartMapVector returns a vector of partmaps, null if no parts are present
Set<String>	getQueueEntryDefSet() get the list of QueueEntryDef/@QueueEntryIDs strings as a set
JDFAutoQueueFilter.EnumQueueEntryDetails	getQueueEntryDetails() (9) get attribute QueueEntryDetails
Vector<JDFAutoQueueEntry.EnumQueueEntryStatus>	getStatusList() (9.2) get StatusList attribute StatusList
JDFQueue	match(JDFQueue theQueue) Deprecated. use the 2 parameter version
boolean	matches(JDFQueueEntry qe) return true if the queuentry matches this filter
void	setIdentifier(NodeIdentifier ni)
void	setPartMapVector(VJDFAttributeMap vPart) SetPartMapVector
String	toString() toString

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

appendDevice, appendPart, appendQueueEntryDef, getAllDevice, getAllPart, getAllQueueEntryDef, getCreateDevice, getCreatePart, getCreateQueueEntryDef, getDevice, getGangNames, getJobID, getJobPartID, getMaxEntries, getNewerThan, getOlderThan, getPart, getPreviewUsages, getQueueEntryDef, getTheAttributeInfo, getTheElementInfo, getUpdateGranularity, setGangNames, setJobID, setJobPartID, setMaxEntries, setNewerThan, setOlderThan, setPreviewUsages, setQueueEntryDetails, setStatusList, setUpdateGranularity

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

JDFQueueFilter

public JDFQueueFilter(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                      String qualifiedName)

Constructor for JDFQueueFilter

Parameters:

myOwnerDocument -

qualifiedName -

JDFQueueFilter

public JDFQueueFilter(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                      String myNamespaceURI,
                      String qualifiedName)

Constructor for JDFQueueFilter

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFQueueFilter

public JDFQueueFilter(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                      String myNamespaceURI,
                      String qualifiedName,
                      String myLocalName)

Constructor for JDFQueueFilter

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

toString

public String toString()

toString

Overrides:

toString in class JDFAutoQueueFilter

Returns:

String

See Also:

Object.toString()

getPartMapVector

public VJDFAttributeMap getPartMapVector()

GetPartMapVector returns a vector of partmaps, null if no parts are present

Overrides:

getPartMapVector in class JDFElement

Returns:

VJDFAttributeMap

setPartMapVector

public void setPartMapVector(VJDFAttributeMap vPart)

SetPartMapVector

Overrides:

setPartMapVector in class JDFElement

Parameters:

vPart -

match

@Deprecated
public JDFQueue match(JDFQueue theQueue)

Deprecated. use the 2 parameter version

modifies queue to match this filter by removing all non-matching entries make sure that this is a copy of any original queue as the incoming queue itself is not cloned

Parameters:

theQueue - the queue to modify

Returns:

apply

@Deprecated
public JDFQueue apply(JDFQueue theQueue,
                                 JDFQueue lastQueue)

Deprecated. - use copyTo modifies queue to match this filter by removing all non-matching entries make sure that this is a copy of any original queue as the incoming queue itself is not cloned

Parameters:

theQueue - the queue to modify

lastQueue - the last queue to diff against, note that this must be the complete queue prior to the last call of match

Returns:

getQueueEntryDetails

public JDFAutoQueueFilter.EnumQueueEntryDetails getQueueEntryDetails()

(9) get attribute QueueEntryDetails

Overrides:

getQueueEntryDetails in class JDFAutoQueueFilter

Returns:

the value of the attribute

matches

public boolean matches(JDFQueueEntry qe)

return true if the queuentry matches this filter

Parameters:

qe - the queueentry to check

Returns:

getStatusList

public Vector<JDFAutoQueueEntry.EnumQueueEntryStatus> getStatusList()

(9.2) get StatusList attribute StatusList

Overrides:

getStatusList in class JDFAutoQueueFilter

Returns:

Vector of the enumerations this version uses queueEntryStatus rather than an own enumeration

getQueueEntryDefSet

public Set<String> getQueueEntryDefSet()

get the list of QueueEntryDef/@QueueEntryIDs strings as a set

Returns:

the set of QueueEntryIDs, null if no QueueEntryDef is specified

getDeviceIDSet

public Set<String> getDeviceIDSet()

get the list of Device/@DeviceIDs strings as a set

Returns:

the set of DeviceIDs, null if no Device is specified

appendDevice

public JDFDevice appendDevice(String deviceID)
                       throws JDFException

append a Device element with @DeviceID

Parameters:

deviceID - the deviceID to set

Returns:

Throws:

JDFException

See Also:

JDFAutoQueueFilter.appendDevice()

appendQueueEntryDef

public JDFQueueEntryDef appendQueueEntryDef(String queueEntryID)
                                     throws JDFException

Parameters:

queueEntryID - the queueEntryID to set

Returns:

Throws:

JDFException

See Also:

JDFAutoQueueFilter.appendQueueEntryDef()

copy

public JDFQueue copy(JDFQueue theQueue,
                     JDFQueue lastQueue,
                     KElement resp)

copy theQueue to newParent while applying the filter

Parameters:

theQueue - the queue to copy

lastQueue - the previously created queue

resp - the JDF response message, may be null

Returns:

getIdentifier

public NodeIdentifier getIdentifier()

Specified by:

getIdentifier in interface INodeIdentifiable

Returns:

See Also:

INodeIdentifiable.getIdentifier()

setIdentifier

public void setIdentifier(NodeIdentifier ni)

Specified by:

setIdentifier in interface INodeIdentifiable

Parameters:

ni -

See Also:

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