| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Wed Apr 24 20:07:13 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JSONObjectFormatter (OpenJPA Parent POM 3.1.0 API)</title> |
| <meta name="date" content="2019-04-24"> |
| <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="JSONObjectFormatter (OpenJPA Parent POM 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/JSONObjectFormatter.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObject.KVMap.html" title="class in org.apache.openjpa.persistence.jest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/MetamodelHelper.html" title="class in org.apache.openjpa.persistence.jest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/JSONObjectFormatter.html" target="_top">Frames</a></li> |
| <li><a href="JSONObjectFormatter.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.apache.openjpa.persistence.jest</div> |
| <h2 title="Class JSONObjectFormatter" class="title">Class JSONObjectFormatter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.persistence.jest.JSONObjectFormatter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JSONObjectFormatter</span> |
| extends <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> |
| implements <a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></pre> |
| <div class="block">Marshals a root instance and its persistent closure as JSON object. |
| The closure is resolved against the persistence context that contains the root instance. |
| The JSON format introduces a $id and $ref to address reference that pure JSON does not.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Pinaki Poddar</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.openjpa.persistence.jest.ObjectFormatter"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.persistence.jest.<a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a></h3> |
| <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#dateFormat">dateFormat</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#JSONObjectFormatter--">JSONObjectFormatter</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#encode-java.util.Collection-javax.persistence.metamodel.Metamodel-">encode</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| javax.persistence.metamodel.Metamodel model)</code> |
| <div class="block">Encode the <a href="../../../../../org/apache/openjpa/persistence/jest/Closure.html" title="class in org.apache.openjpa.persistence.jest"><code>persistent closure</code></a> of the given collection of managed instances as a |
| resource e.g a XML or HTML document or an interactive document with JavaScript or a JSON array.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#encode-javax.persistence.metamodel.Metamodel-">encode</a></span>(javax.persistence.metamodel.Metamodel model)</code> |
| <div class="block">Encode the given domain model in to a object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#encode-java.lang.Object-org.apache.openjpa.persistence.jest.JPAServletContext-">encode</a></span>(<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> obj, |
| <a href="../../../../../org/apache/openjpa/persistence/jest/JPAServletContext.html" title="interface in org.apache.openjpa.persistence.jest">JPAServletContext</a> ctx)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#getMimeType--">getMimeType</a></span>()</code> |
| <div class="block">Gets the mime type produced by this formatter.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#writeOut-java.util.Collection-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">writeOut</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| javax.persistence.metamodel.Metamodel model, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</code> |
| <div class="block">Encodes the <a href="../../../../../org/apache/openjpa/persistence/jest/Closure.html" title="class in org.apache.openjpa.persistence.jest"><code>persistent closure</code></a> of the given collection of objects, then write it into |
| the given output stream.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html#writeOut-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">writeOut</a></span>(javax.persistence.metamodel.Metamodel model, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</code> |
| <div class="block">Encodes the given domain model, then write it into the given output stream.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JSONObjectFormatter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JSONObjectFormatter</h4> |
| <pre>public JSONObjectFormatter()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMimeType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeType</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMimeType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#getMimeType--">ObjectFormatter</a></code></span></div> |
| <div class="block">Gets the mime type produced by this formatter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#getMimeType--">getMimeType</a></code> in interface <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-java.lang.Object-org.apache.openjpa.persistence.jest.JPAServletContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public void encode(<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> obj, |
| <a href="../../../../../org/apache/openjpa/persistence/jest/JPAServletContext.html" title="interface in org.apache.openjpa.persistence.jest">JPAServletContext</a> ctx)</pre> |
| </li> |
| </ul> |
| <a name="writeOut-java.util.Collection-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeOut</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a> writeOut(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| javax.persistence.metamodel.Metamodel model, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut-java.util.Collection-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">ObjectFormatter</a></code></span></div> |
| <div class="block">Encodes the <a href="../../../../../org/apache/openjpa/persistence/jest/Closure.html" title="class in org.apache.openjpa.persistence.jest"><code>persistent closure</code></a> of the given collection of objects, then write it into |
| the given output stream.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut-java.util.Collection-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">writeOut</a></code> in interface <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sms</code> - the collection of objects to be formatted.</dd> |
| <dd><code>model</code> - a meta-model of managed types, provided for easier introspection if necessary</dd> |
| <dd><code>title</code> - TODO</dd> |
| <dd><code>desc</code> - TODO</dd> |
| <dd><code>uri</code> - TODO</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-java.util.Collection-javax.persistence.metamodel.Metamodel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a> encode(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>> sms, |
| javax.persistence.metamodel.Metamodel model)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode-java.util.Collection-javax.persistence.metamodel.Metamodel-">ObjectFormatter</a></code></span></div> |
| <div class="block">Encode the <a href="../../../../../org/apache/openjpa/persistence/jest/Closure.html" title="class in org.apache.openjpa.persistence.jest"><code>persistent closure</code></a> of the given collection of managed instances as a |
| resource e.g a XML or HTML document or an interactive document with JavaScript or a JSON array. |
| Exact nature of the output type is the generic parameter of this interface.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode-java.util.Collection-javax.persistence.metamodel.Metamodel-">encode</a></code> in interface <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sms</code> - a collection of managed instances</dd> |
| <dd><code>model</code> - domain model</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an encoded object e.g. a XML or HTML Document or a JSON object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-javax.persistence.metamodel.Metamodel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a> encode(javax.persistence.metamodel.Metamodel model)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode-javax.persistence.metamodel.Metamodel-">ObjectFormatter</a></code></span></div> |
| <div class="block">Encode the given domain model in to a object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode-javax.persistence.metamodel.Metamodel-">encode</a></code> in interface <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>model</code> - a meta-model of managed types</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an encoded object e.g. a XML or HTML Document or a JSON object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeOut-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeOut</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a> writeOut(javax.persistence.metamodel.Metamodel model, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">ObjectFormatter</a></code></span></div> |
| <div class="block">Encodes the given domain model, then write it into the given output stream.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut-javax.persistence.metamodel.Metamodel-java.lang.String-java.lang.String-java.lang.String-java.io.OutputStream-">writeOut</a></code> in interface <code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="interface in org.apache.openjpa.persistence.jest">ObjectFormatter</a><<a href="../../../../../org/apache/openjpa/json/JSON.html" title="interface in org.apache.openjpa.json">JSON</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>model</code> - a meta-model of managed types</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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="class-use/JSONObjectFormatter.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObject.KVMap.html" title="class in org.apache.openjpa.persistence.jest"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/MetamodelHelper.html" title="class in org.apache.openjpa.persistence.jest"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/JSONObjectFormatter.html" target="_top">Frames</a></li> |
| <li><a href="JSONObjectFormatter.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2006–2019 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |