Package 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, IStreamWriter, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class JDFAncestorPool extends JDFAutoAncestorPool
Description: This class represents an JDFAncestorPool
See Also:

  • Constructor Details

    • 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 Details

    • 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

    • getGeneralID

      public String getGeneralID(String idUsage, int iPos)
      Gets IDValue of the GeneralID with IDUsage=idUsage null, if none exists
      Overrides:
      getGeneralID in class JDFElement
      Parameters:
      idUsage -
      iPos -
      Returns:
      String the attribute value

    • 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

    • getPartMapArray

      public JDFAttributeMapArray getPartMapArray()
      get part map array
      Overrides:
      getPartMapArray in class JDFElement
      Returns:
      array of attribute, 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