org.cip4.jdflib.core

Class JDFRefElement

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.core.JDFRefElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, 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 JDFRefElement
extends JDFElement

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

Method Summary

Modifier and Type	Method and Description
JDFPart	appendPart() Method AppendPart.
JDFElement	deleteRef(boolean bCheckRefCount) delete this refElement and it's target
boolean	fitsName(java.lang.String nodeName, java.lang.String nameSpaceURI) returns true if the name specified fits the node name of this
JDFPart	getCreatePart() get element JDFPart, create one if it doesn't exist
JDFPart	getPart() Get element Part
JDFAttributeMap	getPartMap() get part map
VJDFAttributeMap	getPartMapVector() Deprecated. 060310 not more than one is allowed - use getPartMap
java.lang.String	getRefLocalName() return the Localname of the target
static java.lang.String	getRefName(java.lang.String base)
java.lang.String	getRefNodeName() return the NodeName of the referenced resource
java.lang.String	getrRef() Get string attribute rRef
java.lang.String	getrSubRef() Get string attribute rSubRef
JDFResource	getTarget() get the referenced target resource The resource's PartUsage is evaluated to correctly retrieve implicit or explicit partitions may return null overrides the deprecated method JDFElement.getTarget()
JDFResource	getTargetRoot() get the referenced target resource The resource's PartUsage is evaluated to correctly retrieve implicit or explicit partitions may return null
protected AttributeInfo	getTheAttributeInfo()
protected ElementInfo	getTheElementInfo()
boolean	hasPart() Deprecated. 060310 use inline hasChildElement(ElementName.PART, null);
boolean	hasPartMap(JDFAttributeMap mPart) check whether the part defined in mPart is included
JDFElement	inlineRef() inline this refElement by replacing it with a copy of its target
boolean	isValid(JDFElement.EnumValidationLevel level) Mother of all validators
void	removePart() Deprecated.
void	removePartMap(JDFAttributeMap mPart) removes the part defined in mPart
void	setPartMap(JDFAttributeMap mPart) set all parts to those define in vParts
void	setrRef(java.lang.String value) Set attribute rRef
void	setrSubRef(java.lang.String value) Deprecated. in JDF 1.2
boolean	validResourcePosition()

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, copyChildren, copyInto, createRoot, createRoot, deprecatedAttributes, eraseDefaultAttributes, exclusiveOneOfAttribute, exclusiveOneOfElement, fixVersion, getAllRefs, getAtrType, getAttributeInfo, getBestEffortExceptions, getChildElement, getChildElements, getChildElementVector_JDFElement, getChildElementVector, getChildIds, getChildrenByTagName, getChildrenByTagName, getChildWithAttribute, getChildWithMatchingAttribute, getComment, getComment, getCommentURL, getCreateComment, getCreateElement_JDFElement, getCreatePreview, getCreateRefElement, getDeepElementByID, getDefaultAttributeMap, getDefaultJDFVersion, getDeprecatedAttributes, getDeprecatedElements, getDescriptiveName, getElement_JDFElement, getElement, getElementIDPrefix, getElementInfo, getElementNameVector, getEnumAttribute, getEnumerationsAttribute, getEnumerationsAttribute, getEnumforAttribute, getEnumNodeName, getEnumString, getFirstVersion, getGeneralID, getGeneralID, getGeneralID, getGeneralIDListMap, getGeneralIDMap, getGeneralIDVectorMap, getHRef, getHRefs, getHRefs, getInsertElements, getInsertElementVector, getInvalidAttributes, getInvalidElements_JDFElement, getInvalidElements, getJDFRoot, getJMFRoot, getLastVersion, getLinkFromUserData, getLinkRoot, getMaxVersion, getMissingAttributes, getMissingAttributeVector, getMissingElements, getMissingElementVector, getMustHonorExceptions, getNamesVector, getOperatorInterventionExceptions, getOwnerDocument_JDFElement, getParentJDF, getParentJDF, getPartMapArray, getPrereleaseAttributes, getPrereleaseElements, getPreview, getRefElement, getRefElements, getRefString, getrRefs, getSchemaURL, getSchemaURL, getSchemaURL, getSettingsPolicy, getStatus, getTarget_JDFElement, getTarget, getTheAttributeInfo_JDFElement, getTheElementInfo_JDFElement, getTypeForAttribute, getUnknownAttributes, getUnknownAttributeVector, getUnknownElements, getUnknownElementVector, getUnknownPoolElements, getURLDoc, getURLInputStream, getValueForNewAttribute, getVersion, getVersion, getvHRefRes, getvHRefRes, getXMLDocUserData, hasMissingAttributes, hasMissingElements, hasSettingsPolicy, hasUnknownAttributes, hasUnknownElements, idString, includesMatchingAttribute, init, inlineRefElements, insertBefore, isComment, isCommentStatic, isDeprecated, isDirty, isInAnyJDFNameSpaceStatic, isInAnyJDFNameSpaceStatic, isInJDFNameSpace, isInJDFNameSpaceStatic, isInJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isInXJDFNameSpaceStatic, isJDFNode, isRefElement, isRefElementStatic, isResource, isResourceLink, isResourceLinkStatic, isResourceStatic, isResourceUpdate, isValid_JDFElement, isXJDF, jdfVersion, knownAttributes, knownElements, matchesPath, newID, numChildElements_JDFElement, numChildElements, optionalAttributes, optionalElements, prereleaseAttributes, prereleaseElements, refElement, removeBestEffortExceptions, removeChild, removeChild, removeChildren, removeExtensions, removeFromBestEffortExceptions, removeFromMustHonorExceptions, removeFromOperatorInterventionExceptions, removeFromrRefs, removeGeneralID, 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, setPartMapVector, setSettingsPolicy, setStatus, 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, appendAttributes, appendCData, appendCData, appendChild, appendElement, appendElementN, appendElementRaw, appendEntityReference, appendText, appendTextElement, appendXMLComment, appendXMLComment, buildRelativeXPath, buildXPath, buildXPath, buildXPath, cleanup, clearNSMap, clone, copyAttribute, copyAttribute, copyAttribute, copyAttribute, copyElement, copyElements, copyXPathValue, createRoot, deleteNode, ensureCase, eraseEmptyAttributes, eraseEmptyNodes, fillHashSet, fitsName_KElement, flush, generateDotID, getAttribute_KElement, getAttribute_KElement, getAttribute, getAttribute, getAttributeArray_KElement, getAttributeIgnoreCase, getAttributeMap_KElement, getAttributeMap, getAttributeRaw, getAttributeVector_KElement, getAttributeVector, getBoolAttribute, getCData, getChildArray_KElement, getChildArray, getChildArrayByClass_KElement, getChildArrayByClass, getChildAttributeList, getChildByTagName, getChildElementArray, getChildElementVector_KElement, getChildElementVector, getChildElementVector, getChildFromList, getChildFromList, getChildList, getChildList, getChildNode, getChildNodes_KElement, getChildNodeVector, getChildrenByClass, getChildrenByTagName_KElement, getChildrenByTagName, getChildrenFromList, getChildrenIgnoreList, getChildrenWithAttribute, getChildWithAttribute, getChildWithAttribute, getCreateChildWithAttribute, 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, getIgnoreCase_KElement, getIgnoreCase, getInheritedAttribute, getInheritedElement, getInheritedXPathAttribute, getIntAttribute, getLocalNameStatic, getLongAttribute, getMultipleIDs, getNamespaceURI, getNamespaceURIFromPrefix, getNextElementNode, getNextSiblingElement, getNextSiblingElement, getNextSiblingElement, getNonEmpty_KElement, getNonEmpty, getNumCDatas, getNumChildNodes, getNumChildText, getNumXMLComments, getOwnerDocument_KElement, getParentNode_KElement, getPreviousSiblingElement, getPreviousSiblingElement, getRealAttribute, getTarget_KElement, getText, getText, getTree, getTree, getTreeByClass, getTreeElement, getXMLComment, getXMLNSNameSpace, getXMLNSPrefix, getXPathAttribute, getXPathAttributeMap, getXPathElement, getXPathElementVector, getXPathValueMap, getXPathValueMap, getXSIType, hasAttribute_KElement, hasAttribute, hasAttribute, hasAttributes, hasChildElement, hasChildElements, hasChildNodes, hasChildText, hasNonEmpty_KElement, hasNonEmpty, hasXPathNode, includesAttribute, includesAttributes, insertAt, insertBefore, isAncestor, isEqual, isEqual, isWildCard, matchesPath, matchesPathName, mergeElement, moveArray, moveAttribute, moveAttribute, moveElement, moveElements, moveMe, normalize, numChildElements_KElement, numChildNodes, numChildNodes, numChildrenByClass, numSiblingElements, parseFile, parseStream, parseString, pushUp, removeAllText, removeAttribute_KElement, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeAttributes, removeCData, removeChildNode, removeChildren, removeChildrenByClass, removeChildText, removeExtensions, removeFromAttribute, removeIgnoreCase_KElement, removeIgnoreCase, removeXMLComment, removeXPathAttribute, removeXPathElement, renameAttribute, renameAttribute, renameElement, replaceElement, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setAttributeNSRaw, setAttributeRaw, setAttributes, setAttributes, setAttributes, setAttributesRaw, setBoolAttribute, setDirty, setID, setIntAttribute, setNamespaceURI, setNodeValue, setNonEmpty, setPrefix, setRealAttribute, setText, setvStringAttribute, setXMLComment, setXMLComment, setXPathAttribute, setXPathValue, setXPathValues, setXSIType, sortChild, sortChild, sortChildren, sortChildren, sortChildren, sortChildren, toDisplayXML, toString, toValueString, toXML, toXML, uniqueID, uniqueID, write2File, write2File, write2Stream, xmlNameSpace, xmlnsLocalName, xmlnsPrefix

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

