Uses of Interface
st.orm.Navigable

Packages that use Navigable

Package	Description
st.orm	Foundation of the data model: the mapping annotations and the record interfaces.
st.orm.template	Java client API: templates, query builders and transactions.
st.orm.template.impl	Java client API implementation.

Uses of Navigable in st.orm

Subinterfaces of Navigable in st.orm

Modifier and Type	Interface	Description
interface	Metamodel<T extends Data,E>	The metamodel provides type-safe references to entity fields for use in queries.
static interface	Metamodel.Key<T extends Data,E>	Marker interface for metamodel fields that correspond to columns known to be unique.
interface	TypedMetamodel<T extends Data,E,V extends @Nullable Object>	A Metamodel that also carries the declared component type of the field it represents.

Classes in st.orm that implement Navigable

Modifier and Type	Class	Description
class	AbstractKeyMetamodel<T extends Data,E,V extends @Nullable Object>	Extension of AbstractMetamodel that implements Metamodel.Key, indicating that the field has a uniqueness constraint.
class	AbstractMetamodel<T extends Data,E,V extends @Nullable Object>	Implementation that is used by the generated models.
class	AbstractNavigableMetamodel<T extends Data,E>	Base implementation for generated navigation-only metamodels — nodes that navigate the entity graph beyond a Ref foreign key.
static final record	Metamodel.KeyDelegate<T extends Data,E>	Delegating wrapper that adds the Metamodel.Key marker to an existing Metamodel instance.
static final record	Metamodel.Outer<T extends Data,E>	A path named in the query that encloses the subquery it is used in, see Metamodel.outer(Navigable).
static final record	SqlFunction.Call<T extends Data,E>	The call of a function on a path.

Methods in st.orm that return Navigable

Modifier and Type	Method	Description
Navigable<T,? extends Data>	AbstractNavigableMetamodel.table()
Navigable<T,? extends Data>	Navigable.table()	Returns the navigable of the table that holds the column this navigable points to.

Methods in st.orm with parameters of type Navigable

Modifier and Type	Method	Description
static <T extends Data> Match<T>	Match.anywhere(Navigable<T,String> path)	Returns a match of a word anywhere in the value, the default of search.
static <T extends Data> Match<T>	Match.anywhere(Navigable<T,String> path, int minLength)	Returns a anywhere match that takes the words in its form once one reaches the given length, and the whole input as the start of the value, ignoring case, before: a longer length keeps a column whose matches rank low, such as one of a related table, in its fallback until a word is long enough to match few rows, and 0 takes every word in its form.
static <T extends Data> Match<T>	Match.exact(Navigable<T,String> path)	Returns a match of a word as the whole value, with the column bare and the word lowered, which an ordinary index over a column that compares case-insensitively serves.
static <T extends Data> Match<T>	Match.exact(Navigable<T,String> path, int minLength)	Returns a exact match that takes words of at least the given length.
static <T extends Data> Match<T>	Match.exactIgnoreCase(Navigable<T,String> path)	Returns a match of a word as the whole value, ignoring case: the column lowered as well as the word, on any column, which an index over LOWER(column) serves, the index of a match anywhere or at a word start included.
static <T extends Data> Match<T>	Match.exactIgnoreCase(Navigable<T,String> path, int minLength)	Returns a exactIgnoreCase match that takes words of at least the given length.
static boolean	Metamodel.isOuter(Navigable<?,?> path)	Returns whether the path names a column of an enclosing query: a path made by Metamodel.outer(Navigable), a SqlFunction call on one, or a key view of one.
static <T extends Data, E> Metamodel<T,E>	Metamodel.outer(Navigable<T,E> path)	Names the column at the given path in the query that encloses the subquery being built, as the other side of a comparison of two columns: where(Visit_.pet.id, EQUALS, outer(Pet_.id)) keeps the visits of the enclosing query's pet.
static <T extends Data> Match<T>	Match.prefix(Navigable<T,String> path)	Returns a match of a word as a prefix of the value, with the column bare and the word lowered, which an ordinary index over a column that compares case-insensitively serves.
static <T extends Data> Match<T>	Match.prefix(Navigable<T,String> path, int minLength)	Returns a prefix match that takes words of at least the given length.
static <T extends Data> Match<T>	Match.prefixIgnoreCase(Navigable<T,String> path)	Returns a match of a word as a prefix of the value, ignoring case: the column lowered as well as the word, on any column, which an index over LOWER(column) serves, the index of a match anywhere or at a word start included.
static <T extends Data> Match<T>	Match.prefixIgnoreCase(Navigable<T,String> path, int minLength)	Returns a prefixIgnoreCase match that takes words of at least the given length.
static <T extends Data> Match<T>	Match.wordStart(Navigable<T,String> path)	Returns a match of a word at the start of any word in the value, the default of suggest: the value's start, or the text after a space or a punctuation character that joins or separates words.
static <T extends Data> Match<T>	Match.wordStart(Navigable<T,String> path, int minLength)	Returns a wordStart match that takes the words in its form once one reaches the given length, and the whole input as the start of the value, ignoring case, before: a longer length keeps a column whose matches rank low, such as one of a related table, in its fallback until a word is long enough to match few rows, and 0 takes every word in its form.

Method parameters in st.orm with type arguments of type Navigable

Modifier and Type	Method	Description
default Match<T>	Match.withFallback(BiFunction<? super Navigable<T,String>,Integer,? extends Match<T>> form)	Returns this match with a fallback in another form on the same column, such as wordStart(Owner_.lastName).withFallback(Match::wordStart), which matches a short input at every word start.

Constructors in st.orm with parameters of type Navigable

