Class DocumentPreservationPolicy
- java.lang.Object
-
- org.eclipse.persistence.oxm.documentpreservation.DocumentPreservationPolicy
-
- Direct Known Subclasses:
DescriptorLevelDocumentPreservationPolicy
,NoDocumentPreservationPolicy
,XMLBinderPolicy
public abstract class DocumentPreservationPolicy extends Object
Purpose:Provides an interface for customizing how Documents are preserved.Responsibilities:
- Access objects from the cache based on node
- Access nodes from the cache based on Object
- Add objects and nodes to the cache
- Allow the configuration of how nodes are added into the preserved doc
- Since:
- Oracle TopLink 11g
- Author:
- mmacivor
-
-
Constructor Summary
Constructors Constructor Description DocumentPreservationPolicy()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
addObjectToCache(Object obj, Node node)
abstract void
addObjectToCache(Object obj, Node node, Mapping selfRecordMapping)
abstract Node
getNodeForObject(Object obj)
NodeOrderingPolicy
getNodeOrderingPolicy()
abstract Object
getObjectForNode(Node node)
abstract Object
getObjectForNode(Node node, Mapping selfRecordMapping)
void
initialize(Context context)
INTERNALvoid
setNodeOrderingPolicy(NodeOrderingPolicy policy)
PUBLIC: Sets the NodeOrderingPolicy to be used by this DocumentPreservationPolicy when adding new elements into a cached XML Document.abstract boolean
shouldPreserveDocument()
-
-
-
Method Detail
-
setNodeOrderingPolicy
public void setNodeOrderingPolicy(NodeOrderingPolicy policy)
PUBLIC: Sets the NodeOrderingPolicy to be used by this DocumentPreservationPolicy when adding new elements into a cached XML Document.
-
getNodeOrderingPolicy
public NodeOrderingPolicy getNodeOrderingPolicy()
-
addObjectToCache
public abstract void addObjectToCache(Object obj, Node node, Mapping selfRecordMapping)
- Since:
- EclipseLink 2.5.0
-
shouldPreserveDocument
public abstract boolean shouldPreserveDocument()
-
initialize
public void initialize(Context context)
INTERNAL
-
-