org.cip4.jdflib.core

Class JDFAudit

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.auto.JDFAutoAudit

org.cip4.jdflib.core.JDFAudit

All Implemented Interfaces:

Serializable, Cloneable, Comparator<JDFAudit>, Element, EventTarget, Node, NodeList, TypeInfo

Direct Known Subclasses:

JDFAutoCreated, JDFAutoDeleted, JDFAutoMerged, JDFAutoModified, JDFAutoNotification, JDFAutoPhaseTime, JDFAutoProcessRun, JDFAutoResourceAudit, JDFAutoSpawned

public class JDFAudit
extends JDFAutoAudit
implements Comparator<JDFAudit>

This class represents a JDF-Audit which handles individual Audit elements

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JDFAudit.EnumAuditType
static class	JDFAudit.EnumSeverity

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

Method Summary

Methods

Modifier and Type	Method and Description
JDFEmployee	appendEmployee() (30) append element Employee
int	compare(JDFAudit a1, JDFAudit a2) sort by timestamp
JDFAudit	createUpdateAudit() create an update audit for this
Collection<JDFEmployee>	getAllEmployee() Get all Employee from the current element
JDFAuditPool	getAuditPool()
JDFAudit.EnumAuditType	getAuditType() GetAuditType
JDFEmployee	getCreateEmployee(int iSkip) (26) getCreateEmployee
JDFEmployee	getEmployee(int iSkip) (27) const get element Employee
protected JDFElement.EnumNodeStatus	getEndStatus() GetEndStatus
String	getIDPrefix() getIDPrefix
VJDFAttributeMap	getPartMapVector() get part map vector
JDFElement.EnumNodeStatus	getPhase() Deprecated. use JDFPhaseTime.getStatus()
JDFAudit.EnumSeverity	getSeverity() Deprecated. - only valid in the respective subclasses
static String	getStaticAgentName() Gets the default static AgentName that is used to preset @AgentName when generating a new Audit
static String	getStaticAgentVersion() gets the default static AgentVersion that is used to preset @AgentName when generating a new Audit
static String	getStaticAuthor() Gets the default static Author that is used to preset @AgentName when generating a new Audit
protected ElementInfo	getTheElementInfo()
JDFDate	getTimeStampDate() Deprecated. - use getTimeStamp
JDFAudit	getUpdatedPreviousAudit() get the previous updated audit that was updated by this
boolean	init() init
void	setBy(String by) Deprecated. 2005-09-01 use setAuthor()
void	setEndStatus(JDFElement.EnumNodeStatus s) Deprecated. - only valid in the respective subclasses
void	setPart(JDFAttributeMap m) Deprecated. 2005-10-20 - use setPartMap() in the various subclasses instead
void	setRef(JDFAudit previous) Set attribute refID to the ID of previous
void	setSeverity(JDFAudit.EnumSeverity s) Deprecated. - only valid in the respective subclasses
static void	setStaticAgentName(String agentName) sets the default static AgentName that is used to preset @AgentName when generating a new Audit
static void	setStaticAgentVersion(String agentVersion) Sets the default static AgentVersion that is used to preset @AgentName when generating a new Audit
static void	setStaticAuthor(String author) sets the default static Author that is used to preset @Author when generating a new Audit
void	setStatus(JDFElement.EnumNodeStatus s) SetStatus
void	setTimeStamp() Deprecated. 2005-12-02 use setTimeStamp(null)
static String	software() Software
String	toString() toString

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

getAgentName, getAgentVersion, getAuthor, getID, getQueueEntryID, getrefID, getSpawnID, getTheAttributeInfo, getTimeStamp, setAgentName, setAgentVersion, setAuthor, setID, setQueueEntryID, setrefID, setSpawnID, setTimeStamp

Methods inherited from class org.cip4.jdflib.core.JDFElement

appendAnchor, appendBestEffortExceptions, appendComment, appendElement, appendGeneralID, 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, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasPartMap, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, 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, setVersion, setvStringAttribute, stringToVersion, uniqueElements, upDaterRefs, validAttribute, validAttribute, validEnumAttribute, validEnumerationsAttribute, validResourcePosition, version, write2Dir

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, buildRelativeXPath, 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_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getCreateChildWithAttribute, getCreateElement_KElement, getCreateElement, getCreateElement, getCreateXPathElement, getDeepElement, getDeepParent, getDeepParent, getDeepParentChild, getDeepParentNotName, getDocRoot, getDOMAttr, getElement_KElement, getElement, getElementByClass, getElementHashMap, getElementsByTagName_KElement, getFirstChildElement, getFirstChildElement, getFirstChildElement, getFirstElementNode, 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, insertAt, insertBefore, isAncestor, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, 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, 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 java.util.Comparator

equals

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

JDFAudit

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

Constructor for JDFAudit

Parameters:

myOwnerDocument -

qualifiedName -

JDFAudit

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

Constructor for JDFAudit

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFAudit

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

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getTheElementInfo

protected ElementInfo getTheElementInfo()

Overrides:

getTheElementInfo in class JDFElement

Returns:

the elementinfo

See Also:

JDFElement.getTheElementInfo()

toString

public String toString()

toString

Overrides:

toString in class JDFAutoAudit

Returns:

