| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:48 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ValueStore (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ValueStore (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html" title="class in org.eclipse.persistence.sdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/sdo/ValueStore.html" target="_top">Frames</a></li> |
| <li><a href="ValueStore.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.sdo</div> |
| <h2 title="Interface ValueStore" class="title">Interface ValueStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/sdo/DefaultValueStore.html" title="class in org.eclipse.persistence.sdo">DefaultValueStore</a>, <a href="../../../../org/eclipse/persistence/sdo/helper/jaxb/JAXBValueStore.html" title="class in org.eclipse.persistence.sdo.helper.jaxb">JAXBValueStore</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ValueStore</span></pre> |
| <div class="block"><p><b>Purpose</b> |
| The ValueStore interface exposes the property model in SDO to pluggable implementers |
| that wish to wrap their object model in the SDO API.</p> |
| <p> |
| The ValueStore interface exposes the properties Map in SDODataObject to extension or replacement. |
| The implementing class must override or extend the get/set/isSet/unset ValueStore functions so that |
| any calls routed through the SDO API are routed through to the underlying Data-Model that ValueStore wraps. |
| </p><p> |
| Possible implementers must maintain DataObject integrity |
| which includes containment and changeSummary. |
| |
| </p><p>Setup:<br> |
| Before using the ValueStore interface the type tree must be defined by loading in the |
| XSD schema file that matches the plugged in model if using dynamic classes. |
| </p><p> |
| The ValueStore interface enables 3rd party implementers of the SDO API to plug-in their |
| object model in place of the default SDO DataObject interface. |
| The Map like functions set/get and the List like functions isSet/unset are left to the |
| implementation to maintain.<br> |
| It is the responsibility of the implementation to handle read or read/write capability against the |
| underlying object model. Any access or modification of the pluggable object model done |
| outside of this interface may destabilize the ValueStore state. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html" title="interface in org.eclipse.persistence.sdo">ValueStore</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#copy--">copy</a></span>()</code> |
| <div class="block">Get a shallow copy of the original ValueStore.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#getDeclaredProperty-int-">getDeclaredProperty</a></span>(int propertyIndex)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#getOpenContentProperty-commonj.sdo.Property-">getOpenContentProperty</a></span>(commonj.sdo.Property property)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#initialize-commonj.sdo.DataObject-">initialize</a></span>(commonj.sdo.DataObject dataObject)</code> |
| <div class="block">Perform any post-instantiation integrity operations that could not be done during |
| ValueStore creation.<br> |
| Since the dataObject reference passed in may be bidirectional or self-referencing |
| - we cannot set this variable until the dataObject itself is finished instantiation |
| - hence the 2-step initialization.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#isSetDeclaredProperty-int-">isSetDeclaredProperty</a></span>(int propertyIndex)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#isSetOpenContentProperty-commonj.sdo.Property-">isSetOpenContentProperty</a></span>(commonj.sdo.Property property)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#setDeclaredProperty-int-java.lang.Object-">setDeclaredProperty</a></span>(int propertyIndex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#setManyProperty-commonj.sdo.Property-java.lang.Object-">setManyProperty</a></span>(commonj.sdo.Property propertyName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#setOpenContentProperty-commonj.sdo.Property-java.lang.Object-">setOpenContentProperty</a></span>(commonj.sdo.Property property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#unsetDeclaredProperty-int-">unsetDeclaredProperty</a></span>(int propertyIndex)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html#unsetOpenContentProperty-commonj.sdo.Property-">unsetOpenContentProperty</a></span>(commonj.sdo.Property property)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDeclaredProperty-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredProperty</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getDeclaredProperty(int propertyIndex)</pre> |
| </li> |
| </ul> |
| <a name="getOpenContentProperty-commonj.sdo.Property-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenContentProperty</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getOpenContentProperty(commonj.sdo.Property property)</pre> |
| </li> |
| </ul> |
| <a name="setDeclaredProperty-int-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredProperty</h4> |
| <pre>void setDeclaredProperty(int propertyIndex, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| </li> |
| </ul> |
| <a name="setOpenContentProperty-commonj.sdo.Property-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOpenContentProperty</h4> |
| <pre>void setOpenContentProperty(commonj.sdo.Property property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| </li> |
| </ul> |
| <a name="setManyProperty-commonj.sdo.Property-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setManyProperty</h4> |
| <pre>void setManyProperty(commonj.sdo.Property propertyName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| </li> |
| </ul> |
| <a name="isSetDeclaredProperty-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSetDeclaredProperty</h4> |
| <pre>boolean isSetDeclaredProperty(int propertyIndex)</pre> |
| </li> |
| </ul> |
| <a name="isSetOpenContentProperty-commonj.sdo.Property-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSetOpenContentProperty</h4> |
| <pre>boolean isSetOpenContentProperty(commonj.sdo.Property property)</pre> |
| </li> |
| </ul> |
| <a name="unsetDeclaredProperty-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unsetDeclaredProperty</h4> |
| <pre>void unsetDeclaredProperty(int propertyIndex)</pre> |
| </li> |
| </ul> |
| <a name="unsetOpenContentProperty-commonj.sdo.Property-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unsetOpenContentProperty</h4> |
| <pre>void unsetOpenContentProperty(commonj.sdo.Property property)</pre> |
| </li> |
| </ul> |
| <a name="initialize-commonj.sdo.DataObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>void initialize(commonj.sdo.DataObject dataObject)</pre> |
| <div class="block">Perform any post-instantiation integrity operations that could not be done during |
| ValueStore creation.<br> |
| Since the dataObject reference passed in may be bidirectional or self-referencing |
| - we cannot set this variable until the dataObject itself is finished instantiation |
| - hence the 2-step initialization.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataObject</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre><a href="../../../../org/eclipse/persistence/sdo/ValueStore.html" title="interface in org.eclipse.persistence.sdo">ValueStore</a> copy()</pre> |
| <div class="block">Get a shallow copy of the original ValueStore. |
| Changes made to the copy must not impact the original ValueStore</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ValueStore</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/sdo/SDOXMLDocument.html" title="class in org.eclipse.persistence.sdo"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/sdo/ValueStore.html" target="_top">Frames</a></li> |
| <li><a href="ValueStore.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
