public class XMLDocUserData extends Object
Modifier and Type | Class and Description |
---|---|
static class |
XMLDocUserData.EnumDirtyPolicy
Enumeration of various policies
|
Constructor and Description |
---|
XMLDocUserData(DocumentJDFImpl parent)
constructor
|
Modifier and Type | Method and Description |
---|---|
void |
clearDirtyIDs()
clear the vector of all IDs of elements that are dirty
|
void |
clearTargets()
clear the map of all targets
|
void |
fillIDCache()
clear the map of all targets
|
VString |
getDirtyIDs()
get a vector of all IDs of elements that are dirty
|
Object |
getDirtyPolicy() |
VString |
getDirtyXPaths()
get the vector of dirty XPaths
|
static boolean |
getIDCache()
get the status of the caching method for ids
|
KElement |
getTarget(String strID)
Get the target with ID=
strID |
Object |
getUserData()
Return the documents user data pointer.
|
boolean |
hasTargetCache()
is target cashing enabled
|
boolean |
isDirty(KElement element)
checks if
element is dirty |
boolean |
isDirty(String strID)
checks wheter the node with
strID is dirty |
void |
removeTarget(KElement targetElement)
remove the KElement from the target list
|
void |
removeTarget(String id)
remove the target id from the target list
|
void |
setDirtyPolicy(XMLDocUserData.EnumDirtyPolicy dirtPol)
Set the dirty policy to dirtPol
|
static void |
setIDCache(boolean bCache)
switch on or off the caching method for ids
|
void |
setTarget(KElement targetElement,
String id)
Set the target to target
|
void |
setUserData(Object objUserData)
Set the user data for a document.
|
public XMLDocUserData(DocumentJDFImpl parent)
parent
- public static void setIDCache(boolean bCache)
bCache
- if true, the ids will be cachedpublic static boolean getIDCache()
public boolean hasTargetCache()
public void setDirtyPolicy(XMLDocUserData.EnumDirtyPolicy dirtPol)
dirtPol
- the dirtyPolicy to setpublic Object getUserData()
JDFDoc::SetUserData(p)
.public void setUserData(Object objUserData)
DOM_Node::getUserData(p)
.
Deletion of the user data remains the responsibility of the application program; it will not be automatically deleted when the nodes themselves are reclaimed.
Because DOM_Node is not designed to be subclassed, userdata provides an alternative means for extending the information kept with nodes by an application program.
objUserData
- the user data to be kept with the node.public VString getDirtyIDs()
public VString getDirtyXPaths()
public void clearDirtyIDs()
public boolean isDirty(KElement element)
element
is dirtyelement
- element to checkelement
is dirtypublic boolean isDirty(String strID)
strID
is dirtystrID
- the id of the node to be checkedstrID
is dirtypublic void setTarget(KElement targetElement, String id)
targetElement
- the target elementid
- public void removeTarget(KElement targetElement)
targetElement
- the element to removepublic void removeTarget(String id)
id
- the target element idpublic KElement getTarget(String strID)
strID
strID
- the id of the target to searchpublic void clearTargets()
public void fillIDCache()
public Object getDirtyPolicy()
Copyright © 2018. All rights reserved.