org.cip4.jdflib.jmf

Class JDFResourceCmdParams

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

org.cip4.jdflib.jmf.JDFResourceCmdParams

All Implemented Interfaces:

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

public class JDFResourceCmdParams
extends JDFAutoResourceCmdParams
implements INodeIdentifiable

class that wraps a ResourceCmdParams element

Author:

prosirai

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JDFResourceCmdParams.ApplyCommand container for applying resource commands to commands

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

JDFAutoResourceCmdParams.EnumActivation, JDFAutoResourceCmdParams.EnumUpdateMethod

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

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

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

KElement.SimpleNodeComparator, KElement.SingleAttributeComparator, KElement.SingleXPathComparator

Field Summary

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

localName, namespaceURI

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

attributes, name

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

firstChild, fNodeListCache, ownerDocument

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

nextSibling, previousSibling

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

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

Fields inherited from interface org.w3c.dom.Node

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

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
JDFResource	appendResource(String resName) Append Resource
void	applyResourceCommand(JDFNode parentNode) apply the parameters in this to all appropriate resources in parentNode or one of parentNode's children if no matching resource exists in the node, Usage MUST be set in this JDFResourceCmdParams, otherwise it is not possible to correctly link the newly created resource
JDFResource	getCreateResource(String resName) get resource defined by resName, create if it doesn't exist
NodeIdentifier	getIdentifier() gets the NodeIdetifier that matches this
VJDFAttributeMap	getPartMapVector() get part map vector
JDFResource	getResource(String resName) get resource defined by resNam
protected ElementInfo	getTheElementInfo()
VString	getUnknownElements(boolean bIgnorePrivate, int nMax) return the vector of unknown element nodenames
JDFResourceLink.EnumUsage	getUsage() (9) get attribute Usage
boolean	hasPartMap(JDFAttributeMap mPart) check whether the part defined in mPart is included
void	removePartMap(JDFAttributeMap mPart) remove the part defined by mPart
void	setIdentifier(NodeIdentifier ni)
void	setPartMap(JDFAttributeMap mPart) set all parts to those define by mPart
void	setPartMapVector(VJDFAttributeMap vParts) set all parts to those defined by vParts
void	setUsage(JDFResourceLink.EnumUsage enumVar) (5) set attribute Usage
String	toString() toString()

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

appendMISDetails, appendPart, appendResource, getActivation, getAllPart, getAllResource, getCreateMISDetails, getCreatePart, getCreateResource, getExact, getJobID, getJobPartID, getMISDetails, getPart, getProcessUsage, getProductID, getProductionAmount, getQueueEntryID, getResource, getResourceID, getResourceName, getResStatus, getTheAttributeInfo, getUpdateIDs, getUpdateMethod, setActivation, setExact, setJobID, setJobPartID, setProcessUsage, setProductID, setProductionAmount, setQueueEntryID, setResourceID, setResourceName, setResStatus, setUpdateIDs, setUpdateMethod

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

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, appendGeneralID, appendHRef, appendHRef, appendMustHonorExceptions, appendOperatorInterventionExceptions, appendPreview, appendrRefs, attributeType, clearTargets, cloneNewDoc, copyInto, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMap, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, 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, setSettingsPolicy, setStatus, setVersion, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version

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

addAttribute, addAttribute, addNameSpace, ancestorDistance, appendAttribute, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildXPath, buildXPath, buildXPath, clone, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, fitsName, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeMap, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, getID, getIDPrefix, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasXPathNode, includesAttribute, includesAttributes, init, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numSiblingElements, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildText, removeExtensions, removeFromAttribute, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setAttributeNSRaw, setAttributeRaw, setAttributes, setAttributes, setAttributes, setAttributesRaw, setBoolAttribute, setDirty, setID, setIntAttribute, setNamespaceURI, setNodeValue, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, toDisplayXML, toXML, toXML, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix

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

getBaseURI, getLocalName, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setType, setValues

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

cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttributeNS, isEqualNode, reconcileDefaultAttributes, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

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

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren

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

getNextSibling, getParentNode, getPreviousSibling

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

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setUserData, setUserData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Element

getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setTextContent, setUserData

Constructor Detail

JDFResourceCmdParams

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

Constructor for JDFResourceCmdParams

Parameters:

myOwnerDocument -

qualifiedName -

JDFResourceCmdParams

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

Constructor for JDFResourceCmdParams

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFResourceCmdParams

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

Constructor for JDFResourceCmdParams

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getTheElementInfo

protected ElementInfo getTheElementInfo()

Overrides:

getTheElementInfo in class JDFAutoResourceCmdParams

Returns:

the elementinfo

toString

public String toString()

toString()

Overrides:

toString in class JDFAutoResourceCmdParams

Returns:

String

See Also:

Object.toString()

getCreateResource

public JDFResource getCreateResource(String resName)

get resource defined by resName, create if it doesn't exist

Parameters:

resName - name of the resource to get/create

Returns:

JDFResource the element

getResource

public JDFResource getResource(String resName)

get resource defined by resNam

Parameters:

resName - name of the resource to get, if null get the one and only resource

Returns:

JDFResource the element, null if none exists

appendResource

public JDFResource appendResource(String resName)

Append Resource

Parameters:

resName - name of the resource to append

Returns:

JDFResource the element

getUnknownElements

public VString getUnknownElements(boolean bIgnorePrivate,
                         int nMax)

return the vector of unknown element nodenames

default: GetInvalidElements(true, 999999)
!!! Do not change the signature of this method

Overrides:

getUnknownElements in class JDFElement

Parameters:

bIgnorePrivate - used by JDFElement during the validation

nMax - maximum number of elements to get

Returns:

Vector - vector of unknown element nodenames

getPartMapVector

public VJDFAttributeMap getPartMapVector()

get part map vector

Overrides:

getPartMapVector in class JDFElement

Returns:

VJDFAttributeMap: vector of attribute maps, one for each part

setPartMapVector

public void setPartMapVector(VJDFAttributeMap vParts)

set all parts to those defined by vParts

Overrides:

setPartMapVector in class JDFElement

Parameters:

vParts - vector of attribute maps for the parts

setPartMap

public void setPartMap(JDFAttributeMap mPart)

set all parts to those define by mPart

Overrides:

setPartMap in class JDFElement

Parameters:

mPart - attribute map for the part to set

removePartMap

public void removePartMap(JDFAttributeMap mPart)

remove the part defined by mPart

Overrides:

removePartMap in class JDFElement

Parameters:

mPart - attribute map for the part to remove

hasPartMap

public boolean hasPartMap(JDFAttributeMap mPart)

check whether the part defined in mPart is included

Overrides:

hasPartMap in class JDFElement

Parameters:

mPart - attribute map to look for

Returns:

boolean - returns true if the part exists

applyResourceCommand

public void applyResourceCommand(JDFNode parentNode)

apply the parameters in this to all appropriate resources in parentNode or one of parentNode's children if no matching resource exists in the node, Usage MUST be set in this JDFResourceCmdParams, otherwise it is not possible to correctly link the newly created resource

Parameters:

parentNode - the node to search in

getIdentifier

public NodeIdentifier getIdentifier()

gets the NodeIdetifier that matches this

Specified by:

getIdentifier in interface INodeIdentifiable

Returns:

NodeIdentifier the matching NodeIdentifier

setUsage

public void setUsage(JDFResourceLink.EnumUsage enumVar)

(5) set attribute Usage

Overrides:

setUsage in class JDFAutoResourceCmdParams

Parameters:

enumVar - the enumVar to set the attribute to

getUsage

public JDFResourceLink.EnumUsage getUsage()

(9) get attribute Usage

Overrides:

getUsage in class JDFAutoResourceCmdParams

Returns:

the value of the attribute

setIdentifier

public void setIdentifier(NodeIdentifier ni)

Specified by:

setIdentifier in interface INodeIdentifiable

Parameters:

ni -

See Also:

org.cip4.jdflib.ifaces.INodeIdentifiable#setIdentifier(org.cip4.jdflib.node.JDFNode.NodeIdentifier)