org.cip4.jdflib.jmf

Class JDFJMF

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.pool.JDFPool

org.cip4.jdflib.auto.JDFAutoJMF

org.cip4.jdflib.jmf.JDFJMF

All Implemented Interfaces:

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

public class JDFJMF
extends JDFAutoJMF

The wrapper for JMF messages, i.e. the root of a JMF document

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDFJMF.EnumJMFReturnCode

Nested classes/interfaces inherited from class org.cip4.jdflib.core.JDFElement

JDFElement.EnumBoolean, JDFElement.EnumNamedColor, JDFElement.EnumNodeStatus, JDFElement.EnumOrientation, JDFElement.EnumPoolType, JDFElement.EnumSeparation, JDFElement.EnumSettingsPolicy, JDFElement.EnumValidationLevel, JDFElement.EnumVersion, JDFElement.EnumXYRelation

Nested classes/interfaces inherited from class org.cip4.jdflib.core.KElement

KElement.SimpleElementNameComparator, KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator

Field Summary

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

localName, namespaceURI

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

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
JDFAcknowledge	appendAcknowledge(JDFMessage.EnumType typ) Append an Acknowledge
JDFCommand	appendCommand(JDFMessage.EnumType typ) Append a Command
JDFMessage	appendMessageElement(JDFMessage.EnumFamily family) Deprecated. use appendMessageElement (family, null);
JDFMessage	appendMessageElement(JDFMessage.EnumFamily family, JDFMessage.EnumType typ) append a message element to this
JDFQuery	appendQuery(JDFMessage.EnumType typ) Append a query
JDFRegistration	appendRegistration(JDFMessage.EnumType typ) Append a Command
JDFResponse	appendResponse(JDFMessage.EnumType typ) Append a Response
JDFSignal	appendSignal(JDFMessage.EnumType typ) Append a Signal
VString	collectICSVersions() collect ICSVersions from all message children also removes duplicate entries from this and remove ""
void	convertResponses(JDFQuery q) convert all responses that match the query q to signals
static JDFJMF	createJMF(JDFMessage.EnumFamily family, JDFMessage.EnumType typ) create a new JMF with one Message Element of family family and type typ
JDFJMF	createResponse() create a new response for all messages of this if the message is any message except response correctly fills refId, type etc.
JDFAcknowledge	getAcknowledge() Deprecated. use getMessageElement
JDFAcknowledge	getAcknowledge(int i, boolean bCreate) Deprecated. use getMessageElement or appendMessageElement
JDFAcknowledge	getAcknowledge(java.lang.String refID) get element Acknowledge
JDFCommand	getCommand() Deprecated.
JDFCommand	getCommand(int i, boolean bCreate) Deprecated. use getMessageElement or getCreateMessageElement
JDFMessage	getCreateMessageElement(JDFMessage.EnumFamily family, int i) Deprecated. use getCreateMessageElement(family, null, i);
JDFMessage	getCreateMessageElement(JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int i) get an existing message element, create it if it doesn't exist
JDFElement.EnumVersion	getMaxVersion() get attribute MaxVersion, defaults to version if not set
JDFMessage	getMessage(int i) GetMessage - get the ith message, regardless of type
JDFMessage	getMessageElement(JDFMessage.EnumFamily family, int i) Deprecated. since 060619, use getMessageElement (JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int i)
JDFMessage	getMessageElement(JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int i) get the ith message element of family type family
VElement	getMessageVector() Deprecated. use getMessageVector (null, null)
static VElement	getMessageVector(JDFDoc doc, JDFMessage.EnumFamily family, JDFMessage.EnumType typ) get a vector of all messages in a JMF from a JDFDoc
VElement	getMessageVector(JDFMessage.EnumFamily family) Deprecated. use getMessageVector (family, null)
VElement	getMessageVector(JDFMessage.EnumFamily family, JDFMessage.EnumType typ) get a vector of all messages in this JMF
JDFQuery	getQuery() Deprecated. use getMessageElement
JDFQuery	getQuery(int i, boolean bCreate) Deprecated. use getMessageElement or getCreateMessageElement
JDFResponse	getResponse() Deprecated. use getMessageElement
JDFResponse	getResponse(int i, boolean bCreate) Deprecated. use getMessageElement or getCreateMessageElement
JDFResponse	getResponse(java.lang.String refID) (27) get element Response
JDFSignal	getSignal() Deprecated. use getMessageElement
JDFSignal	getSignal(int i, boolean bCreate) Deprecated. use getMessageElement
java.lang.String	getSubmissionURL() get the @URL of this message if it is either a submitQueueEntry, a returnQueuentry or a resubmitqueueentry
static java.lang.String	getTheSenderID()
boolean	init() init
static JDFJMF	parseFile(java.io.File file) parse a JMF file
static JDFJMF	parseFile(java.lang.String fileName) parse a JMF file
void	setMaxVersion(JDFElement.EnumVersion enumVer) set MaxVersion to enumVer
static void	setTheSenderID(java.lang.String _theSenderID) set the default senderID that is used to generate jmf messages
void	setVersion(JDFElement.EnumVersion enumVer) set Version to enumVer
java.lang.String	toString() toString

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