cloneNode, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, 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

JDFRefElement

public JDFRefElement(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String qualifiedName)

Constructor for JDFRefElement

Parameters:

myOwnerDocument -

qualifiedName -

JDFRefElement

public JDFRefElement(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName)

Constructor for JDFRefElement

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

JDFRefElement

public JDFRefElement(org.apache.xerces.dom.CoreDocumentImpl myOwnerDocument,
                     java.lang.String myNamespaceURI,
                     java.lang.String qualifiedName,
                     java.lang.String myLocalName)

Constructor for JDFRefElement

Parameters:

myOwnerDocument -

myNamespaceURI -

qualifiedName -

myLocalName -

Method Detail

getTheAttributeInfo

protected AttributeInfo getTheAttributeInfo()

Overrides:

getTheAttributeInfo in class JDFElement

Returns:

getTheElementInfo

protected ElementInfo getTheElementInfo()

Overrides:

getTheElementInfo in class JDFElement

Returns:

the elementinfo

hasPart

@Deprecated
public boolean hasPart()

Deprecated. 060310 use inline hasChildElement(ElementName.PART, null);

test Part element existence

Returns:

setrRef

public void setrRef(java.lang.String value)

Set attribute rRef

Parameters:

value - the value to set the attribute to

fitsName

public boolean fitsName(java.lang.String nodeName,
                        java.lang.String nameSpaceURI)

