| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>org.apache.cayenne.exp.property (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-12-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.cayenne.exp.property (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.cayenne.exp.property</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block"><h3>Property API</h3> |
| <p> |
| This API allows to use type aware <a href="../Expression.html" title="class in org.apache.cayenne.exp"><code>expression</code></a> factories aka Properties.<br> |
| These properties are normally generated as static constants in model classes, but they can also be created manually by |
| <a href="PropertyFactory.html" title="class in org.apache.cayenne.exp.property"><code>PropertyFactory</code></a> if needed. |
| <p> |
| Typical usage in select queries: |
| <pre><code> |
| Painting painting = ... |
| Artist artist = ObjectSelect.query(Artist.class) |
| .where(Artist.PAINTING_ARRAY.contains(painting)) |
| .and(Artist.DATE_OF_BIRTH.year().gt(1950)) |
| .and(Artist.ARTIST_NAME.like("Pablo%")) |
| .orderBy(Artist.ARTIST_NAME.asc()) |
| .prefetch(Artist.PAINTING_ARRAY.disjointById()) |
| .selectOne(context); |
| </code></pre> |
| <p> |
| Currently supported Property types: |
| <ul> |
| <li><a href="NumericProperty.html" title="class in org.apache.cayenne.exp.property"><code>NumericProperty</code></a> for all data types inherited from <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Number</code></a>.<br> |
| Supports comparison and math functions (like <a href="NumericProperty.html#sqrt()"><code>sqrt()</code></a>). |
| <br> |
| <li><a href="StringProperty.html" title="class in org.apache.cayenne.exp.property"><code>StringProperty</code></a> for all data types inherited from <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>CharSequence</code></a>.<br> |
| Supports multiple string functions (<a href="StringProperty.html#like(java.lang.String)"><code>like()</code></a>, |
| <a href="StringProperty.html#concat(java.lang.Object...)"><code>concat()</code></a>, etc.) |
| <br> |
| <li><a href="DateProperty.html" title="class in org.apache.cayenne.exp.property"><code>DateProperty</code></a> for <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Date</code></a> (and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html?is-external=true" class="externalLink"><code>java.sql</code></a> variants) |
| and <a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html?is-external=true" title="class or interface in java.time" class="externalLink"><code>LocalDate</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html?is-external=true" title="class or interface in java.time" class="externalLink"><code>LocalTime</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html?is-external=true" title="class or interface in java.time" class="externalLink"><code>LocalDateTime</code></a>.<br> |
| Supports date functions like <a href="DateProperty.html#year()"><code>year()</code></a>. |
| <br> |
| <li><a href="EntityProperty.html" title="class in org.apache.cayenne.exp.property"><code>EntityProperty</code></a> for to-one relationships.<br> |
| Supports prefetch related methods, <a href="PathProperty.html#dot(org.apache.cayenne.exp.property.BaseProperty)"><code>dot()</code></a> methods, etc. |
| <br> |
| <li><a href="ListProperty.html" title="class in org.apache.cayenne.exp.property"><code>ListProperty</code></a>, <a href="SetProperty.html" title="class in org.apache.cayenne.exp.property"><code>SetProperty</code></a> |
| and <a href="MapProperty.html" title="class in org.apache.cayenne.exp.property"><code>MapProperty</code></a> are for to-many relationships.<br> |
| In addition to to-one related methods these properties support collection comparison methods |
| like <a href="CollectionProperty.html#contains(V)"><code>contains()</code></a>. |
| <br> |
| <li><a href="EmbeddableProperty.html" title="class in org.apache.cayenne.exp.property"><code>EmbeddableProperty</code></a> for embeddable objects |
| <br> |
| <li><a href="NumericIdProperty.html" title="class in org.apache.cayenne.exp.property"><code>NumericIdProperty</code></a> for numeric PK properties |
| <br> |
| <li><a href="BaseIdProperty.html" title="class in org.apache.cayenne.exp.property"><code>BaseIdProperty</code></a> for non-numeric PK properties |
| <br> |
| <li><a href="BaseProperty.html" title="class in org.apache.cayenne.exp.property"><code>BaseProperty</code></a> for all other data types, supports basic operations (equality, sorting). |
| </ul></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.2</dd> |
| </dl> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ComparableProperty.html" title="interface in org.apache.cayenne.exp.property">ComparableProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Interface (or "Trait") that provides basic functionality for comparable properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IdProperty.html" title="interface in org.apache.cayenne.exp.property">IdProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Base class for properties mapped to PK</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PathProperty.html" title="interface in org.apache.cayenne.exp.property">PathProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Property that represents path segment (relationship or embeddable).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Property.html" title="interface in org.apache.cayenne.exp.property">Property</a><E></th> |
| <td class="colLast"> |
| <div class="block">Base interface for all types of properties</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RelationshipProperty.html" title="interface in org.apache.cayenne.exp.property">RelationshipProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Interface (or "Trait") that provides basic functionality for all types of relationships.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="BaseIdProperty.html" title="class in org.apache.cayenne.exp.property">BaseIdProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Property that represents non-numeric PK</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="BaseProperty.html" title="class in org.apache.cayenne.exp.property">BaseProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Property that represents generic attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CollectionProperty.html" title="class in org.apache.cayenne.exp.property">CollectionProperty</a><V extends <a href="../../Persistent.html" title="interface in org.apache.cayenne">Persistent</a>,​E extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><V>></th> |
| <td class="colLast"> |
| <div class="block">Base class for <a href="ListProperty.html" title="class in org.apache.cayenne.exp.property"><code>ListProperty</code></a> and <a href="SetProperty.html" title="class in org.apache.cayenne.exp.property"><code>SetProperty</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DateProperty.html" title="class in org.apache.cayenne.exp.property">DateProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Property that represents date/time attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EmbeddableProperty.html" title="class in org.apache.cayenne.exp.property">EmbeddableProperty</a><E></th> |
| <td class="colLast"> |
| <div class="block">Property that represents object attribute mapped on <a href="../../map/Embeddable.html" title="class in org.apache.cayenne.map"><code>Embeddable</code></a> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EntityProperty.html" title="class in org.apache.cayenne.exp.property">EntityProperty</a><E extends <a href="../../Persistent.html" title="interface in org.apache.cayenne">Persistent</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents to-one relationships.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ListProperty.html" title="class in org.apache.cayenne.exp.property">ListProperty</a><V extends <a href="../../Persistent.html" title="interface in org.apache.cayenne">Persistent</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents to-many relationship mapped on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MapProperty.html" title="class in org.apache.cayenne.exp.property">MapProperty</a><K,​V extends <a href="../../Persistent.html" title="interface in org.apache.cayenne">Persistent</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents to-many relationship mapped on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NumericIdProperty.html" title="class in org.apache.cayenne.exp.property">NumericIdProperty</a><E extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents numeric PK</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NumericProperty.html" title="class in org.apache.cayenne.exp.property">NumericProperty</a><E extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang" class="externalLink">Number</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents attributes mapped on numeric types</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PropertyFactory.html" title="class in org.apache.cayenne.exp.property">PropertyFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory class that produces all property types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SetProperty.html" title="class in org.apache.cayenne.exp.property">SetProperty</a><V extends <a href="../../Persistent.html" title="interface in org.apache.cayenne">Persistent</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents to-many relationship mapped on <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="StringProperty.html" title="class in org.apache.cayenne.exp.property">StringProperty</a><E extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang" class="externalLink">CharSequence</a>></th> |
| <td class="colLast"> |
| <div class="block">Property that represents attributes mapped on string types</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