String

See Also:

Object.toString()

compare

public int compare(JDFAudit a1,
          JDFAudit a2)

sort by timestamp

Specified by:

compare in interface Comparator<JDFAudit>

Parameters:

a1 - an audit

a2 - another audit

Returns:

@see java.util.Comparator#compare(java.lang.Object, java.lang.Object)

See Also:

Comparator.compare(java.lang.Object, java.lang.Object)

setSeverity

@Deprecated
public void setSeverity(JDFAudit.EnumSeverity s)

Deprecated. - only valid in the respective subclasses

SetSeverity

Parameters:

s -

getSeverity

@Deprecated
public JDFAudit.EnumSeverity getSeverity()

Deprecated. - only valid in the respective subclasses

GetSeverity

Returns:

EnumSeverity

setStatus

public void setStatus(JDFElement.EnumNodeStatus s)

SetStatus

Overrides:

setStatus in class JDFElement

Parameters:

s -

setEndStatus

@Deprecated
public void setEndStatus(JDFElement.EnumNodeStatus s)

Deprecated. - only valid in the respective subclasses

SetEndStatus

Parameters:

s -

getEndStatus

protected JDFElement.EnumNodeStatus getEndStatus()

GetEndStatus

Returns:

JDFElement.EnumNodeStatus

getAuditType

public JDFAudit.EnumAuditType getAuditType()

GetAuditType

Returns:

EnumAuditType

getPhase

@Deprecated
public JDFElement.EnumNodeStatus getPhase()

Deprecated. use JDFPhaseTime.getStatus()

GetPhase

Returns:

JDFElement.EnumNodeStatus

setPart

@Deprecated
public void setPart(JDFAttributeMap m)

Deprecated. 2005-10-20 - use setPartMap() in the various subclasses instead

SetPart

Parameters:

m -

getPartMapVector

public VJDFAttributeMap getPartMapVector()

get part map vector

Overrides:

getPartMapVector in class JDFElement

Returns:

VJDFAttributeMap: vector of mAttribute, one for each part

setRef

public void setRef(JDFAudit previous)

Set attribute refID to the ID of previous

Parameters:

previous - the previous audit that is referenced

setBy

@Deprecated
public void setBy(String by)

Deprecated. 2005-09-01 use setAuthor()

SetBy

Parameters:

by -

software

public static String software()

Software

Returns:

String

init

public boolean init()

init

Overrides:

init in class KElement

Returns:

boolean

getIDPrefix

public String getIDPrefix()

Description copied from class: KElement

getIDPrefix

Overrides:

getIDPrefix in class KElement

Returns:

the default ID prefix of non-overwritten JDF elements

See Also:

KElement.getIDPrefix()

setTimeStamp

@Deprecated
public void setTimeStamp()

Deprecated. 2005-12-02 use setTimeStamp(null)

SetTimeStamp

getTimeStampDate

@Deprecated
public JDFDate getTimeStampDate()

Deprecated. - use getTimeStamp

(12) get JDFDate attribute TimeStamp

Returns:

JDFDate the value of the attribute

getAuditPool

public JDFAuditPool getAuditPool()

Returns:

the parent audit pool

createUpdateAudit

public JDFAudit createUpdateAudit()

create an update audit for this

Returns:

a new audit that updates this

getUpdatedPreviousAudit

public JDFAudit getUpdatedPreviousAudit()

get the previous updated audit that was updated by this

Returns:

the audit that was replaced by this

getStaticAgentName

public static String getStaticAgentName()

Gets the default static AgentName that is used to preset @AgentName when generating a new Audit

Returns:

Returns the m_strAgentName.

setStaticAgentName

public static void setStaticAgentName(String agentName)

sets the default static AgentName that is used to preset @AgentName when generating a new Audit

Parameters:

agentName - The m_strAgentName to set.

getStaticAuthor

public static String getStaticAuthor()

Gets the default static Author that is used to preset @AgentName when generating a new Audit

Returns:

Returns the m_Author.

setStaticAuthor

public static void setStaticAuthor(String author)

sets the default static Author that is used to preset @Author when generating a new Audit

Parameters:

author - The m_strAuthor to set.

getStaticAgentVersion

public static String getStaticAgentVersion()

gets the default static AgentVersion that is used to preset @AgentName when generating a new Audit

Returns:

sTRING the m_strAgentVersion.

setStaticAgentVersion

public static void setStaticAgentVersion(String agentVersion)

Sets the default static AgentVersion that is used to preset @AgentName when generating a new Audit

Parameters:

agentVersion - The m_strAgentVersion to set.

getCreateEmployee

public JDFEmployee getCreateEmployee(int iSkip)

(26) getCreateEmployee

Parameters:

iSkip - number of elements to skip

Returns:

JDFEmployee the element

getEmployee

public JDFEmployee getEmployee(int iSkip)

(27) const get element Employee

Parameters:

iSkip - number of elements to skip

Returns:

JDFEmployee the element default is getEmployee(0)

getAllEmployee

public Collection<JDFEmployee> getAllEmployee()

Get all Employee from the current element

Returns:

Collection

appendEmployee

public JDFEmployee appendEmployee()
                           throws JDFException

(30) append element Employee

Returns:

Throws:

JDFException