Uses of Interface
st.orm.Match

Packages that use Match
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.

  • Uses of Match in st.orm

    Classes in st.orm that implement Match
    Modifier and Type
    Class
    Description
    static final record 
    Match.Anywhere<T extends Data>
    A word matches anywhere in the value: LOWER(column) LIKE LOWER('%word%').
    static final record 
    Match.Exact<T extends Data>
    A word matches the whole value.
    static final record 
    Match.Prefix<T extends Data>
    A word matches at the start of the value.
    static final record 
    Match.WordStart<T extends Data>
    A word matches at the start of any word in the value: the value's start, or the text after a space or one of the punctuation characters that join or separate the words of a name, a hyphen, an apostrophe, an opening parenthesis, a slash, a colon, a period or a comma, so marie matches "Anne-Marie" and brien "O'Brien".
    Methods in st.orm that return Match
    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.
    @Nullable Match<T>
    Match.Anywhere.fallback()
    Returns the value of the fallback record component.
    @Nullable Match<T>
    Match.Exact.fallback()
    Returns the value of the fallback record component.
    @Nullable Match<T>
    Match.fallback()
    Returns how the column matches the whole input, its words joined by one space, while no word reaches the match's minLength(), or null where the column then takes no part.
    @Nullable Match<T>
    Match.Prefix.fallback()
    Returns the value of the fallback record component.
    @Nullable Match<T>
    Match.WordStart.fallback()
    Returns the value of the fallback record component.
    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.
    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.
    default Match<T>
    Match.withFallback(Match<T> fallback)
    Returns this match with a fallback on any column of the row, such as a prefix match on a stored lowered column.
    default Match<T>
    Match.withoutFallback()
    Returns this match without a fallback: the column takes no part in the statement until a word reaches its minLength(), its related table and a semi-join declared for it included, so a column of a related table whose matches rank low is not read for a short input.
    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.
    Methods in st.orm with parameters of type Match
    Modifier and Type
    Method
    Description
    default Match<T>
    Match.withFallback(Match<T> fallback)
    Returns this match with a fallback on any column of the row, such as a prefix match on a stored lowered column.
    Method parameters in st.orm with type arguments of type Match
    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 Match
    Modifier
    Constructor
    Description
     
    Anywhere(Metamodel<T,String> path, int minLength, @Nullable Match<T> fallback)
    Creates an instance of a Anywhere record class.
     
    Exact(Metamodel<T,String> path, int minLength, boolean ignoreCase, @Nullable Match<T> fallback)
    Creates an instance of a Exact record class.
     
    Prefix(Metamodel<T,String> path, int minLength, boolean ignoreCase, @Nullable Match<T> fallback)
    Creates an instance of a Prefix record class.
     
    WordStart(Metamodel<T,String> path, int minLength, @Nullable Match<T> fallback)
    Creates an instance of a WordStart record class.

  • Uses of Match in st.orm.template

    Methods in st.orm.template with parameters of type Match
    Modifier and Type
    Method
    Description
    final PredicateBuilder<T,R,ID>
    WhereBuilder.search(String input, Set<String> ignore, Match<? extends T> field, Match<? extends T>... more)
    Matches the words of a search input against text columns, each in its stated match form, as WhereBuilder.search(String, Match, Match[]) does, ignoring the given words as well, as WhereBuilder.search(String, Set, Navigable, Navigable[]) ignores them.
    final PredicateBuilder<T,R,ID>
    WhereBuilder.search(String input, Match<? extends T> field, Match<? extends T>... more)
    Matches the words of a search input against text columns, each in its stated match form, as WhereBuilder.search(String, Navigable, Navigable[]) matches them anywhere in the value.
    final PredicateBuilder<T,R,ID>
    WhereBuilder.suggest(String input, Set<String> ignore, Match<? extends T> field, Match<? extends T>... more)
    Matches the words of a search box that queries as the user types against text columns, each in its stated match form, as WhereBuilder.suggest(String, Match, Match[]) does, ignoring the given words as well, as WhereBuilder.suggest(String, Set, Navigable, Navigable[]) ignores them.
    final PredicateBuilder<T,R,ID>
    WhereBuilder.suggest(String input, Match<? extends T> field, Match<? extends T>... more)
    Matches the words of a search box that queries as the user types against text columns, each in its stated match form, as WhereBuilder.suggest(String, Navigable, Navigable[]) matches them at the start of a word.