Package org.cip4.jdflib.pool

Class JDFAuditPool

  • 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 JDFAuditPool
extends JDFPool
    This class represents a JDF-AuditPool
    See Also:
    Serialized Form

    • Constructor Detail

      • JDFAuditPool

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

      • JDFAuditPool

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

      • JDFAuditPool

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

      • ensureCreated

        public void ensureCreated()

      • addProcessRun

        @Deprecated
public JDFProcessRun addProcessRun​(JDFElement.EnumNodeStatus s,
                                   java.lang.String by)
        Deprecated.
        use addProcessRun(JDFElement.EnumNodeStatus s, JDFConstants.EMPTYSTRING, new VJDFAttributeMap())
        Add a ProcessRun Audit
        Parameters:
        s - the node status at this time
        by - the author keyword
        Returns:
        JDFProcessRun the newly created ProcessRun audit default: addProcessRun(s, JDFConstants.EMPTYSTRING)

      • addProcessRun

        public JDFProcessRun addProcessRun​(JDFElement.EnumNodeStatus s,
                                   java.lang.String by,
                                   VJDFAttributeMap vmParts)
        Add a ProcessRun Audit
        Parameters:
        s - the node status at this time
        by - the author keyword
        vmParts - the vector of parts that tis processrun applies to
        Returns:
        the newly created ProcessRun audit default: AddProcessRun(s, JDFConstants.EMPTYSTRING)

      • addAudit

        public JDFAudit addAudit​(JDFAudit.EnumAuditType typ,
                         java.lang.String by)
        add an audit, called internally by the specialized functions
        Parameters:
        typ - audit type
        by - the author keyword
        Returns:
        JDFAudit default: AddAudit(typ, JDFConstants.EMPTYSTRING)

      • addCreated

        public JDFCreated addCreated​(java.lang.String by,
                             KElement createdElem)
        Append a Created audit element, if createdElem==null only add if it is not yet there
        Parameters:
        by - the author keyword
        createdElem - the created element
        Returns:
        the newly created Created audit default: AddCreated(by, null)

      • addModified

        public JDFModified addModified​(java.lang.String by,
                               KElement modifiedElem)
        Append a Modified audit element
        Parameters:
        by - the author keyword
        modifiedElem - the modified element default: AddModified(by, null)
        Returns:
        the modified audit

      • addDeleted

        public JDFDeleted addDeleted​(java.lang.String by,
                             KElement deletedElem)
        Append a Deleted audit element
        Parameters:
        by - the author keyword
        deletedElem - the deleted element
        Returns:
        JDFDeleted the newly created Deleted audit default: AddDeleted(null, null)

      • addResourceAudit

        public JDFResourceAudit addResourceAudit​(java.lang.String by)
        append a ResourceAudit audit element
        Parameters:
        by - the author keyword
        Returns:
        JDFResourceAudit - the newly created ResourceAudit audit, null if an error occured

      • addEvent

        public JDFAudit addEvent​(java.lang.String by,
                         JDFAudit.EnumSeverity s)
        add a Notification Audit
        Parameters:
        by - the author keyword
        s - severity of the event
        Returns:
        JDFAudit - the newly created Notification Audit TODO replace with addNotification

      • addPhaseTime

        public JDFPhaseTime addPhaseTime​(JDFElement.EnumNodeStatus phase,
                                 java.lang.String by,
                                 VJDFAttributeMap vmParts)
        Append a PhaseTime audit element
        Parameters:
        phase - the node status at this time
        by - the author keyword
        vmParts - defines a vector of map of parts for which the Spawned is valid
        Returns:
        the newly created PhaseTime audit default: AddPhaseTime(phase, JDFConstants.EMPTYSTRING, new VJDFAttributeMap())

      • addSpawned

        public JDFSpawned addSpawned​(JDFNode spawned,
                             VString rRefsRO,
                             VString rRefsRW,
                             java.lang.String by,
                             VJDFAttributeMap vmParts)
        Append a Spawned audit element
        Parameters:
        spawned - the spawned node
        rRefsRO - a vector of rRefs that are spawned read-only
        rRefsRW - a vector of rRefs that are spawned read-write
        by - the author keyword
        vmParts - the vector of parts
        Returns:
        JDFAudit - the newly created Spawned audit default: AddSpawned(spawned, new Vector(), new Vector(), JDFConstants.EMPTYSTRING, new VJDFAttributeMap())

      • addMerged

        public JDFMerged addMerged​(JDFNode merged,
                           VString rRefsOverwritten,
                           java.lang.String by,
                           VJDFAttributeMap vmParts)
        Append a Merged audit element
        Parameters:
        merged - the merged node
        rRefsOverwritten - a vector of rRefs that are overwritten
        by - the author keyword
        vmParts - the vector of parts
        Returns:
        JDFMerged - the newly created Merged audit default: AddMerged(merged, rRefsOverwritten, JDFConstants.EMPTYSTRING, null)

      • addNotification

        public JDFNotification addNotification​(JDFAutoNotification.EnumClass severity,
                                       java.lang.String by,
                                       VJDFAttributeMap vmParts)
        Append a Notification audit element with a Class attribute of Severity
        Parameters:
        by - the author keyword
        severity - the severity
        vmParts - the vector of parts
        Returns:
        JDFAudit - the newly created Notification audit

      • getLastPhase

        @Deprecated