returns true if the name specified fits the node name of this

Overrides:

fitsName in class KElement

Parameters:

nodeName - the name of the node to test. may be either local or qualified

nameSpaceURI - the namespace of the node to test.

Returns:

true if ok

getrRef

public java.lang.String getrRef()

Get string attribute rRef

Returns:

String - the vaue of the attribute

setrSubRef

@Deprecated
public void setrSubRef(java.lang.String value)

Deprecated. in JDF 1.2

Set attribute rSubRef

Parameters:

value - the value to set the attribute to

getrSubRef

public java.lang.String getrSubRef()

Get string attribute rSubRef

Returns:

String - the vaue of the attribute

isValid

public boolean isValid(JDFElement.EnumValidationLevel level)

Description copied from class: JDFElement

Mother of all validators

Overrides:

isValid in class JDFElement

Parameters:

level - validation level

• level EnumValidationLevel.None: always return true;
• level EnumValidationLevel.Construct: incomplete and null elements are valid.
• level EnumValidationLevel.Incomplete: incomplete elements are valid
• level EnumValidationLevel.Complete: full validation
• level EnumValidationLevel.RecursiveIncomplete: incomplete validation but follow links
• level EnumValidationLevel.RecursiveComplete: full validation and follow links downward

Returns:

boolean the validity of the node

See Also:

JDFElement.isValid(org.cip4.jdflib.core.JDFElement.EnumValidationLevel)

validResourcePosition

public boolean validResourcePosition()

Returns:

getTargetRoot

public JDFResource getTargetRoot()

get the referenced target resource The resource's PartUsage is evaluated to correctly retrieve implicit or explicit partitions
may return null

Returns:

JDFResource - the reference target partition

getTarget

public JDFResource getTarget()

get the referenced target resource The resource's PartUsage is evaluated to correctly retrieve implicit or explicit partitions
may return null overrides the deprecated method JDFElement.getTarget()

Overrides:

getTarget in class JDFElement

Returns:

JDFResource - the reference target partition

getPart

public JDFPart getPart()

Get element Part

Returns:

JDFPart - the element

getRefNodeName

public java.lang.String getRefNodeName()

return the NodeName of the referenced resource

Returns:

the nodename of the referenced resource

getRefLocalName

public java.lang.String getRefLocalName()

return the Localname of the target

Returns:

inlineRef

public JDFElement inlineRef()

inline this refElement by replacing it with a copy of its target

Returns:

JDFElement - the newly created element

Throws:

JDFException - if no target exists

deleteRef

public JDFElement deleteRef(boolean bCheckRefCount)

delete this refElement and it's target

Parameters:

bCheckRefCount - if true, check that no other element refers to the target before deleting
if bCheckRefCount=false, the target is force deleted

Returns:

JDFElement the deleted targeelement

Since:

290502

appendPart

public JDFPart appendPart()

Method AppendPart.

Returns:

JDFPart

getRefName

public static java.lang.String getRefName(java.lang.String base)

Parameters:

base -

Returns:

getCreatePart

public JDFPart getCreatePart()

get element JDFPart, create one if it doesn't exist

Returns:

JDFPart

removePart

@Deprecated
public void removePart()

Deprecated.

getPartMapVector

@Deprecated
public VJDFAttributeMap getPartMapVector()

Deprecated. 060310 not more than one is allowed - use getPartMap

get part map vector

Overrides:

getPartMapVector in class JDFElement

Returns:

VJDFAttributeMap: vector of attribute maps, one for each part

getPartMap

public JDFAttributeMap getPartMap()

get part map

Overrides:

getPartMap in class JDFElement

Returns:

JDFAttributeMap: the attribute maps, one for each part

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)

Description copied from class: JDFElement

removes 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:

boolean - returns true if the part exists