Modifier	Constructor	Description
	AbstractNavigableMetamodel(Class<E> fieldType, String path, String field, boolean inline, @Nullable Navigable<T,?> parent)
protected	AbstractNavigableMetamodel(Class<E> fieldType, String path, String field, boolean inline, @Nullable Navigable<T,?> parent, boolean isColumn)

Uses of Navigable in st.orm.template

Methods in st.orm.template with parameters of type Navigable

Modifier and Type	Method	Description
final QueryBuilder<T,R,ID>	QueryBuilder.fetch(Navigable<T,? extends Data> path, Navigable<T,? extends Data>... more)	Resolves the references at the specified paths as part of this query.
final QueryBuilder<T,R,ID>	QueryBuilder.groupBy(Navigable<? extends T,?> path, Navigable<? extends T,?>... more)	Adds a GROUP BY clause to the query for field at the specified path in the table graph.
final <V> QueryBuilder<T,R,ID>	QueryBuilder.having(Navigable<? extends T,V> path, Operator operator, Navigable<?,V> other)	Adds a HAVING clause that compares the column at the specified path with the column at another path of the query.
final <V> QueryBuilder<T,R,ID>	QueryBuilder.having(Navigable<? extends T,V> path, Operator operator, V... o)	Adds a HAVING clause to the query using the specified expression.
final QueryBuilder<T,R,ID>	QueryBuilder.orderBy(Navigable<? extends T,?> path, Navigable<? extends T,?>... more)	Adds an ORDER BY clause to the query for the field at the specified path in the table graph.
final QueryBuilder<T,R,ID>	QueryBuilder.orderByDescending(Navigable<? extends T,?> path, Navigable<? extends T,?>... more)	Adds an ORDER BY clause to the query for the fields at the specified paths in the table graph.
final PredicateBuilder<T,R,ID>	WhereBuilder.search(String input, Set<String> ignore, Navigable<? extends T,String> path, Navigable<? extends T,String>... more)	Matches the words of a search input against one or more text columns, as WhereBuilder.search(String, Navigable, Navigable[]) does, ignoring the given words as well.
final PredicateBuilder<T,R,ID>	WhereBuilder.search(String input, Navigable<? extends T,String> path, Navigable<? extends T,String>... more)	Matches the words of a search input against one or more text columns.
final PredicateBuilder<T,R,ID>	WhereBuilder.suggest(String input, Set<String> ignore, Navigable<? extends T,String> path, Navigable<? extends T,String>... more)	Matches the words of a search box that queries as the user types against one or more text columns, as WhereBuilder.suggest(String, Navigable, Navigable[]) does, ignoring the given words as well.
final PredicateBuilder<T,R,ID>	WhereBuilder.suggest(String input, Navigable<? extends T,String> path, Navigable<? extends T,String>... more)	Matches the words of a search box that queries as the user types, such as an auto-complete, against one or more text columns.
final <V extends Data> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, Iterable<V> it)	Adds a WHERE clause that matches the specified records.
final <V> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, Operator operator, Iterable<? extends V> it)	Adds a WHERE clause that matches the specified objects at the specified path in the table graph.
final <V> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, Operator operator, Navigable<?,V> other)	Adds a WHERE clause that compares the column at the specified path with the column at another path of the query, such as a foreign key with a foreign key to the same table.
final <V> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, Operator operator, V... o)	Adds a WHERE clause that matches the specified objects at the specified path in the table graph.
final <V extends Data> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, Ref<V> ref)	Adds a WHERE clause that matches the specified ref.
final <V extends Data> QueryBuilder<T,R,ID>	QueryBuilder.where(Navigable<? extends T,V> path, V record)	Adds a WHERE clause that matches the specified record.
final <V extends Data> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, Iterable<V> it)	Adds a condition to the WHERE clause that matches the specified records.
abstract <V> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, Operator operator, Iterable<? extends V> it)	Adds a condition to the WHERE clause that matches the specified objects at the specified path in the table graph.
abstract <V> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, Operator operator, Navigable<?,V> other)	Adds a condition to the WHERE clause that compares the column at the specified path with the column at another path of the query, such as a foreign key with a foreign key to the same table.
final <V> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, Operator operator, V... o)	Adds a condition to the WHERE clause that matches the specified objects at the specified path in the table graph.
abstract <V extends Data> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, Ref<V> ref)	Adds a condition to the WHERE clause that matches the specified ref.
final <V extends Data> PredicateBuilder<T,R,ID>	WhereBuilder.where(Navigable<? extends T,V> path, V record)	Adds a condition to the WHERE clause that matches the specified record.
final <V extends Data> QueryBuilder<T,R,ID>	QueryBuilder.whereRef(Navigable<? extends T,V> path, Iterable<? extends Ref<V>> it)	Adds a WHERE clause that matches the specified records.
abstract <V extends Data> PredicateBuilder<T,R,ID>	WhereBuilder.whereRef(Navigable<? extends T,V> path, Iterable<? extends Ref<V>> it)	Adds a condition to the WHERE clause that matches the specified refs.

Method parameters in st.orm.template with type arguments of type Navigable

Modifier and Type	Method	Description
abstract QueryBuilder<T,R,ID>	QueryBuilder.fetch(List<? extends Navigable<T,? extends Data>> paths)	Resolves the references at the specified paths as part of this query.

Uses of Navigable in st.orm.template.impl

Method parameters in st.orm.template.impl with type arguments of type Navigable

Modifier and Type	Method	Description
QueryBuilder<T,R,ID>	QueryBuilderImpl.fetch(List<? extends Navigable<T,? extends Data>> paths)	Resolves the references at the specified paths as part of this query.