appendAcknowledge, appendCommand, appendEmployee, appendQuery, appendRegistration, appendResponse, appendSignal, getAcknowledge, getAgentName, getAgentVersion, getAllAcknowledge, getAllCommand, getAllEmployee, getAllQuery, getAllRegistration, getAllResponse, getAllSignal, getCommand, getCreateAcknowledge, getCreateCommand, getCreateEmployee, getCreateQuery, getCreateRegistration, getCreateResponse, getCreateSignal, getDeviceID, getEmployee, getICSVersions, getQuery, getRegistration, getResponse, getResponseURL, getSenderID, getSignal, getTheAttributeInfo, getTheElementInfo, getTimeStamp, setAgentName, setAgentVersion, setDeviceID, setICSVersions, setResponseURL, setSenderID, setTimeStamp

Methods inherited from class org.cip4.jdflib.pool.JDFPool

appendUniqueGeneric, appendUniqueGeneric, getPoolChildGeneric, getPoolChildrenGeneric

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

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyChildren, copyInto, createRoot, createRoot, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreateElement_JDFElement, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementInfo, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDListMap, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkFromUserData, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPartMapArray, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, isDirty, isInAnyJDFNameSpaceStatic, isInAnyJDFNameSpaceStatic, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, isXJDF, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, removePartMap, removeRefElement, removeSettingsPolicy, replaceChild, requiredAttributes, requiredElements, requiredLevel, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNameTimeStamp, setAttributes, setBestEffortExceptions, setCommentURL, setDefaultJDFVersion, setDescriptiveName, setDirty, setEnumerationsAttribute, setGeneralID, setLongID, setMustHonorExceptions, setOperatorInterventionExceptions, setPartMap, setPartMapVector, setSettingsPolicy, setStatus, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version, write2Dir

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

addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendAttributes, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, buildXPath, buildXPath, buildXPath, cleanup, clearNSMap, clone, copyAttribute, copyAttribute, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, ensureCase, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeArray_KElement, getAttributeIgnoreCase, getAttributeMap_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildArray_KElement, getChildArray, getChildArrayByClass_KElement, getChildArrayByClass, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildList, getChildList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenByTagName, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getChildWithAttribute, getChildWithAttribute, getCreateChildWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getID, getIDPrefix, getIgnoreCase_KElement, getIgnoreCase, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNonEmpty_KElement, getNonEmpty, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTree, getTreeByClass, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasNonEmpty_KElement, hasNonEmpty, hasXPathNode, includesAttribute, includesAttributes, insertAt, insertBefore, isAncestor, isEqual, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveArray, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, numSiblingElements, parseStream, parseString, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeIgnoreCase_KElement, removeIgnoreCase, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, 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.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

JDFJMF

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

Constructor for JDFJMF

Parameters:

myOwnerDocument -

qualifiedName -

JDFJMF

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

Constructor for JDFJMF

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFJMF

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

Constructor for JDFJMF

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

parseFile

public static JDFJMF parseFile(java.io.File file)

parse a JMF file

Parameters:

file -

Returns:

the parsed JDFNode

parseFile

public static JDFJMF parseFile(java.lang.String fileName)

parse a JMF file

Parameters:

fileName -

Returns:

the parsed JDFNode

toString

public java.lang.String toString()

toString

Overrides:

toString in class KElement

Returns:

String

See Also:

Object.toString()

init

public boolean init()

init

Overrides:

init in class JDFElement

Returns:

boolean

See Also:

KElement.init()

getMaxVersion

public JDFElement.EnumVersion getMaxVersion()

get attribute MaxVersion, defaults to version if not set

