Package org.cip4.jdflib.jmf
Class JDFMessage
- 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.JDFAutoMessage
-
- org.cip4.jdflib.jmf.JDFMessage
-
- 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
- Direct Known Subclasses:
JDFAutoAcknowledge,JDFAutoCommand,JDFAutoQuery,JDFAutoRegistration,JDFAutoResponse,JDFAutoSignal
public class JDFMessage extends JDFAutoMessage
super class for all message families Signal, Command,...- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classJDFMessage.EnumFamilyEnumerations for message familiesstatic classJDFMessage.EnumType-
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.MultiAttributeComparator, KElement.SimpleElementNameComparator, KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator
-
-
Field Summary
-
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
-
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
-
-
Constructor Summary
Constructors Constructor Description JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String qualifiedName)Constructor for JDFMessageJDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName)Constructor for JDFMessageJDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName, java.lang.String myLocalName)Constructor for JDFMessage
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description JDFAbortQueueEntryParamsappendAbortQueueEntryParams()JDFDeviceappendDevice()append elementDeviceJDFDeviceFilterappendDeviceFilter()append elementDeviceFilterJDFDeviceInfoappendDeviceInfo()append elementDeviceInfoJDFDeviceListappendDeviceList()Append elementDeviceListJDFEmployeeDefappendEmployeeDef()Append elementEmployeeDefJDFFlushedResourcesappendFlushedResources()append elementFlushedResourcesJDFFlushQueueInfoappendFlushQueueInfo()JDFFlushQueueParamsappendFlushQueueParams()JDFFlushResourceParamsappendFlushResourceParams()JDFGangCmdFilterappendGangCmdFilter()append elementIDInfoJDFIDInfo: the elementJDFGangInfoappendGangInfo()Append elementGangInfoJDFGangQuFilterappendGangQuFilter()append elementIDInfoJDFIDInfo: the elementJDFIDInfoappendIDInfo()append elementIDInfoJDFIDInfo: the elementJDFJDFControllerappendJDFController()Append elementJDFControllerJDFJDFServiceappendJDFService()Append elementJDFServiceJDFJobPhaseappendJobPhase()append elementJobPhaseJDFKnownMsgQuParamsappendKnownMsgQuParams()append elementKnownMsgQuParamsJDFMessageServiceappendMessageService()append elementMessageServiceJDFModifyNodeCmdParamsappendModifyNodeCmdParams()JDFMsgFilterappendMsgFilter()append elementMsgFilterJDFNewJDFCmdParamsappendNewJDFCmdParams()JDFNewJDFQuParamsappendNewJDFQuParams()JDFNodeInfoCmdParamsappendNodeInfoCmdParams()JDFNodeInfoQuParamsappendNodeInfoQuParams()JDFNodeInfoRespappendNodeInfoResp()JDFNotificationDefappendNotificationDef()append elementNotificationDefJDFNotificationFilterappendNotificationFilter()append elementNotificationFilterJDFOccupationappendOccupation()append elementOccupationJDFPipeParamsappendPipeParams()append elementPipeParamsJDFQueueappendQueue()append elementQueueJDFQueueEntryappendQueueEntry()append elementQueueEntryJDFQueueEntryDefappendQueueEntryDef()append elementQueueEntryDefJDFQueueEntryDefListappendQueueEntryDefList()append elementQueueEntryDefListJDFQueueEntryPosParamsappendQueueEntryPosParams()append elementQueueEntryPosParamsJDFQueueEntryPriParamsappendQueueEntryPriParams()append elementQueueEntryPriParamsJDFQueueFilterappendQueueFilter()JDFQueueSubmissionParamsappendQueueSubmissionParams()append elementQueueSubmissionParamsJDFRequestQueueEntryParamsappendRequestQueueEntryParams()JDFResourceCmdParamsappendResourceCmdParams()append elementResourceCmdParamsJDFResourceInfoappendResourceInfo()append elementResourceInfoJDFResourcePullParamsappendResourcePullParams()JDFResourceQuParamsappendResourceQuParams()append elementResourceQuParamsJDFResubmissionParamsappendResubmissionParams()JDFReturnQueueEntryParamsappendReturnQueueEntryParams()JDFShutDownCmdParamsappendShutDownCmdParams()JDFStatusQuParamsappendStatusQuParams()append elementStatusQuParamsJDFStopPersChParamsappendStopPersChParams()append elementStopPersChParamsJDFSubmissionMethodsappendSubmissionMethods()append elementSubmissionMethodsJDFSubscriptionFilterappendSubscriptionFilter()JDFSubscriptionInfoappendSubscriptionInfo()JDFTrackFilterappendTrackFilter()append elementTrackFilterJDFTrackResultappendTrackResult()append elementTrackResultJDFUpdateJDFCmdParamsappendUpdateJDFCmdParams()KElementappendValidElement(java.lang.String elementName)Deprecated.use appendValidElement(elementName, null);KElementappendValidElement(java.lang.String elementName, java.lang.String nameSpaceURI)append an element
throws a JDFException, ifelementNameis not legal and strictValidation is switched onJDFWakeUpCmdParamsappendWakeUpCmdParams()JDFJMFcreateResponse()create a new response for this if this is any message except response correctly fills refId, type etc.JDFJMFcreateSignal()create a new signal for this if this is any message except response correctly fills refId, type etc.JDFAbortQueueEntryParamsgetAbortQueueEntryParams()JDFAbortQueueEntryParamsgetCreateAbortQueueEntryParams()JDFDevicegetCreateDevice(int iSkip)get device, create if it doesn't existJDFDeviceFiltergetCreateDeviceFilter(int iSkip)get iSkip'th elementDeviceFilter, create if it doesn't existJDFDeviceInfogetCreateDeviceInfo(int iSkip)get elementDeviceInfo, create if it doesn't existJDFDeviceInfogetCreateDeviceInfo(java.lang.String deviceID)get a matching deviceInfo for a given DeviceID, create it if it does not existJDFDeviceListgetCreateDeviceList(int iSkip)get ElementDeviceList, create if it doesn't existJDFEmployeeDefgetCreateEmployeeDef(int iSkip)get elementEmployeeDef, create if it doesn't existJDFFlushedResourcesgetCreateFlushedResources(int iSkip)get iSkip'th element FlushedResourcesJDFFlushQueueInfogetCreateFlushQueueInfo(int iSkip)JDFFlushQueueParamsgetCreateFlushQueueParams(int iSkip)JDFFlushResourceParamsgetCreateFlushResourceParams(int iSkip)JDFGangInfogetCreateGangInfo(int iSkip)get iSkip'th elementGangInfo, create if it doesn't existJDFIDInfogetCreateIDInfo(int iSkip)get iSkip'th elementIDInfo, create if it doesn't existJDFJDFControllergetCreateJDFController(int iSkip)get ElementJDFController, create if it doesn't existJDFJDFServicegetCreateJDFService(int iSkip)get iSkip'th elementJDFService, create if it doesn't existJDFJobPhasegetCreateJobPhase(int iSkip)get ElementJobPhase, create if it doesn't existJDFKnownMsgQuParamsgetCreateKnownMsgQuParams(int iSkip)get iSkip'thKnownMsgQuParamselement, create if it doesn't existJDFMessageServicegetCreateMessageService(int iSkip)get iSkip'th elementMessageService, create if it doesn't existJDFModifyNodeCmdParamsgetCreateModifyNodeCmdParams()JDFMsgFiltergetCreateMsgFilter(int iSkip)get elementMsgFilter, create if it doesn't existJDFNewJDFCmdParamsgetCreateNewJDFCmdParams(int iSkip)JDFNewJDFQuParamsgetCreateNewJDFQuParams(int iSkip)JDFNodeInfoCmdParamsgetCreateNodeInfoCmdParams(int iSkip)JDFNodeInfoQuParamsgetCreateNodeInfoQuParams(int iSkip)JDFNodeInfoRespgetCreateNodeInfoResp(int iSkip)JDFNotificationDefgetCreateNotificationDef(int iSkip)get elementNotificationDef, create if it doesn't existJDFNotificationFiltergetCreateNotificationFilter(int iSkip)get elementNotificationFilter, create if it doesn't existJDFOccupationgetCreateOccupation(int iSkip)get iSkip'thOccupationelementJDFPipeParamsgetCreatePipeParams(int iSkip)get iSkip'th elementPipeParamsJDFQueuegetCreateQueue(int iSkip)get iSkip'th elementQueueJDFQueueEntrygetCreateQueueEntry(int iSkip)get iSkip'th elementQueueEntry, create if it doesn't existJDFQueueEntryDefgetCreateQueueEntryDef(int iSkip)get iSkip'th elementQueueEntryDef, create if it doesn't existJDFQueueEntryDefListgetCreateQueueEntryDefList(int iSkip)get iSkip'th element QueueEntryDefList, create if it doesn't existJDFQueueEntryPosParamsgetCreateQueueEntryPosParams(int iSkip)get iSkip'th element QueueEntryPosParams, create if it doesn't existJDFQueueEntryPriParamsgetCreateQueueEntryPriParams(int iSkip)get iSkip'th elementQueueEntryPriParamsJDFQueueFiltergetCreateQueueFilter(int iSkip)JDFQueueSubmissionParamsgetCreateQueueSubmissionParams(int iSkip)get iSkip'th elementQueueSubmissionParamsJDFRequestQueueEntryParamsgetCreateRequestQueueEntryParams(int iSkip)JDFResourceCmdParamsgetCreateResourceCmdParams(int iSkip)get iSkip'th elementResourceCmdParamsJDFResourceInfogetCreateResourceInfo(int iSkip)get iSkip'th elementResourceInfoJDFResourceQuParamsgetCreateResourceQuParams(int iSkip)get iSkip'th elementResourceQuParamsJDFResubmissionParamsgetCreateResubmissionParams(int iSkip)JDFReturnQueueEntryParamsgetCreateReturnQueueEntryParams(int iSkip)JDFShutDownCmdParamsgetCreateShutDownCmdParams(int iSkip)JDFStatusQuParamsgetCreateStatusQuParams(int iSkip)get iSkip'th elementStatusQuParams, create if it doesn't existJDFStopPersChParamsgetCreateStopPersChParams(int iSkip)get iSkip'th element StopPersChParamsJDFSubmissionMethodsgetCreateSubmissionMethods(int iSkip)get iSkip'th elementSubmissionMethodsJDFSubscriptionFiltergetCreateSubscriptionFilter()JDFSubscriptionInfogetCreateSubscriptionInfo(int iSkip)JDFTrackFiltergetCreateTrackFilter(int iSkip)get iSkip'th elementTrackFilterJDFTrackResultgetCreateTrackResult(int iSkip)get iSkip'th elementTrackResultJDFUpdateJDFCmdParamsgetCreateUpdateJDFCmdParams()KElementgetCreateValidElement(java.lang.String nodeName, java.lang.String nameSpaceURI, int iSkip)get a (valid) element, create if it doesn't exist
throwsJDFExceptionif the element is not valid and strictValidation is switched onJDFWakeUpCmdParamsgetCreateWakeUpCmdParams()VStringgetDeprecatedElements(int nMax)Vector of deprecated elements below the current element.JDFDevicegetDevice(int iSkip)get the iSkip'th deviceJDFDeviceFiltergetDeviceFilter(int iSkip)get iSkip'th elementDeviceFilterJDFDeviceInfogetDeviceInfo(int iSkip)get iSkip'th elementDeviceInfoJDFDeviceInfogetDeviceInfo(java.lang.String deviceID)get a matching deviceInfo for a given DeviceIDJDFDeviceListgetDeviceList(int iSkip)get iSkip'th DeviceList elementJDFEmployeeDefgetEmployeeDef(int iSkip)get iSkip'th elementEmployeeDefJDFMessage.EnumTypegetEnumType()Typesafe enumerated attribute TypeJDFMessage.EnumFamilygetFamily()getFamily: get the enum family typeJDFFlushedResourcesgetFlushedResources(int iSkip)JDFFlushQueueInfogetFlushQueueInfo(int iSkip)JDFFlushQueueParamsgetFlushQueueParams(int iSkip)JDFFlushResourceParamsgetFlushResourceParams(int iSkip)JDFGangInfogetGangInfo(int iSkip)get iSkip'thGangInfoelementVStringgetICSVersions()(21) get VString attribute ICSVersions, grab from parent JMF if none exists hereJDFIDInfogetIDInfo(int iSkip)get iSkip'th elementIDInfojava.lang.StringgetIDPrefix()getIDPrefixVStringgetInvalidAttributes(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)get invalid attributesVStringgetInvalidElements(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)get invalid elementsJDFJDFControllergetJDFController(int iSkip)get iSkip'th JDFController elementJDFGangCmdFiltergetJDFGangCmdFilter(int iSkip)get iSkip'th elementIDInfoJDFGangQuFiltergetJDFGangQuFilter(int iSkip)get iSkip'th elementIDInfoJDFJDFServicegetJDFService(int iSkip)get iSkip'thJDFServiceelementJDFJobPhasegetJobPhase(int iSkip)get iSkip'thJobPhaseelementJDFKnownMsgQuParamsgetKnownMsgQuParams(int iSkip)get iSkip'thKnownMsgQuParamsJDFElement.EnumVersiongetLastVersion(java.lang.String eaName, boolean bElement)get the last JDF version where attribute name or element name is validJDFMessageServicegetMessageService(int iSkip)get iSkip'th elementMessageServiceJDFModifyNodeCmdParamsgetModifyNodeCmdParams()JDFMsgFiltergetMsgFilter(int iSkip)get iSkip'th elementMsgFilterJDFNewJDFCmdParamsgetNewJDFCmdParams(int iSkip)JDFNewJDFQuParamsgetNewJDFQuParams(int iSkip)JDFNodeInfoCmdParamsgetNodeInfoCmdParams(int iSkip)JDFNodeInfoQuParamsgetNodeInfoQuParams(int iSkip)JDFNodeInfoRespgetNodeInfoResp(int iSkip)JDFNotificationDefgetNotificationDef(int iSkip)get iSkip'th elementNotificationDefJDFNotificationFiltergetNotificationFilter(int iSkip)get iSkip'thNotificationFilterelementJDFOccupationgetOccupation(int iSkip)get iSkip'th elementOccupationJDFPipeParamsgetPipeParams()get elementPipeParamsJDFPipeParamsgetPipeParams(int iSkip)Deprecated.- use the 0 parameter versionJDFQueuegetQueue(int iSkip)get iSkip'th elementQueueJDFQueueEntrygetQueueEntry(int iSkip)get iSkip'th elementQueueEntryJDFQueueEntryDefgetQueueEntryDef(int iSkip)get iSkip'th elementQueueEntryDefJDFQueueEntryDefListgetQueueEntryDefList(int iSkip)get iSkip'th elementQueueEntryDefListJDFQueueEntryPosParamsgetQueueEntryPosParams(int iSkip)get iSkip'th elementQeueEntryPosParamsJDFQueueEntryPriParamsgetQueueEntryPriParams(int iSkip)get iSkip'th elementQueueEntryPriParamsJDFQueueFiltergetQueueFilter(int iSkip)JDFQueueSubmissionParamsgetQueueSubmissionParams(int iSkip)get iSkip'th elementQueueSubmissionParamsjava.lang.StringgetrefID()Method getrefID.JDFRequestQueueEntryParamsgetRequestQueueEntryParams(int iSkip)JDFResourceCmdParamsgetResourceCmdParams(int iSkip)get iSkip'th elementResourceCmdParamsJDFResourceInfogetResourceInfo(int iSkip)get iSkip'th elementResourceInfoJDFResourcePullParamsgetResourcePullParams(int iSkip)JDFResourceQuParamsgetResourceQuParams()get first elementResourceQuParamsJDFResourceQuParamsgetResourceQuParams(int iSkip)Deprecated.use null parameter versionJDFResubmissionParamsgetResubmissionParams(int iSkip)intgetReturnCode()Returns the ReturnCode; applies to JmfResponse and JmfAcknowledge.JDFReturnQueueEntryParamsgetReturnQueueEntryParams(int iSkip)java.lang.StringgetSenderID()gets the senderID of this messageJDFShutDownCmdParamsgetShutDownCmdParams(int iSkip)JDFStatusQuParamsgetStatusQuParams()get StatusQuParamsJDFStatusQuParamsgetStatusQuParams(int iSkip)Deprecated.- use 0 parameter versionJDFStopPersChParamsgetStopPersChParams(int iSkip)get iSkip'th elementStopPersChParamsJDFSubmissionMethodsgetSubmissionMethods(int iSkip)get iSkip'th elementSubMissionMethodsJDFSubscriptionFiltergetSubscriptionFilter()JDFSubscriptionInfogetSubscriptionInfo(int iSkip)protected AttributeInfogetTheAttributeInfo()protected ElementInfogetTheElementInfo()JDFDategetTime()(12) get JDFDate attribute TimeJDFTrackFiltergetTrackFilter(int iSkip)get iSkip'th elementTrackFilterJDFTrackResultgetTrackResult(int iSkip)get the iSkip'th elementTrackResultjava.lang.StringgetType()getType: get attributeTypeJDFUpdateJDFCmdParamsgetUpdateJDFCmdParams()KElementgetValidElement(java.lang.String nodeName, java.lang.String nameSpaceURI, int iSkip)get a (valid) element
throwsJDFExceptionif the element is not valid and strictValidation is switched onJDFWakeUpCmdParamsgetWakeUpCmdParams()booleaninit()initbooleanisMessageElement()Deprecated.use instanceof JDFMessagestatic booleanisStrictValidation()if true, all typesafe calls are strictly validatedbooleanisValidMessageElement(java.lang.String elementName, int iSkip)checks whether the type of messageElement is valid for this messageVStringoptionalElements()definition of optional elements in the JDF namespacevoidsetEnumType(JDFMessage.EnumType value)Deprecated.use setType()voidsetQuery(JDFMessage q)SetQuery - sets the initiating query, command, Acknowledge, Signal or registration to qvoidsetrefID(java.lang.String refID)Method setrefID.static voidsetStrictValidation(boolean strictValidation)set false to switch off jmf validation when adding elements set true (default) to enable run time checking when constructing JMF messagesvoidsetType(java.lang.String typ)Set attributeTypeandxsi:typevoidsetType(JDFMessage.EnumType value)Set attribute Typestatic java.lang.StringtypeString()Deprecated.use EnumType to get stringsstatic java.lang.StringtypeString(JDFMessage.EnumType value)Enumeration string for enum value-
Methods inherited from class org.cip4.jdflib.auto.JDFAutoMessage
getAgentName, getAgentVersion, getID, setAgentName, setAgentVersion, setICSVersions, setID, setSenderID, setTime
-
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, 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, getInvalidElements_JDFElement, getJDFRoot, getJMFRoot, 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, 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, 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, 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, setIntAttribute, setNamespaceURI, setNodeValue, setNonEmpty, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, sortChildren, sortChildren, toDisplayXML, toString, 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
-
JDFMessage
public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String qualifiedName)Constructor for JDFMessage- Parameters:
myOwnerDocument-qualifiedName-
-
JDFMessage
public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName)Constructor for JDFMessage- Parameters:
myOwnerDocument-myNamespaceURI-qualifiedName-
-
JDFMessage
public JDFMessage(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument, java.lang.String myNamespaceURI, java.lang.String qualifiedName, java.lang.String myLocalName)Constructor for JDFMessage- Parameters:
myOwnerDocument-myNamespaceURI-qualifiedName-myLocalName-
-
-
Method Detail
-
isStrictValidation
public static boolean isStrictValidation()
if true, all typesafe calls are strictly validated- Returns:
- the strictValidation
-
setStrictValidation
public static void setStrictValidation(boolean strictValidation)
set false to switch off jmf validation when adding elements set true (default) to enable run time checking when constructing JMF messages- Parameters:
strictValidation- the strictValidation to set
-
getTheAttributeInfo
protected AttributeInfo getTheAttributeInfo()
- Overrides:
getTheAttributeInfoin classJDFAutoMessage- Returns:
-
getTheElementInfo
protected ElementInfo getTheElementInfo()
- Overrides:
getTheElementInfoin classJDFElement- Returns:
- the elementinfo
-
isMessageElement
@Deprecated public boolean isMessageElement()
Deprecated.use instanceof JDFMessageIsMessageElement - is a message with this name a message element?- Returns:
- boolean
-
init
public boolean init()
init- Overrides:
initin classJDFElement- Returns:
- boolean
- See Also:
KElement.init()
-
getIDPrefix
public java.lang.String getIDPrefix()
getIDPrefix- Overrides:
getIDPrefixin classKElement- Returns:
- the ID prefix of JDFMessage
-
getFamily
public JDFMessage.EnumFamily getFamily()
getFamily: get the enum family type- Returns:
- EnumFamily - type Family_Unknown, Family_Query, Family_Signal, Family_Command, Family_Response or Family_Acknowledge
-
getType
public java.lang.String getType()
getType: get attributeType- Overrides:
getTypein classJDFAutoMessage- Returns:
- String
-
setType
public void setType(java.lang.String typ)
Set attributeTypeandxsi:type- Overrides:
setTypein classJDFAutoMessage- Parameters:
typ- the type
-
setQuery
public void setQuery(JDFMessage q)
SetQuery - sets the initiating query, command, Acknowledge, Signal or registration to q- Parameters:
q- the query, command or registration to create a response for
-
typeString
public static java.lang.String typeString(JDFMessage.EnumType value)
Enumeration string for enum value- Parameters:
value- the enumeration to translate- Returns:
- String the string representation of the enumeration
-
typeString
@Deprecated public static java.lang.String typeString()
Deprecated.use EnumType to get strings- Returns:
-
setEnumType
@Deprecated public void setEnumType(JDFMessage.EnumType value)
Deprecated.use setType()Set attribute Type- Parameters:
value- the value to set the attribute to
-
setType
public void setType(JDFMessage.EnumType value)
Set attribute Type- Parameters:
value- the value to set the attribute to
-
createResponse
public JDFJMF createResponse()
create a new response for this if this is any message except response correctly fills refId, type etc.- Returns:
- the newly created message
-
createSignal
public JDFJMF createSignal()
create a new signal for this if this is any message except response correctly fills refId, type etc.- Returns:
- the newly created message
-
isValidMessageElement
public boolean isValidMessageElement(java.lang.String elementName, int iSkip)checks whether the type of messageElement is valid for this message- Parameters:
elementName- the name of the element to be testediSkip-- Returns:
- boolean: true if valid; always true if not in JDFNameSpace
-
getEnumType
public JDFMessage.EnumType getEnumType()
Typesafe enumerated attribute Type- Returns:
- EnumType: the enumeration value of the attribute
-
appendValidElement
public KElement appendValidElement(java.lang.String elementName, java.lang.String nameSpaceURI)
append an element
throws a JDFException, ifelementNameis not legal and strictValidation is switched on- Parameters:
elementName- name of the element to appendnameSpaceURI- namespace URI of the element to append- Returns:
- the appended element
-
appendValidElement
@Deprecated public KElement appendValidElement(java.lang.String elementName)
Deprecated.use appendValidElement(elementName, null);- Parameters:
elementName-- Returns:
-
getValidElement
public KElement getValidElement(java.lang.String nodeName, java.lang.String nameSpaceURI, int iSkip)
get a (valid) element
throwsJDFExceptionif the element is not valid and strictValidation is switched on- Parameters:
nodeName- name of the element to getnameSpaceURI- namespace URI of the element to getiSkip- number of elements to skip- Returns:
- the element
-
getCreateValidElement
public KElement getCreateValidElement(java.lang.String nodeName, java.lang.String nameSpaceURI, int iSkip)
get a (valid) element, create if it doesn't exist
throwsJDFExceptionif the element is not valid and strictValidation is switched on- Parameters:
nodeName- name of the element to getnameSpaceURI- namespace URI of the element to getiSkip- number of elements to skip- Returns:
- KElement
-
getCreateDevice
public JDFDevice getCreateDevice(int iSkip)
get device, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDevice
-
appendDevice
public JDFDevice appendDevice()
append elementDevice- Returns:
- JDFDevice: the element
-
getDevice
public JDFDevice getDevice(int iSkip)
get the iSkip'th device- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDevice: the element
-
getCreateDeviceFilter
public JDFDeviceFilter getCreateDeviceFilter(int iSkip)
get iSkip'th elementDeviceFilter, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceFilter: the element
-
appendDeviceFilter
public JDFDeviceFilter appendDeviceFilter()
append elementDeviceFilter- Returns:
- JDFDeviceFilter: the element
-
getDeviceFilter
public JDFDeviceFilter getDeviceFilter(int iSkip)
get iSkip'th elementDeviceFilter- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceFilter: the element
-
getCreateDeviceInfo
public JDFDeviceInfo getCreateDeviceInfo(int iSkip)
get elementDeviceInfo, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceInfo: the element
-
appendDeviceInfo
public JDFDeviceInfo appendDeviceInfo()
append elementDeviceInfo- Returns:
- JDFDeviceInfo: the element
-
getDeviceInfo
public JDFDeviceInfo getDeviceInfo(int iSkip)
get iSkip'th elementDeviceInfo- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceInfo: the element
-
getDeviceInfo
public JDFDeviceInfo getDeviceInfo(java.lang.String deviceID)
get a matching deviceInfo for a given DeviceID- Parameters:
deviceID- the deviceID of the device to get- Returns:
-
getCreateDeviceInfo
public JDFDeviceInfo getCreateDeviceInfo(java.lang.String deviceID)
get a matching deviceInfo for a given DeviceID, create it if it does not exist- Parameters:
deviceID- the deviceID of the device to get- Returns:
-
getCreateDeviceList
public JDFDeviceList getCreateDeviceList(int iSkip)
get ElementDeviceList, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceList: the element
-
appendDeviceList
public JDFDeviceList appendDeviceList()
Append elementDeviceList- Returns:
- JDFDeviceList the element
-
getDeviceList
public JDFDeviceList getDeviceList(int iSkip)
get iSkip'th DeviceList element- Parameters:
iSkip- number of elements to skip- Returns:
- JDFDeviceList: the element
-
getCreateEmployeeDef
public JDFEmployeeDef getCreateEmployeeDef(int iSkip)
get elementEmployeeDef, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFEmployeeDef: the element
-
appendEmployeeDef
public JDFEmployeeDef appendEmployeeDef()
Append elementEmployeeDef- Returns:
- JDFEmployeeDef: the element
-
getEmployeeDef
public JDFEmployeeDef getEmployeeDef(int iSkip)
get iSkip'th elementEmployeeDef- Parameters:
iSkip- number of elements to skip- Returns:
- JDFEmployeeDef: the element
-
getCreateJDFController
public JDFJDFController getCreateJDFController(int iSkip)
get ElementJDFController, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFJDFController: the element
-
appendJDFController
public JDFJDFController appendJDFController()
Append elementJDFController- Returns:
- JDFJDFController: the element
-
getJDFController
public JDFJDFController getJDFController(int iSkip)
get iSkip'th JDFController element- Parameters:
iSkip- number of elemts to skip- Returns:
- JDFJDFController: the element
-
getCreateJDFService
public JDFJDFService getCreateJDFService(int iSkip)
get iSkip'th elementJDFService, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFJDFService: the element
-
appendJDFService
public JDFJDFService appendJDFService()
Append elementJDFService- Returns:
- JDFJDFService the element
-
getJDFService
public JDFJDFService getJDFService(int iSkip)
get iSkip'thJDFServiceelement- Parameters:
iSkip- number of elements to skip- Returns:
- JDFJDFService: the element
-
getCreateGangInfo
public JDFGangInfo getCreateGangInfo(int iSkip)
get iSkip'th elementGangInfo, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFGangInfo: the element
-
appendGangInfo
public JDFGangInfo appendGangInfo()
Append elementGangInfo- Returns:
- JDFGangInfo the element
-
getGangInfo
public JDFGangInfo getGangInfo(int iSkip)
get iSkip'thGangInfoelement- Parameters:
iSkip- number of elements to skip- Returns:
- JDFGangInfo: the element
-
getCreateJobPhase
public JDFJobPhase getCreateJobPhase(int iSkip)
get ElementJobPhase, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFJobPhase: the element
-
appendJobPhase
public JDFJobPhase appendJobPhase()
append elementJobPhase- Returns:
- JDFJobPhase: the element
-
getJobPhase
public JDFJobPhase getJobPhase(int iSkip)
get iSkip'thJobPhaseelement- Parameters:
iSkip- elements to skip- Returns:
- JDFJobPhase: the element
-
getCreateKnownMsgQuParams
public JDFKnownMsgQuParams getCreateKnownMsgQuParams(int iSkip)
get iSkip'thKnownMsgQuParamselement, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFKnownMsgQuParams the element
-
appendKnownMsgQuParams
public JDFKnownMsgQuParams appendKnownMsgQuParams()
append elementKnownMsgQuParams- Returns:
- JDFKnownMsgQuParams: the element
-
getKnownMsgQuParams
public JDFKnownMsgQuParams getKnownMsgQuParams(int iSkip)
get iSkip'thKnownMsgQuParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFKnownMsgQuParams: the element
-
getCreateMessageService
public JDFMessageService getCreateMessageService(int iSkip)
get iSkip'th elementMessageService, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFMessageService: the element
-
appendMessageService
public JDFMessageService appendMessageService()
append elementMessageService- Returns:
-
getMessageService
public JDFMessageService getMessageService(int iSkip)
get iSkip'th elementMessageService- Parameters:
iSkip- number of elements to skip- Returns:
- JDFMessageService: the element
-
getCreateMsgFilter
public JDFMsgFilter getCreateMsgFilter(int iSkip)
get elementMsgFilter, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFMsgFilter: the element
-
appendMsgFilter
public JDFMsgFilter appendMsgFilter()
append elementMsgFilter- Returns:
- JDFMsgFilter: the element
-
getMsgFilter
public JDFMsgFilter getMsgFilter(int iSkip)
get iSkip'th elementMsgFilter- Parameters:
iSkip- number of elements to skip- Returns:
- JDFMsgFilter: the element
-
getCreateNotificationDef
public JDFNotificationDef getCreateNotificationDef(int iSkip)
get elementNotificationDef, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFNotificationDef: the element
-
appendNotificationDef
public JDFNotificationDef appendNotificationDef()
append elementNotificationDef- Returns:
- JDFNotificationDef: the element
-
getNotificationDef
public JDFNotificationDef getNotificationDef(int iSkip)
get iSkip'th elementNotificationDef- Parameters:
iSkip- number of elements to skip- Returns:
- JDFNotificationDef: the element
-
getCreateNotificationFilter
public JDFNotificationFilter getCreateNotificationFilter(int iSkip)
get elementNotificationFilter, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFNotificationFilter: the element
-
appendNotificationFilter
public JDFNotificationFilter appendNotificationFilter()
append elementNotificationFilter- Returns:
- JDFNotificationFilter: the element
-
getNotificationFilter
public JDFNotificationFilter getNotificationFilter(int iSkip)
get iSkip'thNotificationFilterelement- Parameters:
iSkip- number of elements to skip- Returns:
- JDFNotificationFilter: the element
-
getCreateOccupation
public JDFOccupation getCreateOccupation(int iSkip)
get iSkip'thOccupationelement- Parameters:
iSkip- number of elements to skip- Returns:
- JDFOccupation: the element
-
appendOccupation
public JDFOccupation appendOccupation()
append elementOccupation- Returns:
- JDFOccupation: the element
-
getOccupation
public JDFOccupation getOccupation(int iSkip)
get iSkip'th elementOccupation- Parameters:
iSkip- number of elements to skip- Returns:
- JDFOccupation: the element
-
getCreatePipeParams
public JDFPipeParams getCreatePipeParams(int iSkip)
get iSkip'th elementPipeParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFPipeParams: the element
-
appendPipeParams
public JDFPipeParams appendPipeParams()
append elementPipeParams- Returns:
- JDFPipeParams: the element
-
getPipeParams
public JDFPipeParams getPipeParams()
get elementPipeParams- Returns:
- JDFPipeParams: the element
-
getPipeParams
@Deprecated public JDFPipeParams getPipeParams(int iSkip)
Deprecated.- use the 0 parameter versionget iSkip'th elementPipeParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFPipeParams: the element
-
getCreateQueue
public JDFQueue getCreateQueue(int iSkip)
get iSkip'th elementQueue- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueue: the element
-
appendQueue
public JDFQueue appendQueue()
append elementQueue- Returns:
- JDFQueue: the element
-
getQueue
public JDFQueue getQueue(int iSkip)
get iSkip'th elementQueue- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueue: the element
-
getCreateQueueEntry
public JDFQueueEntry getCreateQueueEntry(int iSkip)
get iSkip'th elementQueueEntry, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntry: the element
-
appendQueueEntry
public JDFQueueEntry appendQueueEntry()
append elementQueueEntry- Returns:
- JDFQueueEntry: the element
-
getQueueEntry
public JDFQueueEntry getQueueEntry(int iSkip)
get iSkip'th elementQueueEntry- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntry: the element
-
getCreateQueueEntryDef
public JDFQueueEntryDef getCreateQueueEntryDef(int iSkip)
get iSkip'th elementQueueEntryDef, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryDef: the element
-
appendQueueEntryDef
public JDFQueueEntryDef appendQueueEntryDef()
append elementQueueEntryDef- Returns:
- JDFQueueEntryDef: the element
-
getQueueEntryDef
public JDFQueueEntryDef getQueueEntryDef(int iSkip)
get iSkip'th elementQueueEntryDef- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryDef: the element
-
getCreateQueueEntryDefList
public JDFQueueEntryDefList getCreateQueueEntryDefList(int iSkip)
get iSkip'th element QueueEntryDefList, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryDefList: the element
-
appendQueueEntryDefList
public JDFQueueEntryDefList appendQueueEntryDefList()
append elementQueueEntryDefList- Returns:
- JDFQueueEntryDefList: the element
-
getQueueEntryDefList
public JDFQueueEntryDefList getQueueEntryDefList(int iSkip)
get iSkip'th elementQueueEntryDefList- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryDefList: the element
-
getCreateQueueEntryPriParams
public JDFQueueEntryPriParams getCreateQueueEntryPriParams(int iSkip)
get iSkip'th elementQueueEntryPriParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryPriParams: the element
-
appendQueueEntryPriParams
public JDFQueueEntryPriParams appendQueueEntryPriParams()
append elementQueueEntryPriParams- Returns:
- JDFQueueEntryPriParams: the element
-
getQueueEntryPriParams
public JDFQueueEntryPriParams getQueueEntryPriParams(int iSkip)
get iSkip'th elementQueueEntryPriParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryPriParams: the element
-
getCreateQueueEntryPosParams
public JDFQueueEntryPosParams getCreateQueueEntryPosParams(int iSkip)
get iSkip'th element QueueEntryPosParams, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryPosParams: the element
-
appendQueueEntryPosParams
public JDFQueueEntryPosParams appendQueueEntryPosParams()
append elementQueueEntryPosParams- Returns:
- JDFQueueEntryPosParams: the element
-
getQueueEntryPosParams
public JDFQueueEntryPosParams getQueueEntryPosParams(int iSkip)
get iSkip'th elementQeueEntryPosParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueEntryPosParams: the element
-
getCreateQueueSubmissionParams
public JDFQueueSubmissionParams getCreateQueueSubmissionParams(int iSkip)
get iSkip'th elementQueueSubmissionParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueSubmissionParams: the element
-
appendQueueSubmissionParams
public JDFQueueSubmissionParams appendQueueSubmissionParams()
append elementQueueSubmissionParams- Returns:
- JDFQueueSubmissionParams: the element
-
getQueueSubmissionParams
public JDFQueueSubmissionParams getQueueSubmissionParams(int iSkip)
get iSkip'th elementQueueSubmissionParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFQueueSubmissionParams: the element
-
getCreateResourceCmdParams
public JDFResourceCmdParams getCreateResourceCmdParams(int iSkip)
get iSkip'th elementResourceCmdParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceCmdParams: the element
-
appendResourceCmdParams
public JDFResourceCmdParams appendResourceCmdParams()
append elementResourceCmdParams- Returns:
- JDFResourceCmdParams: the element
-
getResourceCmdParams
public JDFResourceCmdParams getResourceCmdParams(int iSkip)
get iSkip'th elementResourceCmdParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceCmdParams: the element
-
getCreateResourceQuParams
public JDFResourceQuParams getCreateResourceQuParams(int iSkip)
get iSkip'th elementResourceQuParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceQuParams: the element
-
appendResourceQuParams
public JDFResourceQuParams appendResourceQuParams()
append elementResourceQuParams- Returns:
- JDFResourceQuParams: the element
-
getResourceQuParams
@Deprecated public JDFResourceQuParams getResourceQuParams(int iSkip)
Deprecated.use null parameter versionget iSkip'th elementResourceQuParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceQuParams: the element
-
getResourceQuParams
public JDFResourceQuParams getResourceQuParams()
get first elementResourceQuParams- Returns:
- JDFResourceQuParams: the element
-
getCreateResourceInfo
public JDFResourceInfo getCreateResourceInfo(int iSkip)
get iSkip'th elementResourceInfo- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceInfo: the element
-
appendResourceInfo
public JDFResourceInfo appendResourceInfo()
append elementResourceInfo- Returns:
- JDFResourceInfo: the element
-
getResourceInfo
public JDFResourceInfo getResourceInfo(int iSkip)
get iSkip'th elementResourceInfo- Parameters:
iSkip- number of elements to skip- Returns:
- JDFResourceInfo: the element
-
getCreateStatusQuParams
public JDFStatusQuParams getCreateStatusQuParams(int iSkip)
get iSkip'th elementStatusQuParams, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFStatusQuParams: the element
-
appendStatusQuParams
public JDFStatusQuParams appendStatusQuParams()
append elementStatusQuParams- Returns:
- JDFStatusQuParams: the element
-
getStatusQuParams
@Deprecated public JDFStatusQuParams getStatusQuParams(int iSkip)
Deprecated.- use 0 parameter versionget iSkip'th element StatusQuParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFStatusQuParams: the element
-
getStatusQuParams
public JDFStatusQuParams getStatusQuParams()
get StatusQuParams- Returns:
- JDFStatusQuParams: the element
-
getCreateStopPersChParams
public JDFStopPersChParams getCreateStopPersChParams(int iSkip)
get iSkip'th element StopPersChParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFStopPersChParams: the element
-
appendStopPersChParams
public JDFStopPersChParams appendStopPersChParams()
append elementStopPersChParams- Returns:
- JDFStopPersChParams: the element
-
getStopPersChParams
public JDFStopPersChParams getStopPersChParams(int iSkip)
get iSkip'th elementStopPersChParams- Parameters:
iSkip- number of elements to skip- Returns:
- JDFStopPersChParams: the element
-
getCreateSubmissionMethods
public JDFSubmissionMethods getCreateSubmissionMethods(int iSkip)
get iSkip'th elementSubmissionMethods- Parameters:
iSkip- number of elements to skip- Returns:
- JDFSubmissionMethods: the element
-
appendSubmissionMethods
public JDFSubmissionMethods appendSubmissionMethods()
append elementSubmissionMethods- Returns:
- JDFSubmissionMethods: the element
-
getSubmissionMethods
public JDFSubmissionMethods getSubmissionMethods(int iSkip)
get iSkip'th elementSubMissionMethods- Parameters:
iSkip- number of elements to skip- Returns:
- JDFSubmissionMethods: the element
-
getCreateTrackFilter
public JDFTrackFilter getCreateTrackFilter(int iSkip)
get iSkip'th elementTrackFilter- Parameters:
iSkip- number of elements to skip- Returns:
- JDFTrackFilter: the element
-
appendTrackFilter
public JDFTrackFilter appendTrackFilter()
append elementTrackFilter- Returns:
- JDFTrackFilter: the element
-
getTrackFilter
public JDFTrackFilter getTrackFilter(int iSkip)
get iSkip'th elementTrackFilter- Parameters:
iSkip- number of elements to skip- Returns:
- JDFTrackFilter: the element
-
getCreateTrackResult
public JDFTrackResult getCreateTrackResult(int iSkip)
get iSkip'th elementTrackResult- Parameters:
iSkip- number of elements to skip- Returns:
- JDFTrackResult: the element
-
appendTrackResult
public JDFTrackResult appendTrackResult()
append elementTrackResult- Returns:
- JDFTrackResult: the element
-
getTrackResult
public JDFTrackResult getTrackResult(int iSkip)
get the iSkip'th elementTrackResult- Parameters:
iSkip- the number of elements to skip- Returns:
- JDFTrackResult: the element
-
getReturnCode
public int getReturnCode()
Returns the ReturnCode; applies to JmfResponse and JmfAcknowledge.- Returns:
- ConstReturnCode
-
getCreateIDInfo
public JDFIDInfo getCreateIDInfo(int iSkip)
get iSkip'th elementIDInfo, create if it doesn't exist- Parameters:
iSkip- number of elements to skip- Returns:
- JDFIDInfo: the element
-
appendIDInfo
public JDFIDInfo appendIDInfo()
append elementIDInfoJDFIDInfo: the element- Returns:
-
getIDInfo
public JDFIDInfo getIDInfo(int iSkip)
get iSkip'th elementIDInfo- Parameters:
iSkip- number of elements to skip JDFIDInfo: the element- Returns:
-
appendGangQuFilter
public JDFGangQuFilter appendGangQuFilter()
append elementIDInfoJDFIDInfo: the element- Returns:
-
getJDFGangQuFilter
public JDFGangQuFilter getJDFGangQuFilter(int iSkip)
get iSkip'th elementIDInfo- Parameters:
iSkip- number of elements to skip JDFIDInfo: the element- Returns:
-
appendGangCmdFilter
public JDFGangCmdFilter appendGangCmdFilter()
append elementIDInfoJDFIDInfo: the element- Returns:
-
getJDFGangCmdFilter
public JDFGangCmdFilter getJDFGangCmdFilter(int iSkip)
get iSkip'th elementIDInfo- Parameters:
iSkip- number of elements to skip JDFIDInfo: the element- Returns:
-
getCreateFlushedResources
public JDFFlushedResources getCreateFlushedResources(int iSkip)
get iSkip'th element FlushedResources- Parameters:
iSkip- number of elements to skip- Returns:
- JDFFlushedResources: the element
-
appendFlushedResources
public JDFFlushedResources appendFlushedResources()
append elementFlushedResources- Returns:
- JDFFlushedResources: the element
-
getFlushedResources
public JDFFlushedResources getFlushedResources(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateFlushQueueParams
public JDFFlushQueueParams getCreateFlushQueueParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateFlushQueueInfo
public JDFFlushQueueInfo getCreateFlushQueueInfo(int iSkip)
- Parameters:
iSkip-- Returns:
-
getFlushQueueInfo
public JDFFlushQueueInfo getFlushQueueInfo(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendAbortQueueEntryParams
public JDFAbortQueueEntryParams appendAbortQueueEntryParams()
- Returns:
-
getAbortQueueEntryParams
public JDFAbortQueueEntryParams getAbortQueueEntryParams()
- Returns:
-
getCreateAbortQueueEntryParams
public JDFAbortQueueEntryParams getCreateAbortQueueEntryParams()
- Returns:
-
appendFlushQueueParams
public JDFFlushQueueParams appendFlushQueueParams()
- Returns:
-
appendFlushQueueInfo
public JDFFlushQueueInfo appendFlushQueueInfo()
- Returns:
-
getFlushQueueParams
public JDFFlushQueueParams getFlushQueueParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateFlushResourceParams
public JDFFlushResourceParams getCreateFlushResourceParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendFlushResourceParams
public JDFFlushResourceParams appendFlushResourceParams()
- Returns:
-
getFlushResourceParams
public JDFFlushResourceParams getFlushResourceParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateNewJDFCmdParams
public JDFNewJDFCmdParams getCreateNewJDFCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendNewJDFCmdParams
public JDFNewJDFCmdParams appendNewJDFCmdParams()
- Returns:
-
getNewJDFCmdParams
public JDFNewJDFCmdParams getNewJDFCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateNewJDFQuParams
public JDFNewJDFQuParams getCreateNewJDFQuParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendNewJDFQuParams
public JDFNewJDFQuParams appendNewJDFQuParams()
- Returns:
-
getNewJDFQuParams
public JDFNewJDFQuParams getNewJDFQuParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateNodeInfoCmdParams
public JDFNodeInfoCmdParams getCreateNodeInfoCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendNodeInfoCmdParams
public JDFNodeInfoCmdParams appendNodeInfoCmdParams()
- Returns:
-
getNodeInfoCmdParams
public JDFNodeInfoCmdParams getNodeInfoCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateNodeInfoQuParams
public JDFNodeInfoQuParams getCreateNodeInfoQuParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendNodeInfoQuParams
public JDFNodeInfoQuParams appendNodeInfoQuParams()
- Returns:
-
getNodeInfoQuParams
public JDFNodeInfoQuParams getNodeInfoQuParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateNodeInfoResp
public JDFNodeInfoResp getCreateNodeInfoResp(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendNodeInfoResp
public JDFNodeInfoResp appendNodeInfoResp()
- Returns:
-
getNodeInfoResp
public JDFNodeInfoResp getNodeInfoResp(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateQueueFilter
public JDFQueueFilter getCreateQueueFilter(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendQueueFilter
public JDFQueueFilter appendQueueFilter()
- Returns:
-
getQueueFilter
public JDFQueueFilter getQueueFilter(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateRequestQueueEntryParams
public JDFRequestQueueEntryParams getCreateRequestQueueEntryParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendRequestQueueEntryParams
public JDFRequestQueueEntryParams appendRequestQueueEntryParams()
- Returns:
-
getRequestQueueEntryParams
public JDFRequestQueueEntryParams getRequestQueueEntryParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendResourcePullParams
public JDFResourcePullParams appendResourcePullParams()
- Returns:
-
getResourcePullParams
public JDFResourcePullParams getResourcePullParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateResubmissionParams
public JDFResubmissionParams getCreateResubmissionParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendResubmissionParams
public JDFResubmissionParams appendResubmissionParams()
- Returns:
-
getResubmissionParams
public JDFResubmissionParams getResubmissionParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateReturnQueueEntryParams
public JDFReturnQueueEntryParams getCreateReturnQueueEntryParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendReturnQueueEntryParams
public JDFReturnQueueEntryParams appendReturnQueueEntryParams()
- Returns:
-
getReturnQueueEntryParams
public JDFReturnQueueEntryParams getReturnQueueEntryParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateSubscriptionInfo
public JDFSubscriptionInfo getCreateSubscriptionInfo(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendSubscriptionInfo
public JDFSubscriptionInfo appendSubscriptionInfo()
- Returns:
-
getSubscriptionInfo
public JDFSubscriptionInfo getSubscriptionInfo(int iSkip)
- Parameters:
iSkip-- Returns:
-
getSubscriptionFilter
public JDFSubscriptionFilter getSubscriptionFilter()
- Returns:
-
getCreateSubscriptionFilter
public JDFSubscriptionFilter getCreateSubscriptionFilter()
- Returns:
-
appendSubscriptionFilter
public JDFSubscriptionFilter appendSubscriptionFilter()
- Returns:
-
getCreateShutDownCmdParams
public JDFShutDownCmdParams getCreateShutDownCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
appendShutDownCmdParams
public JDFShutDownCmdParams appendShutDownCmdParams()
- Returns:
-
getShutDownCmdParams
public JDFShutDownCmdParams getShutDownCmdParams(int iSkip)
- Parameters:
iSkip-- Returns:
-
getCreateWakeUpCmdParams
public JDFWakeUpCmdParams getCreateWakeUpCmdParams()
- Returns:
-
appendWakeUpCmdParams
public JDFWakeUpCmdParams appendWakeUpCmdParams()
- Returns:
-
getWakeUpCmdParams
public JDFWakeUpCmdParams getWakeUpCmdParams()
- Returns:
-
getCreateModifyNodeCmdParams
public JDFModifyNodeCmdParams getCreateModifyNodeCmdParams()
- Returns:
-
appendModifyNodeCmdParams
public JDFModifyNodeCmdParams appendModifyNodeCmdParams()
- Returns:
-
getModifyNodeCmdParams
public JDFModifyNodeCmdParams getModifyNodeCmdParams()
- Returns:
-
getCreateUpdateJDFCmdParams
public JDFUpdateJDFCmdParams getCreateUpdateJDFCmdParams()
- Returns:
-
appendUpdateJDFCmdParams
public JDFUpdateJDFCmdParams appendUpdateJDFCmdParams()
- Returns:
-
getUpdateJDFCmdParams
public JDFUpdateJDFCmdParams getUpdateJDFCmdParams()
- Returns:
-
getrefID
public java.lang.String getrefID()
Method getrefID.- Returns:
- String
-
setrefID
public void setrefID(java.lang.String refID)
Method setrefID.- Parameters:
refID-
-
getInvalidElements
public VString getInvalidElements(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
Description copied from class:JDFElementget invalid elements- Overrides:
getInvalidElementsin classJDFElement- Parameters:
level- validation levelbIgnorePrivate- if true, do not worry about elements in other namespacesnMax- maximum size of the returned vector- Returns:
- VString - a vector of invalid element names
- See Also:
JDFElement.getInvalidElements(org.cip4.jdflib.core.JDFElement.EnumValidationLevel, boolean, int)
-
optionalElements
public VString optionalElements()
definition of optional elements in the JDF namespace- Overrides:
optionalElementsin classJDFElement- Returns:
- VString the comma separated list of optional element names
-
getInvalidAttributes
public VString getInvalidAttributes(JDFElement.EnumValidationLevel level, boolean bIgnorePrivate, int nMax)
Description copied from class:JDFElementget invalid attributes- Overrides:
getInvalidAttributesin classJDFElement- Parameters:
level- validation levelbIgnorePrivate- if true, do not worry about attributes in other namespacesnMax- maximum size of the returned vector- Returns:
- VString - a vector of invalid attribute names
- See Also:
JDFElement.getInvalidAttributes(org.cip4.jdflib.core.JDFElement.EnumValidationLevel, boolean, int)
-
getICSVersions
public VString getICSVersions()
(21) get VString attribute ICSVersions, grab from parent JMF if none exists here- Overrides:
getICSVersionsin classJDFAutoMessage- Returns:
- VString the value of the attribute
-
getSenderID
public java.lang.String getSenderID()
gets the senderID of this message- Overrides:
getSenderIDin classJDFAutoMessage- Returns:
- String the senderID of this message or the SenderID of the parent JMF; null if neither are specified
-
getDeprecatedElements
public VString getDeprecatedElements(int nMax)
Description copied from class:JDFElementVector of deprecated elements below the current element.default: getDeprecatedElements(99999999)
- Overrides:
getDeprecatedElementsin classJDFElement- Parameters:
nMax-- Returns:
- See Also:
JDFElement.getDeprecatedElements(int)
-
getLastVersion
public JDFElement.EnumVersion getLastVersion(java.lang.String eaName, boolean bElement)
Description copied from class:JDFElementget the last JDF version where attribute name or element name is valid- Overrides:
getLastVersionin classJDFElement- Parameters:
eaName-bElement-- Returns:
- See Also:
JDFElement.getLastVersion(java.lang.String, boolean)
-
getTime
public JDFDate getTime()
Description copied from class:JDFAutoMessage(12) get JDFDate attribute Time- Overrides:
getTimein classJDFAutoMessage- Returns:
- JDFDate the value of the attribute
- See Also:
JDFAutoMessage.getTime()
-
-