org.cip4.jdflib.pool

Class JDFStatusPool

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

org.cip4.jdflib.pool.JDFStatusPool

All Implemented Interfaces:

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

public class JDFStatusPool
extends JDFAutoStatusPool

This class represents a JDF-Status Pool. THe status pool describes the status of a JDF node that processes partitioned resources. StatusPool elements are only valid if the nodes Status="Pool", otherwise the nodes status is valid for all parts, regardless of the contents of StatusPool.

See Also:

Serialized Form

Nested Class Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
JDFPartStatus	getCreatePartStatus(JDFAttributeMap mPart) getCreatePartStatus - get a PartStatus that fits to the filter defined by mPart create it if it does not exist
VElement	getCreatePartStatusVector(Vector vmPart) getCreatePartStatusVector - get a vector of PartStatus that fits to the filter defined by mPart
VElement	getMatchingPartStatusVector(JDFAttributeMap mPart) get matching part status vector
JDFPartStatus	getPartStatus(JDFAttributeMap mPart) getPartStatus - get a PartStatus that fits to the filter defined by mPart
VElement	getPartStatusVector(Vector vmPart) getPartStatusVector - get a vector of PartStatus that fits to the filter defined by mPart
JDFPartStatus	getPoolChild(int i, JDFAttributeMap mAttrib) get pool child
VElement	getPoolChildren(JDFAttributeMap mAttrib) get pool children with attributes definded by mAttrib
JDFElement.EnumNodeStatus	getStatus(JDFAttributeMap mPart) getElementStatus - get the status of a part defined in StatusPool
void	setStatus(JDFAttributeMap mPart, JDFElement.EnumNodeStatus s, String statusDetails) Set the status of a part defined in StatusPool
void	setStatus(JDFElement.EnumNodeStatus s) Set the status of the entire StatusPool
void	setStatus(VJDFAttributeMap vmPart, JDFElement.EnumNodeStatus s, String statusDetails) Set the status of a part defined in StatusPool
String	toString() toString
boolean	validStatus() check whether the status is valid

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

appendPartStatus, getAllPartStatus, getCreatePartStatus, getPartStatus, getStatusDetails, getTheAttributeInfo, getTheElementInfo, setStatusDetails

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, 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, getPartMapVector, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDirty, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isValid, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, removePartMap, removeRefElement, removeSettingsPolicy, replaceChild, requiredAttributes, requiredElements, requiredLevel, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNameTimeStamp, setAttributes, setBestEffortExceptions, setCommentURL, setDefaultJDFVersion, setDescriptiveName, setDirty, setEnumerationsAttribute, setGeneralID, setLongID, setMustHonorExceptions, setOperatorInterventionExceptions, setPartMap, setPartMapVector, setSettingsPolicy, 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, getAttributeRaw, 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, removeChildrenByClass, 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

JDFStatusPool

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

Constructor for JDFStatusPool

Parameters:

myOwnerDocument -

qualifiedName -

JDFStatusPool

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

Constructor for JDFStatusPool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFStatusPool

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

Constructor for JDFStatusPool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

toString

public String toString()

toString

Overrides:

toString in class JDFAutoStatusPool

Returns:

String

See Also:

Object.toString()

getStatus

public JDFElement.EnumNodeStatus getStatus(JDFAttributeMap mPart)

getElementStatus - get the status of a part defined in StatusPool

Parameters:

mPart - filter for the part to get the status

Returns:

EnumNodeStatus - the status for the filter defined in mPart

getPartStatus

public JDFPartStatus getPartStatus(JDFAttributeMap mPart)

getPartStatus - get a PartStatus that fits to the filter defined by mPart

Parameters:

mPart - the filter for the part to set the status

Returns:

JDFPartStatus - the PartStatus that fits

getCreatePartStatus

public JDFPartStatus getCreatePartStatus(JDFAttributeMap mPart)

getCreatePartStatus - get a PartStatus that fits to the filter defined by mPart
create it if it does not exist

Parameters:

mPart - the filter for the part to set the status

Returns:

JDFPartStatus - the PartStatus that fits

getPartStatusVector

public VElement getPartStatusVector(Vector vmPart)

getPartStatusVector - get a vector of PartStatus that fits to the filter defined by mPart

Parameters:

vmPart - the filter vector for the part to set the status.If null, return all.

Returns:

VElement - the vector of PartStatus that fit

getMatchingPartStatusVector

public VElement getMatchingPartStatusVector(JDFAttributeMap mPart)

get matching part status vector

Parameters:

mPart -

Returns:

VElement - vector of JDFPartStatus

getCreatePartStatusVector

public VElement getCreatePartStatusVector(Vector vmPart)

getCreatePartStatusVector - get a vector of PartStatus that fits to the filter defined by mPart

Parameters:

vmPart - the filter vector for the part to set the status

Returns:

VElement - vector of JDFPartStatus

getPoolChildren

public VElement getPoolChildren(JDFAttributeMap mAttrib)

get pool children with attributes definded by mAttrib

Parameters:

mAttrib - attribute map

Returns:

VElement

getPoolChild

public JDFPartStatus getPoolChild(int i,
                         JDFAttributeMap mAttrib)

get pool child

Parameters:

i - the index of the child, or -1 to create a new one

mAttrib - the attribute of the child

Returns:

JDFPartStatus: the pool child matching the given conditions

setStatus

public void setStatus(JDFElement.EnumNodeStatus s)

Set the status of the entire StatusPool

Overrides:

setStatus in class JDFElement

Parameters:

s - the status to set

setStatus

public void setStatus(VJDFAttributeMap vmPart,
             JDFElement.EnumNodeStatus s,
             String statusDetails)

Set the status of a part defined in StatusPool

default setStatus(vmPart, s, JDFConstants.EMPTYSTRING)

Parameters:

vmPart -

s -

statusDetails -

setStatus

public void setStatus(JDFAttributeMap mPart,
             JDFElement.EnumNodeStatus s,
             String statusDetails)

Set the status of a part defined in StatusPool

default setStatus(mPart, s, JDFConstants.EMPTYSTRING)

Parameters:

mPart -

s -

statusDetails -

validStatus

public boolean validStatus()

check whether the status is valid

Returns:

true if status is valid