| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:09 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ObjectFormatter (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ObjectFormatter (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ObjectFormatter.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/MetamodelHelper.AttributeComparator.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/ObjectFormatter.html" target="_top">Frames</a></li> |
| <li><a href="ObjectFormatter.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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.apache.openjpa.persistence.jest</div> |
| <h2 title="Interface ObjectFormatter" class="title">Interface ObjectFormatter<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of encoded output</dd></dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/openjpa/persistence/jest/JSONObjectFormatter.html" title="class in org.apache.openjpa.persistence.jest">JSONObjectFormatter</a>, <a href="../../../../../org/apache/openjpa/persistence/jest/XMLFormatter.html" title="class in org.apache.openjpa.persistence.jest">XMLFormatter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ObjectFormatter<T></span></pre> |
| <div class="block">A parameterized interface defines the protocol for converting <a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>managed</code></a> persistence |
| instances or a persistent <code>domain model</code> into a form suitable for transport to a language-neutral |
| client such as an web browser. |
| <p> |
| The interface prefers that the resultant resource as a <em>complete</em> representation i.e. all the references |
| contained in the resource can be resolved within the same resource itself. As the intended recipient of this |
| resource is a remote client, an <em>incomplete</em> resource will require the client to request further for |
| any (unresolved) reference resulting in a <em>chatty</em> protocol. |
| <p> |
| This interface also defines methods for writing the representation into an output stream e.g. |
| <code>response output stream</code> of a HTTP Servlet. |
| <p> |
| Implementation Note: Each concrete formatter type is registered with <a href="../../../../../org/apache/openjpa/persistence/jest/PrototypeFactory.html" title="class in org.apache.openjpa.persistence.jest">factory</a> |
| that requires the implementation to have a no-argument constructor.</div> |
| <dl><dt><span class="strong">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> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#dateFormat">dateFormat</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode(java.util.Collection,%20javax.persistence.metamodel.Metamodel)">encode</a></strong>(<a href="http://docs.oracle.com/javase/6/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>> objs, |
| 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 class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#encode(javax.persistence.metamodel.Metamodel)">encode</a></strong>(javax.persistence.metamodel.Metamodel model)</code> |
| <div class="block">Encode the given domain model in to a object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#getMimeType()">getMimeType</a></strong>()</code> |
| <div class="block">Gets the mime type produced by this formatter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut(java.util.Collection,%20javax.persistence.metamodel.Metamodel,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.io.OutputStream)">writeOut</a></strong>(<a href="http://docs.oracle.com/javase/6/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>> objs, |
| javax.persistence.metamodel.Metamodel model, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="http://docs.oracle.com/javase/6/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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html#writeOut(javax.persistence.metamodel.Metamodel,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.io.OutputStream)">writeOut</a></strong>(javax.persistence.metamodel.Metamodel model, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="http://docs.oracle.com/javase/6/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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="dateFormat"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dateFormat</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text">SimpleDateFormat</a> dateFormat</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><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getMimeType()</pre> |
| <div class="block">Gets the mime type produced by this formatter.</div> |
| </li> |
| </ul> |
| <a name="encode(java.util.Collection, javax.persistence.metamodel.Metamodel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encode</h4> |
| <pre><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a> encode(<a href="http://docs.oracle.com/javase/6/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>> objs, |
| javax.persistence.metamodel.Metamodel model)</pre> |
| <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="strong">Parameters:</span></dt><dd><code>objs</code> - a collection of managed instances</dd><dd><code>model</code> - domain model</dd> |
| <dt><span class="strong">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><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a> encode(javax.persistence.metamodel.Metamodel model)</pre> |
| <div class="block">Encode the given domain model in to a object.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>model</code> - a meta-model of managed types</dd> |
| <dt><span class="strong">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(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><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a> writeOut(<a href="http://docs.oracle.com/javase/6/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>> objs, |
| javax.persistence.metamodel.Metamodel model, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out) |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <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="strong">Parameters:</span></dt><dd><code>objs</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><dd><code>writer</code> - a text-oriented output stream</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/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="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><a href="../../../../../org/apache/openjpa/persistence/jest/ObjectFormatter.html" title="type parameter in ObjectFormatter">T</a> writeOut(javax.persistence.metamodel.Metamodel model, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> desc, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out) |
| throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Encodes the given domain model, then write it into the given output stream.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>model</code> - a meta-model of managed types</dd><dd><code>writer</code> - a text-oriented output stream</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ObjectFormatter.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/MetamodelHelper.AttributeComparator.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/persistence/jest/ProcessingException.html" title="class in org.apache.openjpa.persistence.jest"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/persistence/jest/ObjectFormatter.html" target="_top">Frames</a></li> |
| <li><a href="ObjectFormatter.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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 © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |