| <!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_112) on Mon Oct 14 11:36:12 MSK 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ExtendedType (cayenne-doc: Cayenne Documentation 4.0.2 API)</title> |
| <meta name="date" content="2019-10-14"> |
| <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="ExtendedType (cayenne-doc: Cayenne Documentation 4.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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="class-use/ExtendedType.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/cayenne/access/types/ExtendedEnumType.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/access/types/ExtendedType.html" target="_top">Frames</a></li> |
| <li><a href="ExtendedType.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.cayenne.access.types</div> |
| <h2 title="Interface ExtendedType" class="title">Interface ExtendedType<T></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/apache/cayenne/access/types/BigDecimalType.html" title="class in org.apache.cayenne.access.types">BigDecimalType</a>, <a href="../../../../../org/apache/cayenne/access/types/BooleanType.html" title="class in org.apache.cayenne.access.types">BooleanType</a>, <a href="../../../../../org/apache/cayenne/access/types/ByteArrayType.html" title="class in org.apache.cayenne.access.types">ByteArrayType</a>, <a href="../../../../../org/apache/cayenne/access/types/ByteType.html" title="class in org.apache.cayenne.access.types">ByteType</a>, <a href="../../../../../org/apache/cayenne/access/types/CalendarType.html" title="class in org.apache.cayenne.access.types">CalendarType</a>, <a href="../../../../../org/apache/cayenne/access/types/CharType.html" title="class in org.apache.cayenne.access.types">CharType</a>, <a href="../../../../../org/apache/cayenne/access/types/DateType.html" title="class in org.apache.cayenne.access.types">DateType</a>, <a href="../../../../../org/apache/cayenne/access/types/DoubleType.html" title="class in org.apache.cayenne.access.types">DoubleType</a>, <a href="../../../../../org/apache/cayenne/access/types/EnumType.html" title="class in org.apache.cayenne.access.types">EnumType</a>, <a href="../../../../../org/apache/cayenne/access/types/ExtendedEnumType.html" title="class in org.apache.cayenne.access.types">ExtendedEnumType</a>, <a href="../../../../../org/apache/cayenne/access/types/FloatType.html" title="class in org.apache.cayenne.access.types">FloatType</a>, <a href="../../../../../org/apache/cayenne/dba/ingres/IngresBooleanType.html" title="class in org.apache.cayenne.dba.ingres">IngresBooleanType</a>, <a href="../../../../../org/apache/cayenne/access/types/IntegerType.html" title="class in org.apache.cayenne.access.types">IntegerType</a>, <a href="../../../../../org/apache/cayenne/access/types/LongType.html" title="class in org.apache.cayenne.access.types">LongType</a>, <a href="../../../../../org/apache/cayenne/access/types/ObjectType.html" title="class in org.apache.cayenne.access.types">ObjectType</a>, <a href="../../../../../org/apache/cayenne/dba/oracle/OracleByteArrayType.html" title="class in org.apache.cayenne.dba.oracle">OracleByteArrayType</a>, <a href="../../../../../org/apache/cayenne/dba/oracle/OracleCharType.html" title="class in org.apache.cayenne.dba.oracle">OracleCharType</a>, <a href="../../../../../org/apache/cayenne/dba/oracle/OracleUtilDateType.html" title="class in org.apache.cayenne.dba.oracle">OracleUtilDateType</a>, <a href="../../../../../org/apache/cayenne/access/types/ShortType.html" title="class in org.apache.cayenne.access.types">ShortType</a>, <a href="../../../../../org/apache/cayenne/access/types/TimestampType.html" title="class in org.apache.cayenne.access.types">TimestampType</a>, <a href="../../../../../org/apache/cayenne/access/types/TimeType.html" title="class in org.apache.cayenne.access.types">TimeType</a>, <a href="../../../../../org/apache/cayenne/access/types/UtilDateType.html" title="class in org.apache.cayenne.access.types">UtilDateType</a>, <a href="../../../../../org/apache/cayenne/access/types/VoidType.html" title="class in org.apache.cayenne.access.types">VoidType</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ExtendedType<T></span></pre> |
| <div class="block">Defines methods to read Java objects from JDBC ResultSets and write as parameters of PreparedStatements.</div> |
| </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="memberSummary" 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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html#TRIM_VALUES_THRESHOLD">TRIM_VALUES_THRESHOLD</a></span></code> |
| <div class="block">Defines trimming constant for toString method that helps to limit logging of large values.</div> |
| </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="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="https://docs.oracle.com/javase/7/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/cayenne/access/types/ExtendedType.html#getClassName--">getClassName</a></span>()</code> |
| <div class="block">Returns a full name of Java class that this ExtendedType supports.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html#materializeObject-java.sql.CallableStatement-int-int-">materializeObject</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/CallableStatement.html?is-external=true" title="class or interface in java.sql">CallableStatement</a> rs, |
| int index, |
| int type)</code> |
| <div class="block">Reads an object from a stored procedure OUT parameter, converting it to class |
| returned by 'getClassName' method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html#materializeObject-java.sql.ResultSet-int-int-">materializeObject</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| int index, |
| int type)</code> |
| <div class="block">Reads an object from JDBC ResultSet column, converting it to class returned by |
| 'getClassName' method.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html#setJdbcObject-java.sql.PreparedStatement-T-int-int-int-">setJdbcObject</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a> statement, |
| <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> value, |
| int pos, |
| int type, |
| int scale)</code> |
| <div class="block">Initializes a single parameter of a PreparedStatement with object value.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/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/cayenne/access/types/ExtendedType.html#toString-T-">toString</a></span>(<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> value)</code> |
| <div class="block">Converts value of the supported type to a human-readable String representation.</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="TRIM_VALUES_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TRIM_VALUES_THRESHOLD</h4> |
| <pre>static final int TRIM_VALUES_THRESHOLD</pre> |
| <div class="block">Defines trimming constant for toString method that helps to limit logging of large values.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.cayenne.access.types.ExtendedType.TRIM_VALUES_THRESHOLD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassName</h4> |
| <pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClassName()</pre> |
| <div class="block">Returns a full name of Java class that this ExtendedType supports.</div> |
| </li> |
| </ul> |
| <a name="setJdbcObject-java.sql.PreparedStatement-java.lang.Object-int-int-int-"> |
| <!-- --> |
| </a><a name="setJdbcObject-java.sql.PreparedStatement-T-int-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJdbcObject</h4> |
| <pre>void setJdbcObject(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/PreparedStatement.html?is-external=true" title="class or interface in java.sql">PreparedStatement</a> statement, |
| <a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> value, |
| int pos, |
| int type, |
| int scale) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Initializes a single parameter of a PreparedStatement with object value.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="materializeObject-java.sql.ResultSet-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>materializeObject</h4> |
| <pre><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> materializeObject(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> rs, |
| int index, |
| int type) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Reads an object from JDBC ResultSet column, converting it to class returned by |
| 'getClassName' method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if read error occurred, or an object can't be converted to a |
| target Java class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="materializeObject-java.sql.CallableStatement-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>materializeObject</h4> |
| <pre><a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> materializeObject(<a href="https://docs.oracle.com/javase/7/docs/api/java/sql/CallableStatement.html?is-external=true" title="class or interface in java.sql">CallableStatement</a> rs, |
| int index, |
| int type) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Reads an object from a stored procedure OUT parameter, converting it to class |
| returned by 'getClassName' method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if read error occurred, or an object can't be converted to a |
| target Java class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-java.lang.Object-"> |
| <!-- --> |
| </a><a name="toString-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(<a href="../../../../../org/apache/cayenne/access/types/ExtendedType.html" title="type parameter in ExtendedType">T</a> value)</pre> |
| <div class="block">Converts value of the supported type to a human-readable String representation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a value to convert to String.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</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/ExtendedType.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/cayenne/access/types/ExtendedEnumType.html" title="class in org.apache.cayenne.access.types"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/cayenne/access/types/ExtendedTypeFactory.html" title="interface in org.apache.cayenne.access.types"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/cayenne/access/types/ExtendedType.html" target="_top">Frames</a></li> |
| <li><a href="ExtendedType.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 © 2001–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
