| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Autocomplete Annotations :: causeway</title> |
| <link rel="canonical" href="https://causeway.apache.org/querydsl/latest/autocomplete-annotations.html"> |
| <meta name="generator" content="Antora 3.1.14"> |
| <link rel="stylesheet" href="../../_/css/site.css"> |
| <link rel="stylesheet" href="../../_/css/site-custom.css"> |
| <link rel="home" href="https://causeway.apache.org" title="causeway"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://causeway.apache.org"> |
| <span class="icon"> |
| <img src="../../_/img/causeway-logo-no-words-65x48.png"></img> |
| </span> |
| <span class="navbar-title">causeway</span> |
| </a> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <a class="navbar-end"> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Quick Start</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Starter Apps</span> |
| <a class="navbar-item" href="../../docs/latest/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../docs/latest/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Learning & Tutorials</span> |
| <a class="navbar-item" href="../../docs/latest/reference/about.html">Reference App</a> |
| <a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Resources</span> |
| <a class="navbar-item" href="../../docs/latest/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../docs/latest/resources/icons.html">Icons</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Guides</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/about.html">User Guide</a> |
| <a class="navbar-item" href="../../refguide/latest/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../testing/latest/about.html">Testing Guide</a> |
| <a class="navbar-item" href="../../security/latest/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">For use in apps</span> |
| <a class="navbar-item" href="../../valuetypes/latest/about.html">Value Types</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../setupguide/latest/about.html">Setup Guide</a> |
| <a class="navbar-item" href="../../conguide/latest/about.html">Contributors' Guide</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Components</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/bypass/about.html">Bypass</a> |
| <a class="navbar-item" href="../../security/latest/simple/about.html">Simple</a> |
| <a class="navbar-item" href="../../security/latest/spring/about.html">Spring</a> |
| <a class="navbar-item" href="../../security/latest/keycloak/about.html">Keycloak</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Viewers</span> |
| <a class="navbar-item" href="../../vw/latest/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../gqlv/latest/about.html">GraphQL API</a> |
| <a class="navbar-item" href="../../vro/latest/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../pjpa/latest/about.html">JPA (EclipseLink)</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Extensions</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../userguide/latest/commandlog/about.html">Command Log</a> |
| <a class="navbar-item" href="../../userguide/latest/docgen/about.html">Doc Gen</a> |
| <a class="navbar-item" href="../../userguide/latest/executionlog/about.html">Execution Log</a> |
| <a class="navbar-item" href="../../userguide/latest/executionoutbox/about.html">Execution Outbox</a> |
| <a class="navbar-item" href="../../userguide/latest/executionrepublisher/about.html">Execution Republisher</a> |
| <a class="navbar-item" href="../../userguide/latest/excel/about.html">Excel</a> |
| <a class="navbar-item" href="../../userguide/latest/flyway/about.html">Flyway</a> |
| <a class="navbar-item" href="../../userguide/latest/layoutloaders/about.html">Layout Loaders</a> |
| <a class="navbar-item" href="../../userguide/latest/titlecache/about.html">Title Cache</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../security/latest/secman/about.html">Secman</a> |
| <a class="navbar-item" href="../../security/latest/audittrail/about.html">Audit Trail</a> |
| <a class="navbar-item" href="../../security/latest/spring-oauth2/about.html">Spring OAuth2 Integration</a> |
| <a class="navbar-item" href="../../security/latest/sessionlog/about.html">Session Log</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Web UI (Wicket)</span> |
| <a class="navbar-item" href="../../vw/latest/fullcalendar/about.html">Full Calendar</a> |
| <a class="navbar-item" href="../../vw/latest/pdfjs/about.html">pdf.js</a> |
| <a class="navbar-item" href="../../vw/latest/sse/about.html">Server Side Events</a> |
| <a class="navbar-item" href="../../vw/latest/tabular/about.html">Tabular Download</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">REST API (Restful Objects)</span> |
| <a class="navbar-item" href="../../vro/latest/cors/about.html">CORS</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../querydsl/latest/about.html">QueryDSL</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Support</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Contact</span> |
| <a class="navbar-item" href="../../docs/latest/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../docs/latest/support/mailing-list.html">Mailing Lists</a> |
| <a class="navbar-item" href="https://issues.apache.org/jira/browse/CAUSEWAY">JIRA</a> |
| <a class="navbar-item" href="https://stackoverflow.com/questions/tagged/causeway">Stack Overflow</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Releases</span> |
| <a class="navbar-item" href="../../docs/latest/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../relnotes/latest/about.html">Release Notes</a> |
| <hr class="navbar-divider"/> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Framework</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Process</span> |
| <a class="navbar-item" href="../../comguide/latest/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../tooling/latest/about.html">Tooling</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Automated Analysis</span> |
| <a class="navbar-item" href="https://sonarcloud.io/dashboard?id=apache_causeway">SonarCloud.io</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Interim Builds</span> |
| <a class="navbar-item" href="../../comguide/latest/nightly-builds.html">Nightly builds</a> |
| <a class="navbar-item" href="../../comguide/latest/weekly-builds.html">Weekly builds</a> |
| <a class="navbar-item" href="https://apache-causeway-committers.github.io/causeway-nightly">Website Preview (not ASF hosted)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../core/latest/about.html">Internal Design Docs</a> |
| <a class="navbar-item" href="../../regressiontests/latest/about.html">Regression Tests</a> |
| <a class="navbar-item" href="../../incubator/latest/about.html">Incubator</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Thanks</span> |
| <a class="navbar-item" href="../../more-thanks/latest/more-thanks.html">Acknowledgements</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">ASF</a> |
| <div class="navbar-dropdown"> |
| <a class="navbar-item" href="http://www.apache.org/">Apache Homepage</a> |
| <a class="navbar-item" href="https://www.apache.org/events/current-event">Events</a> |
| <a class="navbar-item" href="https://www.apache.org/licenses/">License</a> |
| <a class="navbar-item" href="https://www.apache.org/security/">Security</a> |
| <a class="navbar-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| <hr class="navbar-divider"/> |
| <a class="navbar-item" href="https://whimsy.apache.org/board/minutes/Causeway.html">PMC board minutes</a> |
| </div> |
| </div> |
| <a class="navbar-item" href="../../docs/latest/about.html"> |
| <span class="icon"> |
| <img src="../../_/img/home.png"></img> |
| </span> |
| </a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body "> |
| <div class="nav-container" data-component="querydsl" data-version="3.4.0"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-search hide-for-print"> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </div> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous disabled" rel="prev" href="" title=""><span></span></a> |
| <a class="page-next disabled" rel="next" |
| href="" title=""><span></span></a> |
| <!-- |
| page.parent doesn't seem to be set... |
| <a class="page-parent disabled" rel="prev" href="" title=""><span></span></a> |
| --> |
| </div> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="about.html">QueryDSL</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/setup-and-configuration.html">Setup and Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/example-queries.html">Example Queries</a> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <a class="nav-link" href="../latest/autocomplete-annotations.html">Autocomplete Annotations</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">QueryDSL</span> |
| <span class="version">3.4.0</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../docs/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../docs/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../comguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../comguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../conguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../conguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../core/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../core/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../extensions/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../extensions/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">GraphQL Viewer</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../gqlv/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../gqlv/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../incubator/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../incubator/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../pjdo/latest/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjdo/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../pjpa/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../pjpa/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">QueryDSL</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version is-current"> |
| <a href="about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../3.2.0/about.html">3.2.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../refguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../refguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">regressiontests</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../regressiontests/latest/index.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.5.0/index.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.4.0/index.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.3.0/index.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.2.0/index.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.1.0/index.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/3.0.0/index.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/2.1.0/index.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../regressiontests/2.0.0/index.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../relnotes/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../relnotes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vro/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vro/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../security/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../security/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../setupguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../setupguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../testing/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../testing/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tutorials</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../tutorials/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../tutorials/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../userguide/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../userguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Value Types Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../valuetypes/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../valuetypes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../vw/latest/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../vw/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main role="main"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../docs/latest/about.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="about.html">QueryDSL</a></li> |
| <li><a href="autocomplete-annotations.html">Autocomplete Annotations</a></li> |
| </ul> |
| </nav> |
| <div class="page-versions"> |
| <button class="version-menu-toggle" title="Show other versions of page">3.4.0</button> |
| <div class="version-menu"> |
| <a class="version" href="../latest/autocomplete-annotations.html">4.0.0-M1</a> |
| <a class="version" href="../3.5.0/autocomplete-annotations.html">3.5.0</a> |
| <a class="version is-current" href="autocomplete-annotations.html">3.4.0</a> |
| <a class="version" href="../3.3.0/autocomplete-annotations.html">3.3.0</a> |
| <a class="version" href="../3.2.0/autocomplete-annotations.html">3.2.0</a> |
| </div> |
| </div> |
| <div class="edit-this-page"><a href="https://github.com/apache/causeway/edit/3.4.0/persistence/querydsl/adoc/modules/ROOT/pages/autocomplete-annotations.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">Autocomplete Annotations</h1> |
| <div class="paragraph"> |
| <p>Actions that accept an entity as a parameter provide a mechanism for finding the entity; either a bounded set of choices, or an autocomplete (enter a number of characters and then search for entities that match).</p> |
| </div> |
| <div class="paragraph"> |
| <p>The QueryDSL module provides a simplified way of providing an autocomplete for a given entity class. |
| For each of the properties that should be used in the search, annotated using <a href="../../refguide/latest/applib/index/annotation/Property.html#queryDslAutoComplete" class="xref page">Property#queryDslAutoComplete()</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@Title |
| @Column(length = Name.MAX_LEN, nullable = false, name = "name") |
| @Getter @Setter @ToString.Include |
| @Property(queryDslAutoComplete = QueryDslAutoCompletePolicy.INCLUDE) <i class="conum" data-value="1"></i><b>(1)</b> |
| private String name;</code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>property is explicitly searched in any autocomplete query. |
| <div class="paragraph"> |
| <p>If multiple properties have been annotated, then the entered value needs to match any one of the properties (the query performed uses <code>OR</code>, not <code>AND</code>).</p> |
| </div></td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>The behaviour of the query can be modified in several ways, using various attributes of <a href="../../refguide/latest/applib/index/annotation/DomainObject.html#queryDslAutoCompleteAdditionalPredicateRepository" class="xref page">@DomainObject</a>):</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="../../refguide/latest/applib/index/annotation/DomainObject.html#queryDslAutoCompleteMinLength" class="xref page">@DomainObject#queryDslAutoCompleteMinLength</a>)</p> |
| <div class="paragraph"> |
| <p>Specifies the minimum number of characters to be entered before a search is performed; the default if not specified is 1 character.</p> |
| </div> |
| </li> |
| <li> |
| <p><a href="../../refguide/latest/applib/index/annotation/DomainObject.html#queryDslAutoCompleteLimitResults" class="xref page">@DomainObject#queryDslAutoCompleteLimitResults</a>),</p> |
| <div class="paragraph"> |
| <p>Specifies the maximum number of candidate entities returned in the drop down list; the default if not specified is 50.</p> |
| </div> |
| </li> |
| <li> |
| <p><a href="../../refguide/latest/applib/index/annotation/DomainObject.html#queryDslAutoCompleteAdditionalPredicateRepository" class="xref page">@DomainObject#queryDslAutoCompleteAdditionalPredicateRepository</a>)</p> |
| <div class="paragraph"> |
| <p>Specifies the repository class that contains a method (default name "queryDslAutoCompleteAdditionalPredicates") which returns a predicate that is applied to every auto-complete query.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This can be used for example to restrict the query so that each user is only prompted with entities that they have access to.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default name of the method can be overridden (see below).</p> |
| </div> |
| </li> |
| <li> |
| <p><a href="../../refguide/latest/applib/index/annotation/DomainObject.html#queryDslAutoCompleteAdditionalPredicateMethod" class="xref page">@DomainObject#queryDslAutoCompleteAdditionalPredicateMethod</a>)</p> |
| <div class="paragraph"> |
| <p>If an additional predicate repository has been defined, this method allows the name of the method returning the additional predicate to be overridden from its default name.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For example, suppose (for some strange reason) that we want to limit the selection only to objects where their <code>attachment</code> property is not populated:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>specify the additional predicate repository/method:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@DomainObject( |
| queryDslAutoCompleteMinLength = 3, |
| queryDslAutoCompleteLimitResults = 30, |
| queryDslAutoCompleteAdditionalPredicateRepository = SimpleObjectRepository.class, |
| queryDslAutoCompleteAdditionalPredicateMethod = "autoFilter" |
| ) |
| public class SimpleObject implements Comparable<SimpleObject> { /*...*/ }</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>implement the predicate method with the correct signature:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">import com.querydsl.core.types.Predicate; |
| import com.querydsl.core.types.dsl.PathBuilder; |
| |
| @Service |
| public class SimpleObjectRepository extends QueryDslRepository<SimpleObject, QSimpleObject> { |
| |
| //... |
| |
| public Function<PathBuilder<SimpleObject>, Predicate> autoFilter( |
| String search |
| ) { |
| return so -> so.getString("attachment").isNull(); <i class="conum" data-value="1"></i><b>(1)</b> |
| } |
| |
| //... |
| }</code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>In this (silly) example, the auto complete will only propose objects that meet the additional criteria (in this case, that the <code>SimpleObject#attachment</code> property is null).</td> |
| </tr> |
| </table> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>As a more realistic example, this filter excludes any agreements that are no longer current:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public Function<PathBuilder<Agreement>, Predicate> autoFilter( |
| final String searchPhrase |
| ) { |
| return a -> a.getDate("endDate", LocalDate.class).isNull() |
| .or(a.getDate("endDate", LocalDate.class).goe(clockService.nowAsLocalDate())); |
| }</code></pre> |
| </div> |
| </div> |
| </article> |
| <aside class="article-aside toc hide-for-print" role="navigation"> |
| <p class="toc-title">On this page</p> |
| <div id="article-toc"></div> |
| </aside> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div class="content"> |
| <div class="copyright"> |
| <p> |
| Copyright © 2010~2024 The Apache Software Foundation, licensed under the Apache License, v2.0. |
| <br/> |
| Apache, the Apache feather logo, Apache Causeway, and the Apache Causeway project logo are all trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| <div class="revision"> |
| <p>Revision: build-website.20251118-0002</p> |
| </div> |
| </div> |
| </footer> |
| <script src="../../_/js/site.js"></script> |
| <script async src="../../_/js/vendor/highlight.js"></script> |
| <script src="../../_/js/vendor/jquery-3.4.1.min.js"></script> |
| <script src="../../_/js/vendor/jquery-ui-1.12.1.custom.widget-only.min.js"></script> |
| <script src="../../_/js/vendor/jquery.tocify.min.js"></script> |
| |
| <script> |
| $(function() { |
| $("#article-toc").tocify( { |
| showEffect: "slideDown", |
| hashGenerator: "pretty", |
| hideEffect: "slideUp", |
| selectors: "h2, h3", |
| scrollTo: 120, |
| smoothScroll: true, |
| theme: "jqueryui", |
| highlightOnScroll: true |
| } ); |
| }); |
| </script> |
| |
| <script src="../../_/js/vendor/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'causeway-apache-org', |
| inputSelector: '#algolia-search-input', |
| autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] }, |
| debug: false, |
| }).autocomplete |
| search.on('autocomplete:closed', function () { search.autocomplete.setVal() }) |
| focusSearchInput() |
| window.addEventListener('load', focusSearchInput); |
| </script> |
| |
| <!-- |
| docsearch options: |
| https://docsearch.algolia.com/docs/behavior/ |
| --> |
| <!-- |
| https://www.algolia.com/doc/api-reference/api-parameters/ |
| algoliaOptions: { hitsPerPage: 6 }, |
| --> |
| </body> |
| </html> |