Skip navigation links

org.eclipse.persistence.oxm.documentpreservation
Class DocumentPreservationPolicy

java.lang.Object
org.eclipse.persistence.oxm.documentpreservation.DocumentPreservationPolicy

public abstract class DocumentPreservationPolicy

extends java.lang.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

  Field Summary

  private NodeOrderingPolicy

  nodeOrderingPolicy

  Constructor Summary

  DocumentPreservationPolicy()
  

  Method Summary

  abstract void	addObjectToCache(java.lang.Object obj, org.w3c.dom.Node node)
  abstract void	addObjectToCache(java.lang.Object obj, org.w3c.dom.Node node, XMLMapping selfRecordMapping)
  abstract org.w3c.dom.Node	getNodeForObject(java.lang.Object obj)
  NodeOrderingPolicy	getNodeOrderingPolicy()
  abstract java.lang.Object	getObjectForNode(org.w3c.dom.Node node)
  abstract java.lang.Object	getObjectForNode(org.w3c.dom.Node node, XMLMapping selfRecordMapping)
  void	initialize(XMLContext context)
  void	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()

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  nodeOrderingPolicy

  private NodeOrderingPolicy nodeOrderingPolicy
  

  Constructor Detail

  DocumentPreservationPolicy

  public DocumentPreservationPolicy()
  

  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.

  See Also:

  AppendNewElementsOrderingPolicy, IgnoreNewElementsOrderingPolicy, RelativePositionNodeOrderingPolicy

  getNodeOrderingPolicy

  public NodeOrderingPolicy getNodeOrderingPolicy()
  

  addObjectToCache

  public abstract void addObjectToCache(java.lang.Object obj,
                                        org.w3c.dom.Node node)
  

  addObjectToCache

  public abstract void addObjectToCache(java.lang.Object obj,
                                        org.w3c.dom.Node node,
                                        XMLMapping selfRecordMapping)
  

  getNodeForObject

  public abstract org.w3c.dom.Node getNodeForObject(java.lang.Object obj)
  

  getObjectForNode

  public abstract java.lang.Object getObjectForNode(org.w3c.dom.Node node)
  

  getObjectForNode

  public abstract java.lang.Object getObjectForNode(org.w3c.dom.Node node,
                                                    XMLMapping selfRecordMapping)
  

  shouldPreserveDocument

  public abstract boolean shouldPreserveDocument()
  

  initialize

  public void initialize(XMLContext context)