Package org.cip4.jdflib.jmf

Class JDFQueueSubmissionParams

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

org.cip4.jdflib.jmf.JDFQueueSubmissionParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IStreamWriter, IURLSetter, 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 JDFQueueSubmissionParams
extends JDFAutoQueueSubmissionParams
implements IURLSetter

See Also:

Serialized Form

Nested Class Summary

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

JDFAutoQueueSubmissionParams.EnumGangPolicy

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, JDFElement.eUnit

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	Description
JDFQueueSubmissionParams(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String qualifiedName)	Constructor for JDFQueueSubmissionParams
JDFQueueSubmissionParams(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName)
JDFQueueSubmissionParams(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName, java.lang.String myLocalName)

Method Summary

Modifier and Type	Method	Description
JDFResponse	addEntry(JDFQueue theQueue, JDFJMF responseIn)	Deprecated. use 3 parameter version
JDFResponse	addEntry(JDFQueue theQueue, JDFJMF responseIn, JDFQueueFilter filter)	add a queueentry to a queue based on the parameters of this you can get the new queueentry by getQueueEntry(0) on the response
MyPair<JDFResponse,JDFQueueEntry>	addQueueEntry(JDFQueue theQueue, JDFJMF responseIn, JDFQueueFilter filter)	add a queueentry to a queue based on the parameters of this you can get the new queueentry by getQueueEntry(0) on the response
JDFDoc	getURLDoc()	returns the jdf doc referenced by url
java.io.InputStream	getURLInputStream()	get the input stream that reads from URL
java.lang.String	getUserFileName()
void	setReturnJMF(java.net.URL url)	sets ReturnURL to the value of url
void	setReturnURL(java.net.URL url)	sets ReturnURL to the value of url
java.lang.String	toString()	toString() return String

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

appendDisposition, getCreateDisposition, getDisposition, getGangName, getGangPolicy, getHold, getNextQueueEntryID, getPrevQueueEntryID, getPriority, getrefID, getReturnJMF, getReturnURL, getTheAttributeInfo, getTheElementInfo, getURL, getWatchURL, setGangName, setGangPolicy, setHold, setNextQueueEntryID, setPrevQueueEntryID, setPriority, setrefID, setReturnJMF, setReturnURL, setURL, setWatchURL

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, getChildElementVector_JDFElement, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentText, getCommentURL, getCreateComment, getCreateComment, getCreateElement_JDFElement, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement, getElement_JDFElement, getElementIDPrefix, getElementInfo, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDListMap, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements, getInvalidElements_JDFElement, 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, getTarget, getTarget_JDFElement, 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, isInAnyCIP4NameSpaceStatic, isInAnyCIP4NameSpaceStatic, isInAnyJDFNameSpaceStatic, isInAnyJDFNameSpaceStatic, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid, isValid_JDFElement, isXJDF, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements, numChildElements_JDFElement, optionalAttributes, optionalElements, parseFile, parseFile, parseStream, parseString, 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, appendAttribute, appendAttributes, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, buildXPath, buildXPath, buildXPath, cleanup, clearNSMap, clone, copyAttribute, copyAttribute, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, ensureCase, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName, fitsName_KElement, flush, generateDotID, getAttribute, getAttribute, getAttribute, getAttribute_KElement, getAttribute_KElement, getAttributeArray_KElement, getAttributeIgnoreCase, getAttributeMap, getAttributeMap_KElement, getAttributeRaw, getAttributeVector, getAttributeVector_KElement, getBoolAttribute, getCData, getChildArray, getChildArray_KElement, getChildArrayByClass, getChildArrayByClass_KElement, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector, getChildElementVector, getChildElementVector_KElement, getChildFromList, getChildFromList, getChildList, getChildList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName, getChildrenByTagName_KElement, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getChildWithAttribute, getChildWithAttribute, getCreateChildWithAttribute, getCreateElement, getCreateElement, getCreateElement_KElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement, getElement_KElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getID, getIDPrefix, getIgnoreCase, getIgnoreCase_KElement, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNonEmpty, getNonEmpty_KElement, 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, hasAttribute, hasAttribute_KElement, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasNonEmpty, hasNonEmpty_KElement, 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, pushUp, removeAllText, removeAttribute, removeAttribute, removeAttribute_KElement, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeIgnoreCase, removeIgnoreCase_KElement, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameAttribute, renameElement, replaceElement, setAttribute, 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, 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.cip4.jdflib.ifaces.IURLSetter

getURL, setURL

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

JDFQueueSubmissionParams

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

Constructor for JDFQueueSubmissionParams

Parameters:

myOwnerDocument -

qualifiedName -

JDFQueueSubmissionParams

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

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFQueueSubmissionParams

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

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

toString

public java.lang.String toString()

toString() return String

Overrides:

toString in class KElement

Returns:

string representativ of this

See Also:

Object.toString()

addEntry

@Deprecated
public JDFResponse addEntry(JDFQueue theQueue,
                            JDFJMF responseIn)

Deprecated.

use 3 parameter version

Parameters:

theQueue -

responseIn -

Returns:

addEntry

public JDFResponse addEntry(JDFQueue theQueue,
                            JDFJMF responseIn,
                            JDFQueueFilter filter)

add a queueentry to a queue based on the parameters of this you can get the new queueentry by getQueueEntry(0) on the response

Parameters:

theQueue - the queue to submit to, note that the queue IS modified by this call

responseIn - the jmf that serves as a container for the new response

filter - the filter to apply

Returns:

the response jmf to the submission message

getURLInputStream

public java.io.InputStream getURLInputStream()

get the input stream that reads from URL

Specified by:

getURLInputStream in interface IURLSetter

Returns:

InputStream the input stream that the url points to, null if the url is inaccessible

addQueueEntry

public MyPair<JDFResponse,JDFQueueEntry> addQueueEntry(JDFQueue theQueue,
                                                             JDFJMF responseIn,
                                                             JDFQueueFilter filter)

add a queueentry to a queue based on the parameters of this you can get the new queueentry by getQueueEntry(0) on the response

Parameters:

theQueue - the queue to submit to, note that the queue IS modified by this call

responseIn - the jmf that serves as a container for the new response

filter - the filter to apply

Returns:

the response jmf to the submission message

getURLDoc

public JDFDoc getURLDoc()

returns the jdf doc referenced by url

Returns:

the document

getUserFileName

public java.lang.String getUserFileName()

Specified by:

getUserFileName in interface IURLSetter

Returns:

the filename of this; null if not implemented

setReturnURL

public void setReturnURL(java.net.URL url)

sets ReturnURL to the value of url

Parameters:

url - the URL to set

setReturnJMF

public void setReturnJMF(java.net.URL url)

sets ReturnURL to the value of url

Parameters:

url - the URL to set