org.cip4.jdflib.pool

Class JDFResourcePool

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

All Implemented Interfaces:

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

public class JDFResourcePool
extends JDFPool

Author:

Dr. Rainer Prosi, Heidelberger Druckmaschinen AG long before June 7, 2009

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

Method Summary

Methods

Modifier and Type	Method and Description
JDFResource	appendResource(JDFResource res) append an existing resource by moving it here
JDFResource	appendResource(String strName, JDFResource.EnumResourceClass resClass, String nameSpaceURI) append a resource
VString	copyResource(JDFResource r, JDFResource.EnumSpawnStatus copyStatus, VJDFAttributeMap vParts, String spawnID) Deprecated. use JDFNode.copySpawnedResources
HashSet<JDFElement>	getAllRefs(HashSet<JDFElement> vDoneRefs, boolean bRecurse) get refElements
static ElemInfoTable[]	getLinkInfoTable() gets the elemeinfotable for the resourcelinkpool based on this pool Note that the cardinality is not updated and that the pool should be used for version checks only
JDFResource	getPoolChild(int i, String strName, JDFAttributeMap mAttrib, String nameSpaceURI) Method getPoolChild get a child resource from the pool matching the parameters
VElement	getPoolChildren(String strName, JDFAttributeMap mAttrib, String nameSpaceURI) Method GetPoolChildren Gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool
VString	getResIds() GetResIds - returns a set of all IDs of the resources that are in this pool
JDFResource	getResource(String strName, int i, String nameSpaceURI) Method GetResource.
JDFResource	getResourceByID(String id) returns a the resource with ID=id, if it is in this pool
protected ElementInfo	getTheElementInfo()
VString	getUnknownElements(boolean bIgnorePrivate, int nMax) return a vector of unknown element nodenames
VElement	getUnlinkedResources() get all completely unlinked resources
String	toString() 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, 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, getTheAttributeInfo, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, 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, 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

JDFResourcePool

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

Constructor for JDFResourcePool

Parameters:

myOwnerDocument -

qualifiedName -

JDFResourcePool

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

Constructor for JDFResourcePool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFResourcePool

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

Constructor for JDFResourcePool

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getTheElementInfo

protected ElementInfo getTheElementInfo()

Overrides:

getTheElementInfo in class JDFElement

Returns:

the elementinfo

getLinkInfoTable

public static ElemInfoTable[] getLinkInfoTable()

gets the elemeinfotable for the resourcelinkpool based on this pool
Note that the cardinality is not updated and that the pool should be used for version checks only

Returns:

ElemInfoTable[] the resourcelinkpools elemeninfotable

toString

public String toString()

toString

Overrides:

toString in class JDFPool

Returns:

String

See Also:

Object.toString()

getResIds

public VString getResIds()

GetResIds - returns a set of all IDs of the resources that are in this pool

Returns:

Vector - all IDs of the pool childs

getResource

public JDFResource getResource(String strName,
                      int i,
                      String nameSpaceURI)

Method GetResource.

default: GetResource(name, 0, JDFConstants.EMPTYSTRING)

Parameters:

strName - name of the resource to look for

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

nameSpaceURI - the namespace to search in

Returns:

JDFResource: the resource you were looking for, null if not found

appendResource

public JDFResource appendResource(JDFResource res)

append an existing resource by moving it here

Parameters:

res - name of the resource to append

Returns:

JDFResource: the appended resource

appendResource

public JDFResource appendResource(String strName,
                         JDFResource.EnumResourceClass resClass,
                         String nameSpaceURI)

append a resource

default: AppendResource(name, resClass, null)

Parameters:

strName - name of the resource to append

resClass - class of the resource to append

nameSpaceURI - the namespace for the resource

Returns:

JDFResource: the appended resource

copyResource

@Deprecated
public VString copyResource(JDFResource r,
                              JDFResource.EnumSpawnStatus copyStatus,
                              VJDFAttributeMap vParts,
                              String spawnID)

Deprecated. use JDFNode.copySpawnedResources

copies a resource recursively, optionally fixes status flags and locks in the source resource

default: copyResource(r, null, new VJDFAttributeMap(), null)

Parameters:

r - the resource to copy into this

copyStatus - rw or ro

vParts - part map vector of the partitions to copy

spawnID - the spawnID of the spawning that initiated the copy

Returns:

VString: vector of resource names that have been copied

getPoolChildren

public VElement getPoolChildren(String strName,
                       JDFAttributeMap mAttrib,
                       String nameSpaceURI)

Method GetPoolChildren Gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool

Parameters:

strName - - name of the child

mAttrib - - a attribute to search for

nameSpaceURI -

Returns:

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

getPoolChild

public JDFResource getPoolChild(int i,
                       String strName,
                       JDFAttributeMap mAttrib,
                       String nameSpaceURI)

Method getPoolChild
get a child resource from the pool matching the parameters

default: GetPoolChild(i, null, null, null)

Parameters:

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

strName - the name of the element

mAttrib - the attribute of the element

nameSpaceURI - the namespace to search in

Returns:

JDFResource: the pool child matching the conditions above

getUnknownElements

public VString getUnknownElements(boolean bIgnorePrivate,
                         int nMax)

return a vector of unknown element nodenames

default: GetUnknownElements(true, 99999999)

Overrides:

getUnknownElements in class JDFElement

Parameters:

bIgnorePrivate - ignores private elements. !Must be here to provide correct validation

nMax - - max entries in vector

Returns:

Vector of unknown element nodenames

getResourceByID

public JDFResource getResourceByID(String id)

returns a the resource with ID=id, if it is in this pool

Parameters:

id - the ID of the requested resource

Returns:

JDFResource: the resource, empty element if it does not exist

getAllRefs

public HashSet<JDFElement> getAllRefs(HashSet<JDFElement> vDoneRefs,
                             boolean bRecurse)

get refElements

Overrides:

getAllRefs in class JDFElement

Parameters:

vDoneRefs - used internally for recursion

bRecurse - if true, also return recursively linked IDs

Returns:

HashSet: the vector of referenced resource IDs

getUnlinkedResources

public VElement getUnlinkedResources()

get all completely unlinked resources

Returns:

V the vector of unlinked resources.