org.cip4.jdflib.pool

Class JDFAncestorPool

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

org.cip4.jdflib.pool.JDFAncestorPool

All Implemented Interfaces:

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

public class JDFAncestorPool
extends JDFAutoAncestorPool

Description: This class represents an JDFAncestorPool

Version:

1.0 2002-01-28

Author:

Torsten Kaehlert

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

Method Summary

Methods

Modifier and Type	Method and Description
void	copyNodeData(JDFNode parentNode) Deprecated. use public void copyNodeData (JDFNode parentNode, false, false) instead
void	copyNodeData(JDFNode parentNode, boolean bCopyNodeInfo, boolean bCopyCustomerInfo, boolean bCopyComments) Copy all data from parentNode into the ancestor elements of this
String	getAncestorAttribute(String attrib, String nameSpaceURI, String def) searches for the first attribute occurence in the ancestor elements
KElement	getAncestorElement(String element, String nameSpaceURI) Deprecated.
KElement	getAncestorElement(String element, String nameSpaceURI, String xPath) searches for the first element occurence in the ancestor elements
String	getAncestorElementAttribute(String element, String attrib, String nameSpaceURI, String def) searches for the first attribute occurence in the ancestor elements subelements e.g.
VElement	getLinkedResources(JDFAttributeMap mResAtt, boolean bFollowRefs) Get the linked resources matching some conditions
VJDFAttributeMap	getPartMapVector() get part map vector
JDFAncestor	getPoolChild(int i, JDFAttributeMap mAttrib) get a child from the pool matching the parameters
VElement	getPoolChildren(JDFAttributeMap mAttrib) Gets all children with the attribute out of the pool
boolean	hasAncestorAttribute(String attrib, String nameSpaceURI) check whether a defined attribute exists in the ancestor elements
boolean	hasAncestorElement(String attrib, String nameSpaceURI) true id a non default occurence in the ancestor elements exists
boolean	hasPartMap(JDFAttributeMap mPart) check whether the part defined in mPart is included
boolean	isPartitioned() check whether the Ancestor pool contains any part elements
void	removePartMap(JDFAttributeMap mPart) remove the part defined in mPart
void	setPartMap(JDFAttributeMap mPart) set all parts to those define in vParts
void	setPartMapVector(VJDFAttributeMap vParts) set all parts to those define in vParts

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

appendAncestor, appendPart, getAllAncestor, getAllPart, getAncestor, getCreateAncestor, getCreatePart, getPart, getTheElementInfo, toString

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, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheAttributeInfo, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, 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, 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

JDFAncestorPool

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

Constructor for JDFAncestorPool

Parameters:

myOwnerDocument -

qualifiedName -

JDFAncestorPool

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

Constructor for JDFAncestorPool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFAncestorPool

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

Constructor for JDFAncestorPool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getAncestorAttribute

public String getAncestorAttribute(String attrib,
                          String nameSpaceURI,
                          String def)

searches for the first attribute occurence in the ancestor elements

Parameters:

attrib - the attribute name

nameSpaceURI - the XML-namespace

def - the default if it does not exist

Returns:

value of attribute found, value of def if not available

Since:

180502

getAncestorElement

@Deprecated
public KElement getAncestorElement(String element,
                                     String nameSpaceURI)

Deprecated.

Parameters:

element -

nameSpaceURI -

Returns:

an element

getAncestorElement

public KElement getAncestorElement(String element,
                          String nameSpaceURI,
                          String xPath)

searches for the first element occurence in the ancestor elements

Parameters:

element - the element name

nameSpaceURI - the XML-namespace of the element

xPath - the xpath of a required attribute

Returns:

value of attribute found, empty string if not available

Since:

290502

hasAncestorElement

public boolean hasAncestorElement(String attrib,
                         String nameSpaceURI)

true id a non default occurence in the ancestor elements exists

Parameters:

attrib - the attribute name

nameSpaceURI - the XML-namespace

Returns:

value of attribute found, empty string if not available

Since:

180502

getLinkedResources

public VElement getLinkedResources(JDFAttributeMap mResAtt,
                          boolean bFollowRefs)

Get the linked resources matching some conditions

Parameters:

mResAtt - map of Resource attributes to search for

bFollowRefs - true if internal references shall be followed

Returns:

vResource: vector with all elements matching the conditions default: GetLinkedResources(new JDFAttributeMap(), false)

copyNodeData

@Deprecated
public void copyNodeData(JDFNode parentNode)

Deprecated. use public void copyNodeData (JDFNode parentNode, false, false) instead

Copy all data from rootNode into the Ancestor elements of this

Parameters:

parentNode - the closest parent Node that contains the information to be copied

copyNodeData

public void copyNodeData(JDFNode parentNode,
                boolean bCopyNodeInfo,
                boolean bCopyCustomerInfo,
                boolean bCopyComments)

Copy all data from parentNode into the ancestor elements of this

Parameters:

parentNode - the closest parent Node that contains the information to be copied

bCopyNodeInfo - if true, also copy the NodeInfo into the ancestor

bCopyCustomerInfo - if true, also copy the CustomerInfo into the ancestor

bCopyComments - if true, also copy the comments and generalID elements into the ancestor

getPoolChildren

public VElement getPoolChildren(JDFAttributeMap mAttrib)

Gets all children with the attribute out of the pool

Parameters:

mAttrib - the attribute to search for

Returns:

VElement: a vector with all elements in the pool matching the conditions default: GetPoolChildren(null)

getPoolChild

public JDFAncestor getPoolChild(int i,
                       JDFAttributeMap mAttrib)

get a child from the pool matching the parameters

Parameters:

i - the index of the child or -1 to make a new one.

mAttrib - an attribute to search for

Returns:

JDFAncestor: the pool child matching the above conditions default: GetPoolChild(i, null)

getPartMapVector

public VJDFAttributeMap getPartMapVector()

get part map vector

Overrides:

getPartMapVector in class JDFElement

Returns:

VJDFAttributeMap: vector of mAttribute, one for each part

setPartMapVector

public void setPartMapVector(VJDFAttributeMap vParts)

set all parts to those define in 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 in vParts

Overrides:

setPartMap in class JDFElement

Parameters:

mPart - attribute map for the part to set

removePartMap

public void removePartMap(JDFAttributeMap mPart)

remove the part defined in 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 for the part to remove

Returns:

true if the part exists

hasAncestorAttribute

public boolean hasAncestorAttribute(String attrib,
                           String nameSpaceURI)

check whether a defined attribute exists in the ancestor elements

Parameters:

attrib - the attribute name to look for

nameSpaceURI - the XML-namespace to search in

Returns:

value of attribute found, empty string if not available

Since:

180502

getAncestorElementAttribute

public String getAncestorElementAttribute(String element,
                                 String attrib,
                                 String nameSpaceURI,
                                 String def)

searches for the first attribute occurence in the ancestor elements subelements
e.g. the JobPriority in NodeInfo

Parameters:

element - node name to look in

attrib - the attribute name

nameSpaceURI - the XML-namespace

def - the default if it does not exist

Returns:

value of attribute found, empty string if not available

Since:

200503

isPartitioned

public boolean isPartitioned()

check whether the Ancestor pool contains any part elements

Returns:

true if the pool comtains part elements