Overrides:

getMaxVersion in class JDFAutoJMF

Returns:

EnumVersion - attribute value default - getMaxVersion(false)

setVersion

public void setVersion(JDFElement.EnumVersion enumVer)

Description copied from class: JDFElement

set Version to enumVer

Overrides:

setVersion in class JDFElement

Parameters:

enumVer - the EnumVersion to set

See Also:

JDFElement.setVersion(org.cip4.jdflib.core.JDFElement.EnumVersion)

setMaxVersion

public void setMaxVersion(JDFElement.EnumVersion enumVer)

set MaxVersion to enumVer

Overrides:

setMaxVersion in class JDFAutoJMF

Parameters:

enumVer - the EnumVersion to set

getMessage

public JDFMessage getMessage(int i)

GetMessage - get the ith message, regardless of type

Parameters:

i - message index

Returns:

JDFMessage - the ith message

getCommand

@Deprecated
public JDFCommand getCommand()

Deprecated.

Get the 0h command

Returns:

JDFCommand: the message element

getCommand

@Deprecated
public JDFCommand getCommand(int i,
                                         boolean bCreate)

Deprecated. use getMessageElement or getCreateMessageElement

Parameters:

i -

bCreate -

Returns:

getQuery

@Deprecated
public JDFQuery getQuery()

Deprecated. use getMessageElement

Get the 0th query,

Returns:

JDFQuery the message element

getQuery

@Deprecated
public JDFQuery getQuery(int i,
                                     boolean bCreate)

Deprecated. use getMessageElement or getCreateMessageElement

Parameters:

i -

bCreate -

Returns:

getResponse

@Deprecated
public JDFResponse getResponse()

Deprecated. use getMessageElement

getResponse()

Returns:

JDFResponse the message element

getResponse

@Deprecated
public JDFResponse getResponse(int i,
                                           boolean bCreate)

Deprecated. use getMessageElement or getCreateMessageElement

getResponse()

Parameters:

i -

bCreate -

Returns:

getSignal

@Deprecated
public JDFSignal getSignal()

Deprecated. use getMessageElement

Get the 0th signal,

Returns:

JDFSignal the message element

getSignal

@Deprecated
public JDFSignal getSignal(int i,
                                       boolean bCreate)

Deprecated. use getMessageElement

Parameters:

i -

bCreate -

Returns:

getCreateMessageElement

public JDFMessage getCreateMessageElement(JDFMessage.EnumFamily family,
                                          JDFMessage.EnumType typ,
                                          int i)

get an existing message element, create it if it doesn't exist

Parameters:

family - the Message family - Query, Acknowledge, Command, Response, Registration or Signal

typ - the message type

i - get the ith element

Returns:

the newly created message

getCreateMessageElement

@Deprecated
public JDFMessage getCreateMessageElement(JDFMessage.EnumFamily family,
                                                      int i)

Deprecated. use getCreateMessageElement(family, null, i);

get an existing message element, create it if it doesn't exist

Parameters:

family - the Message family - Query, Acknowledge, Command, Response, Registration or Signal

i - get the ith element

Returns:

the newly created message

appendMessageElement

@Deprecated
public JDFMessage appendMessageElement(JDFMessage.EnumFamily family)

Deprecated. use appendMessageElement (family, null);

append a message element to this

Parameters:

family -

Returns:

createJMF

public static JDFJMF createJMF(JDFMessage.EnumFamily family,
                               JDFMessage.EnumType typ)

create a new JMF with one Message Element of family family and type typ

Parameters:

family - the Message family - Query, Acknowledge, Command, Response, Registration or Signal

typ - the messages @Type value, null if unknown

Returns:

the newly created message

appendMessageElement

public JDFMessage appendMessageElement(JDFMessage.EnumFamily family,
                                       JDFMessage.EnumType typ)

append a message element to this

Parameters:

family - the Message family - Query, Acknowledge, Command, Response, Registration or Signal

typ - the messages @Type value, null if unknown

Returns:

the newly created message

getMessageElement

@Deprecated
public JDFMessage getMessageElement(JDFMessage.EnumFamily family,
                                                int i)

Deprecated. since 060619, use getMessageElement (JDFMessage.EnumFamily family, JDFMessage.EnumType typ, int i)

get the ith message element of family type family

Parameters:

family -

i -

Returns:

getMessageElement