public JDFPhaseTime getLastPhase()
        Deprecated.
        use getLastPhase(VJDFAttributeMap)
        getLastPhase - get the most recent PhaseTime audit in this pool
        Returns:
        JDFAudit - the last PhaseTime audit

      • getLastPhase

        @Deprecated
public JDFPhaseTime getLastPhase​(VJDFAttributeMap vPartMap)
        Deprecated.
        use getLastPhase(vPartMap, null)
        getLastPhase - get the most recent PhaseTime audit in this pool
        Parameters:
        vPartMap - the list of matching partMaps
        Returns:
        JDFAudit - the last PhaseTime audit

      • getResourceAudits

        public VElement getResourceAudits​(java.lang.String id,
                                  VJDFAttributeMap vPartMap)
        getResourceAudits - get the resourceAudits for a given Resource
        Parameters:
        vPartMap - the list of matching partMaps
        id - the id of the resource
        Returns:
        VElement - the vector of res audits, null if none found

      • getLastPhase

        public JDFPhaseTime getLastPhase​(VJDFAttributeMap vPartMap,
                                 java.lang.String moduleID)
        getLastPhase - get the most recent PhaseTime audit in this pool
        Parameters:
        vPartMap - the list of matching partMaps
        moduleID - the module to restrict the search to, null if any
        Returns:
        JDFAudit - the last PhaseTime audit

      • getAudits

        @Deprecated
public VElement getAudits​(JDFAudit.EnumAuditType typ,
                          JDFAttributeMap mAttributes)
        Deprecated.
        use getAudits(null, null, null)
        getAudits - get all audits with attributes and partMap
        Parameters:
        typ - type of the audit to take
        mAttributes - attribute map to filter the audits
        Returns:
        VElement - all elements, that matches the filter default: getAudits(null, null)

      • getAudits

        public VElement getAudits​(JDFAudit.EnumAuditType typ,
                          JDFAttributeMap mAttributes,
                          VJDFAttributeMap vParts)
        } getAudits - get all audits with attributes and partMap
        Parameters:
        typ - type of the audit to take
        mAttributes - attribute map to filter the audits
        vParts - the partmap vector - note that not all audits legally have parts
        Returns:
        VElement - all elements, that matches the filter default: getAudits(null, null, null)

      • getAudit

        @Deprecated
