Package org.cip4.jdflib.pool

Class JDFStatusPool

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, IStreamWriter, org.w3c.dom.Element, org.w3c.dom.ElementTraversal, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList, org.w3c.dom.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

    • Constructor Detail

      • JDFStatusPool

        public JDFStatusPool​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String qualifiedName)
        Constructor for JDFStatusPool
        Parameters:
        myOwnerDocument -
        qualifiedName -

      • JDFStatusPool

        public JDFStatusPool​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName)
        Constructor for JDFStatusPool
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -

      • JDFStatusPool

        public JDFStatusPool​(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName,
                     java.lang.String myLocalName)
        Constructor for JDFStatusPool
        Parameters:
        myOwnerDocument -
        myNamespaceURI -
        qualifiedName -
        myLocalName -

    • Method Detail

      • toString

        public java.lang.String toString()
        toString
        Overrides:
        toString in class KElement
        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​(java.util.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​(java.util.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​(VJDFAttributeMap vmPart,
                      JDFElement.EnumNodeStatus s,
                      java.lang.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,
                      java.lang.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