Method Details

• of

  public static QueryString of(@NonNull String query)

  Factory method used to construct a new instance of QueryString initialized with the given OQL query statement.

  Parameters:

  query - String containing the OQL query.

  Returns:

  a new QueryString initialized with the given query.

  Throws:

  IllegalArgumentException - if query is null or empty.

  See Also:

  • QueryString(String)

• from

  public static QueryString from(@NonNull Class<?> domainType)

  Factory method used to construct a new instance of QueryString initialized with the given application domain model type from which the OQL query will be created.

  Parameters:

  domainType - application domain model type for which the OQL query will be created.

  Returns:

  a new QueryString for the given application domain model type.

  Throws:

  IllegalArgumentException - if application domain model type is null.

  See Also:

  • QueryString(Class)

• count

  public static QueryString count(Class<?> domainType)

  Factory method used to construct a new instance of QueryString that creates an OQL query to count the number of objects of the specified application domain model type.

  Parameters:

  domainType - application domain model type for which the OQL query will be created.

  Returns:

  a new count QueryString.

  Throws:

  IllegalArgumentException - if application domain model type is null.

  See Also:

  • QueryString(Class)

• getDigitsOnly

  protected static String getDigitsOnly(@Nullable String value)

  Null-safe method used to extract digits from the given String value as a whole number.

  Parameters:

  value - String to evaluate.

  Returns:

  the digits extracted from the give String value as a whole number or an empty String if the given String is null, empty or contains no digits.

  See Also:

  • String

• isLimited

  public boolean isLimited()

  Determines whether a LIMIT is present in the OQL query.

  Returns:

  a boolean value determining whether a LIMIT is present in the OQL query.

  See Also:

  • getLimit()

• getInParameterIndexes

  public Iterable<Integer> getInParameterIndexes()

  Returns the parameter indexes used in this query.

  Returns:

  the parameter indexes used in this query or an empty Iterable if no parameter indexes are used.

  See Also:

  • Iterable

• getLimit

  public int getLimit()

  Gets the LIMIT number. Use isLimited() to determine whether the OQL query statement has a LIMIT.

  Returns:

  an Integer value containing the LIMIT number or Integer.MAX_VALUE if the OQL query statement is not limited.

  See Also:

  • isLimited()

• getQuery

  @NonNull protected String getQuery()

  Returns the OQL query statement from which this QueryString was constructed.

  Returns:

  the OQL query; never null or empty.

• adjustLimit

  public QueryString adjustLimit(@Nullable Integer limit)

  Null-safe method to adjust the LIMIT of the OQL query to use the new, given LIMIT.

  Parameters:

  limit - Integer value specifying the new query LIMIT.

  Returns:

  a new QueryString with the adjusted query LIMIT.

  See Also:

  • withLimit(Integer)

• asDistinct

  public QueryString asDistinct()

  Replaces an OQL SELECT query with an OQL SELECT DISTINCT query if the query is not already distinct; i.e. does not contain the DISTINCT OQL keyword.

  Returns:

  a SELECT DISTINCT query if the query does not contain the DISTINCT OQL keyword.

  See Also:

  • asDistinct(String)

• bindIn

  @NonNull public QueryString bindIn(@NonNull Collection<?> values)

  Binds the given Collection of values into the first IN parameter of the OQL Query (String) by expanding the given values into a comma-separated list.

  Parameters:

  values - Collection of values to bind; must not be null or empty.

  Returns:

  a new QueryString having IN parameter bound with values or returns this QueryString if the Collection of values is null or empty.

  See Also:

  • Collection

• fromRegion

  public QueryString fromRegion(org.apache.geode.cache.Region<?,?> region, Class<?> domainType)

  Replaces the domain classes referenced inside the current query with the given Region.

  Parameters:

  region - Region to query; must not be null.

  domainType - type of the persistent entity to query; must not be null.

  Returns:

  a new QueryString with an OQL SELECT statement having a FROM clause based on the selected Region.

  See Also:

  • Region
  • Class

• fromRegion

  @Deprecated public QueryString fromRegion(Class<?> domainType, org.apache.geode.cache.Region<?,?> region)

  Deprecated.

  use fromRegion(Region, Class).

• orderBy

  @NonNull public QueryString orderBy(@Nullable org.springframework.data.domain.Sort sort)

  Appends the Sort order to this GemFire OQL Query string.

  Parameters:

  sort - Sort indicating the order of the query results.

  Returns:

  a new QueryString with an ORDER BY clause if Sort is not null, or this QueryString as-is if Sort is null.

  See Also:

  • Sort
  • QueryString

• withHints

  @NonNull public QueryString withHints(@NonNull String... hints)

  Applies HINTS to the OQL Query.

  Parameters:

  hints - array of Strings containing query hints.

  Returns:

  a new QueryString if hints are not null or empty, or return this QueryString.

• withImport

  @NonNull public QueryString withImport(@NonNull String importExpression)

  Applies an IMPORT to the OQL Query.

  Parameters:

  importExpression - String containing the import clause.

  Returns:

  a new QueryString if an import was declared, or return this QueryString.

• withLimit

  @NonNull public QueryString withLimit(@NonNull Integer limit)

  Applies a LIMIT to the OQL Query.

  Parameters:

  limit - Integer indicating the number of results to return from the query.

  Returns:

  a new QueryString if a limit was specified, or return this QueryString.

• withTrace

  @NonNull public QueryString withTrace()

  Applies TRACE logging to the OQL Query.

  Returns:

  a new QueryString with tracing enabled.

• toString

  public String toString()

  Returns a String representation of this QueryString. Returns the complete OQL query statement.

  Overrides:

  toString in class Object

  Returns:

  a String representation of this QueryString.

  See Also:

  • Object.toString()
  • String