public JDFAudit getAudit​(int index,
                         JDFAudit.EnumAuditType typ,
                         JDFAttributeMap mAttributes)
        Deprecated.
        use 4 parameter version
        get the index'th audit of the given typ
        Parameters:
        index - index of the audit negativ values are possible and will be substracted from the vector size. For example, your given Filter returns a Vector of 10 Posible Elements and your index is -7 you will get 10 - 7 = Element Number 3
        typ - type of the audit to take
        mAttributes - attribute map to filter the audits
        Returns:
        an Audit that matches the filers default: getAudit(index, typ, null)

      • getAudit

        public JDFAudit getAudit​(int index,
                         JDFAudit.EnumAuditType typ,
                         JDFAttributeMap mAttributes,
                         VJDFAttributeMap vParts)
        get the index'th audit of the given typ
        Parameters:
        index - index of the audit negativ values are possible and will be substracted from the vector size. For example,your given Filter returns a Vector of 10 Posible Elements and your index is -7 you will get 10 - 7 = Element Number 3
        typ - type of the audit to take
        mAttributes - attribute map to filter the audits
        vParts - the partmap vector - note that not all audits legally have parts
        Returns:
        an Audit that matches the filers default: getAudit(index, typ, null)

      • setPhase

        public VElement setPhase​(JDFJMF jmf)
        finds all status messages in a jmf and fills the phaseTime with the appropriate data
        Parameters:
        jmf - the jmf that contains Status messages to apply to this
        Returns:
        vector the vector of all modified phasetime elements

      • setPhase

        @Deprecated
public JDFPhaseTime setPhase​(JDFElement.EnumNodeStatus status,
                             java.lang.String statusDetails,
                             VJDFAttributeMap vmParts)
        Deprecated.
        use the 4 parameter version
        Create or modify a PhaseTime Audit and fill it If the phase is identical to the prior phase that has been set, the existing PhaseTime is modified otherwise an existing phaseTime is closed and a new phaseTime is appended Phasetime elements with different Parts are treated independently
        Parameters:
        status - the node status at this time
        statusDetails - details of this status
        vmParts - defines a vector of map of parts for which the PhaseTime is valid
        Returns:
        JDFPhaseTime the newly created PhaseTime audit default: SetPhase(status, null,null,null)

      • setPhase

        public JDFPhaseTime setPhase​(JDFElement.EnumNodeStatus status,
                             java.lang.String statusDetails,
                             VJDFAttributeMap vmParts,
                             VElement employees)
        Create or modify a PhaseTime Audit and fill it If the phase is identical to the prior phase that has been set, the existing PhaseTime is modified otherwise an existing phaseTime is closed and a new phaseTime is appended Phasetime elements with different Parts are treated independently
        Parameters:
        status - the node status at this time
        statusDetails - details of this status
        vmParts - defines a vector of map of parts for which the PhaseTime is valid
        employees - Vector of employees that are currently registered for this job
        Returns:
        JDFPhaseTime the newly created PhaseTime audit default: SetPhase(status, null,null,null)

      • 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:
        VElement vector with all elements matching the conditions default: getLinkedResources(null, true)

      • getLinks

        @Deprecated
public VElement getLinks​(JDFAttributeMap mLinkAtt)
        Deprecated.
        060216 - this seams to have accidentally been added default: getLinks(null)
        getLinks - get the links matching mLinkAtt out of the resource pool
        Parameters:
        mLinkAtt - the attribute to search for
        Returns:
        VElement - vector all all elements matching the condition mLinkAtt

      • appendUnique

        public void appendUnique​(JDFAudit p)
        Append a new child if no identical child exists
        Parameters:
        p - the Child to add to the element

      • appendUnique

        public void appendUnique​(JDFAuditPool p)
        Append all children of p for which no identical child exists
        Parameters:
        p - the Child to add to the element

      • getPoolChildren

        public VElement getPoolChildren​(java.lang.String strName,
                                JDFAttributeMap mAttrib)
        gets all children with the attribute name,mAttrib, nameSpaceURI out of the pool
        Parameters:
        strName - name of the Child
        mAttrib - an attribute to search for
        Returns:
        VElement: a vector with all elements in the pool matching the conditions default: getPoolChildren(null,null)

      • cleanUpMerge

        @Deprecated
public void cleanUpMerge​(JDFNode.EnumCleanUpMerge cleanPolicy,
                         java.lang.String spawnID)
                  throws java.lang.NoSuchMethodException
        Deprecated.
        use JDFMerge.cleanUpMerge
        Parameters:
        cleanPolicy - .
        spawnID - .
        Throws:
        java.lang.NoSuchMethodException

      • createSubmitProcessRun

        public JDFProcessRun createSubmitProcessRun​(JDFQueueEntry qe)
        creates a ProcessRun when this is submitted should be called by the receiving device when it initially receives and enqueues the JDF
        Parameters:
        qe - the queuentry element to copy information from, if null parameters will be genrated on the fly
        Returns:
        the newly created processRun