Package ch.ivyteam.ivy.business.data.store.search

Interface TextFieldOperation<T>

Type Parameters:
T -
All Superinterfaces:
FieldOperation<T>, TextFieldsOperation<T>
public interface TextFieldOperation<T> extends TextFieldsOperation<T>, FieldOperation<T>
Operations to filter text (String) fields
API:
This is a public API.

  • Method Details

    • containsAllWordPatterns

      Filter<T> containsAllWordPatterns(String wordPatterns)

      Matches texts that contain words that matches all of the given word patterns in any order. Case insensitive.
      The following wildcard characters are supported:

      • * - matches 0..n characters
      • ? - matches one character

      If a word pattern with no wildcard is given then a * is added to the end of the given word.

      White space and special characters are handled as word delimiters.

      Examples:

      • containsAllWordPatterns("") : "*"
      • containsAllWordPatterns("Quick Brown Fox") : "Quick*", "Brown*", "Fox*"
      • containsAllWordPatterns("Quick-Brown+Fox") : "Quick*", "Brown*", "Fox*"
      • containsAllWordPatterns("Q*ck Brown F?x") : "Q*ck", "Brown*", "F?x"

      Parameters:
      wordPatterns - a word pattern with wildcards (E.g. Q*ck, Q?ick or Q*ck Brown F?x)
      Returns:
      filter, orderBy, limit, execute operations
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • isEqualToIgnoringCase

      Filter<T> isEqualToIgnoringCase(String text)

      Matches text values that are equal ignoring case to the given value.

      Special non ASCII characters are converted to its equivalent ASCII characters. E.g äöü = aou, àèë = aee

      Only the first 256 characters are matched.

      Examples:

      • Äpfel = Apfel = apfel
      • Apéro = apero
      • Noël = noel
      • ...Abc = ...Xyz ("..." stands for 256 or more characters)

      Parameters:
      text -
      Returns:
      filter, orderBy, limit, execute operations
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • containsWordsInDistance

      Filter<T> containsWordsInDistance(String words, int maxWordDistance)

      Matches text values that contain words in a given max distance. Case insensitive.

      Examples:

      • A word distance of 0 means the words are adjacent.
      • A query for "quick fox" with a word distance of 1, retrieves "quick fox", "quick brown fox", "fox quick" from a given result set.
      Parameters:
      words - String with a phrase (e.g. Quick Brown Fox)
      maxWordDistance - word distance, minimal distance is 0.
      Returns:
      filter, orderBy, limit, execute operations
      Since:
      6.5
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.