public JDFMessage getMessageElement(JDFMessage.EnumFamily family,
                                    JDFMessage.EnumType typ,
                                    int i)

get the ith message element of family type family

Parameters:

family - the Message family - Query, Acknowledge, Command, Response, Registration or Signal

typ - the messages @Type value, null if unknown

i - the i'th message element to get, if i<0, get from back

Returns:

the matching message, null if none are found

getMessageVector

@Deprecated
public VElement getMessageVector()

Deprecated. use getMessageVector (null, null)

get a vector of all messages in this JMF

Returns:

VElement all message elements

getMessageVector

@Deprecated
public VElement getMessageVector(JDFMessage.EnumFamily family)

Deprecated. use getMessageVector (family, null)

get a vector of all messages in this JMF

Parameters:

family - requested message family

Returns:

VElement all message elements

getMessageVector

public static VElement getMessageVector(JDFDoc doc,
                                        JDFMessage.EnumFamily family,
                                        JDFMessage.EnumType typ)

get a vector of all messages in a JMF from a JDFDoc

Parameters:

doc - the JDFDoc to search - only valid for root JMF

family - requested message family

typ - requested message type

Returns:

VElement all message elements, null if no match found

getMessageVector

public VElement getMessageVector(JDFMessage.EnumFamily family,
                                 JDFMessage.EnumType typ)

get a vector of all messages in this JMF

Parameters:

family - requested message family

typ - requested message type

Returns:

VElement all message elements

getAcknowledge

@Deprecated
public JDFAcknowledge getAcknowledge()

Deprecated. use getMessageElement

Get the 0 acknowledge,

Returns:

JDFAcknowledge: the message element

getAcknowledge

@Deprecated
public JDFAcknowledge getAcknowledge(int i,
                                                 boolean bCreate)

Deprecated. use getMessageElement or appendMessageElement

Parameters:

i -

bCreate -

Returns:

appendCommand

public JDFCommand appendCommand(JDFMessage.EnumType typ)

Append a Command

Parameters:

typ - the type attribute of the appended message

Returns:

JDFQuery the newly created message element

appendRegistration

public JDFRegistration appendRegistration(JDFMessage.EnumType typ)

Append a Command

Parameters:

typ - the type attribute of the appended message

Returns:

JDFQuery the newly created message element

appendQuery

public JDFQuery appendQuery(JDFMessage.EnumType typ)

Append a query

Parameters:

typ - the type attribute of the appended message

Returns:

JDFQuery: the newly created message element

appendSignal

public JDFSignal appendSignal(JDFMessage.EnumType typ)

Append a Signal

Parameters:

typ - the type attribute of the appended message

Returns:

JDFSignal: the newly created message element

appendResponse

public JDFResponse appendResponse(JDFMessage.EnumType typ)

Append a Response

Parameters:

typ - the type attribute of the appended message

Returns:

JDFResponse the newly created message element

appendAcknowledge

public JDFAcknowledge appendAcknowledge(JDFMessage.EnumType typ)

Append an Acknowledge

Parameters:

typ - the type attribute of the appended message

Returns:

JDFAcknowledge the newly created message element

getTheSenderID

public static java.lang.String getTheSenderID()

Returns:

the theSenderID which is used as default when initializing new messages

setTheSenderID

public static void setTheSenderID(java.lang.String _theSenderID)

set the default senderID that is used to generate jmf messages

Parameters:

_theSenderID - the theSenderID to set

createResponse

public JDFJMF createResponse()

create a new response for all messages of this if the message is any message except response correctly fills refId, type etc.

Returns:

the newly created JMF with multiple responses

collectICSVersions

public VString collectICSVersions()

collect ICSVersions from all message children also removes duplicate entries from this and remove ""

Returns:

VString of all ICS versions

convertResponses

public void convertResponses(JDFQuery q)

convert all responses that match the query q to signals

Parameters:

q - the query to convert

getSubmissionURL

public java.lang.String getSubmissionURL()

get the @URL of this message if it is either a submitQueueEntry, a returnQueuentry or a resubmitqueueentry

Returns:

the String

getAcknowledge

public JDFAcknowledge getAcknowledge(java.lang.String refID)

get element Acknowledge

Parameters:

refID - refID of the response

Returns:

JDFResponse the element

getResponse

public JDFResponse getResponse(java.lang.String refID)

(27) get element Response

Parameters:

refID - refID of the response

Returns:

JDFResponse the element