Package com.storedobject.core

Class QueryBuilder<T extends StoredObject>

java.lang.Object

com.storedobject.core.QueryBuilder<T>

Type Parameters:

T - The type of StoredObject this builder targets.

public class QueryBuilder<T extends StoredObject>
extends Object

A builder class for constructing queries and retrieving StoredObject instances based on various criteria. This class provides methods to specify conditions, sorting and other query parameters. This can be used for querying and/or retrieving StoredObject instances, their link instances and master instances.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
QueryBuilder<T>	any()	Enables the "any" condition so that all subclasses to be included in the output.
QueryBuilder<T>	any(boolean any)	Sets the "any" condition for the query, a boolean value indicating whether to retrieve all subclasses or not.
QueryBuilder<T>	any(Boolean any)	Sets the "any" condition for the query, a boolean value indicating whether to retrieve all subclasses or not.
QueryBuilder<T>	columns(String columns)	Sets the column names to be retrieved or operated upon in the query being built.
int	count()	Counts the number of records that match the query constructed using the current configurations of the QueryBuilder.
int	countLinks(Id parentId)	Counts the number of links associated with the given parent object.
int	countLinks(Id parentId, int linkType)	Counts the number of links of a specified type for a given parent object.
int	countLinks(StoredObject parent)	Counts the number of links associated with the given parent object.
int	countLinks(StoredObject parent, int linkType)	Counts the number of links of a specified type for a given parent object.
int	countMasters(Id link)	Counts the number of master objects associated with the given link.
int	countMasters(Id linkId, int linkType)	Counts the number of master objects associated with a given link and link type.
int	countMasters(StoredObject link)	Counts the number of master objects associated with the given link.
int	countMasters(StoredObject link, int linkType)	Counts the number of master objects associated with a given link and link type.
QueryBuilder<T>	distinctColumns(int... columnNumbers)	Specifies the columns by their indexes to be considered as distinct in the query.
boolean	exists()	Check whether any entry exists or not.
boolean	existsLinks(Id parentId)	Check whether link objects exists associated with the specified parent object.
boolean	existsLinks(Id parentId, int linkType)	Check whether link objects exists associated with the specified parent object and of a specific link type.
boolean	existsLinks(StoredObject parent)	Check whether link objects exists associated with the specified parent object.
boolean	existsLinks(StoredObject parent, int linkType)	Check whether link objects exists associated with the specified parent object and of a specific link type.
boolean	existsMasters(Id linkId)	Check whether master objects exists related to the given stored object link.
boolean	existsMasters(Id link, int linkType)	Check whether master objects exists associated with a given stored object link and link type.
boolean	existsMasters(StoredObject link)	Check whether master objects exists related to the given stored object link.
boolean	existsMasters(StoredObject link, int linkType)	Check whether master objects exists associated with a given stored object link and link type.
static <O extends StoredObject> QueryBuilder<O>	from(Class<O> objectClass)	Creates a new QueryBuilder instance for the specified class type.
T	get()	Get an object instance.
static <O extends StoredObject> String	getExistsCondition(Class<O> objectClass, String attributeName)	Create an "exists condition" that can be used for retrieving or querying StoredObject instances.
static <O extends StoredObject> String	getExistsCondition(Class<O> objectClass, String attributeName, String condition)	Create an "exists condition" that can be used for retrieving or querying StoredObject instances.
static <O extends StoredObject> String	getInCondition(String attributeName, Class<O> objectClass)
static <O extends StoredObject> String	getInCondition(String attributeName, Class<O> objectClass, boolean any)
static <O extends StoredObject> String	getInCondition(String attributeName, Class<O> objectClass, String condition)
static <O extends StoredObject> String	getInCondition(String attributeName, Class<O> objectClass, String condition, boolean any)
T	getLink(Id masterId)	Get the first link object.
T	getLink(Id masterId, int linkType)	Get the first link object.
T	getLink(StoredObject master)	Get the first link object.
T	getLink(StoredObject master, int linkType)	Get the first link object.
T	getMaster(Id linkId)	Get the first master object.
T	getMaster(Id linkId, int linkType)	Get the first master object.
T	getMaster(StoredObject link)	Get the first master object.
T	getMaster(StoredObject link, int linkType)	Get the first master object.
static <O extends StoredObject> String	getNotExistsCondition(Class<O> objectClass, String attributeName)	Create a "not exists condition" that can be used for retrieving or querying StoredObject instances.
static <O extends StoredObject> String	getNotExistsCondition(Class<O> objectClass, String attributeName, String condition)	Create a "not exists condition" that can be used for retrieving or querying StoredObject instances.
static <O extends StoredObject> String	getNotInCondition(String attributeName, Class<O> objectClass)
static <O extends StoredObject> String	getNotInCondition(String attributeName, Class<O> objectClass, boolean any)
static <O extends StoredObject> String	getNotInCondition(String attributeName, Class<O> objectClass, String condition)
static <O extends StoredObject> String	getNotInCondition(String attributeName, Class<O> objectClass, String condition, boolean any)
Class<T>	getObjectClass()	Retrieves the class type of the object represented by this instance.
QueryBuilder<T>	limit(int limit)	Sets a limit on the number of records to be retrieved by the query.
ObjectIterator<T>	list()	Retrieves an iterator containing the results that match the query constructed with the current configurations of QueryBuilder.
ObjectIterator<T>	listLinks(Id parentId)	Returns an iterator over the linked objects of the specified parent object.
ObjectIterator<T>	listLinks(Id parentId, int linkType)	Retrieves an iterator over objects that are linked to the given parent object with the specified link type.
ObjectIterator<T>	listLinks(StoredObject parent)	Returns an iterator over the linked objects of the specified parent object.
ObjectIterator<T>	listLinks(StoredObject parent, int linkType)	Retrieves an iterator over objects that are linked to the given parent object with the specified link type.
ObjectIterator<T>	listMasters(Id linkId)	Retrieves an iterator over master objects linked to the specified stored object.
ObjectIterator<T>	listMasters(Id linkId, int linkType)	Retrieves an iterator over the master objects linked to the specified stored object.
ObjectIterator<T>	listMasters(StoredObject link)	Retrieves an iterator over master objects linked to the specified stored object.
ObjectIterator<T>	listMasters(StoredObject link, int linkType)	Retrieves an iterator over the master objects linked to the specified stored object.
QueryBuilder<T>	orderBy(String orderBy)	Sets the "order by" clause for the query being built.
Query	query()	Executes the query built using the current configurations of the QueryBuilder.
Query	queryLinks(Id parentId)	Constructs a query to retrieve the links associated with the specified parent object.
Query	queryLinks(Id parentId, int linkType)	Constructs a query to retrieve the links associated with the specified parent object and of a specific link type.
Query	queryLinks(StoredObject parent)	Constructs a query to retrieve the links associated with the specified parent object.
Query	queryLinks(StoredObject parent, int linkType)	Constructs a query to retrieve the links associated with the specified parent object and of a specific link type.
Query	queryMasters(Id linkId)	Queries and retrieves master objects related to the given stored object link.
Query	queryMasters(Id linkId, int linkType)	Queries the master objects associated with a given stored object link and link type.
Query	queryMasters(StoredObject link)	Queries and retrieves master objects related to the given stored object link.
Query	queryMasters(StoredObject link, int linkType)	Queries the master objects associated with a given stored object link and link type.
String	querySQL()	Constructs and returns an SQL query string based on the given parameters and object class.
QueryBuilder<T>	skip(int skip)	Sets an offset to skip a specified number of records or results in the query being built.
QueryBuilder<T>	transaction(Transaction transaction)	Sets the transaction for the query being built.
QueryBuilder<T>	where(String where)	Sets the "where" clause for the query being built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public static <O extends StoredObject>
QueryBuilder<O> from(Class<O> objectClass)

Creates a new QueryBuilder instance for the specified class type.

Type Parameters:

O - The type of objects that extend StoredObject.

Parameters:

objectClass - The class of the object for which the query builder is to be created.

Returns:

A new QueryBuilder instance for the specified object type.

getObjectClass

public Class<T> getObjectClass()

Retrieves the class type of the object represented by this instance.

Returns:

the class type of the object

where

public QueryBuilder<T> where(String where)

Sets the "where" clause for the query being built.

Parameters:

where - The condition to filter the query results. It should be a valid query condition string.

Returns:

The current QueryBuilder instance with the specified "where" clause applied.

orderBy

public QueryBuilder<T> orderBy(String orderBy)

Sets the "order by" clause for the query being built.

Parameters:

orderBy - The column or columns by which the query results should be ordered. It should be a valid column name or a comma-separated list of column names.

Returns:

The current QueryBuilder instance with the specified "order by" clause applied.

limit

public QueryBuilder<T> limit(int limit)

Sets a limit on the number of records to be retrieved by the query.

Parameters:

limit - The maximum number of results the query should return.

Returns:

The current QueryBuilder instance with the specified limit applied.

skip

public QueryBuilder<T> skip(int skip)

Sets an offset to skip a specified number of records or results in the query being built.

Parameters:

skip - The number of records to skip in the result set.

Returns:

The current QueryBuilder instance with the specified skip value applied.

any

public QueryBuilder<T> any()

Enables the "any" condition so that all subclasses to be included in the output.

Returns:

The current QueryBuilder instance with the "any" condition applied.

any

public QueryBuilder<T> any(Boolean any)

Sets the "any" condition for the query, a boolean value indicating whether to retrieve all subclasses or not.

Parameters:

any - A value of true means all subclasses to be included. If any is null, it is considered as false.

Returns:

the updated QueryBuilder instance.

any

public QueryBuilder<T> any(boolean any)

Sets the "any" condition for the query, a boolean value indicating whether to retrieve all subclasses or not.

Parameters:

any - A value of true means all subclasses to be included.

Returns:

the updated QueryBuilder instance.

columns

public QueryBuilder<T> columns(String columns)

Sets the column names to be retrieved or operated upon in the query being built.

Parameters:

columns - A string representing the column names to include in the query. The column names should be separated by commas if specifying multiple columns. Since the SO platform supports dot (.) notation to retrieve related class instances, it may be used to obtain attributes of related class instances.

Returns:

The current QueryBuilder instance with the specified columns applied.

distinctColumns

public QueryBuilder<T> distinctColumns(int... columnNumbers)

Specifies the columns by their indexes to be considered as distinct in the query.

Parameters:

columnNumbers - The indexes of the columns to be included as distinct in the query.

Returns:

The current QueryBuilder instance with the specified distinct columns applied.

transaction

public QueryBuilder<T> transaction(Transaction transaction)

Sets the transaction for the query being built.

Parameters:

transaction - The transaction to be associated with the query.

Returns:

The current QueryBuilder instance with the specified transaction applied.

get

public T get()

Get an object instance. The first item is retrieved.

Returns:

An object instance or null.

getMaster

public T getMaster(StoredObject link)

Get the first master object.

Parameters:

link - Link object.

Returns:

A master instance or null.

getMaster

public T getMaster(StoredObject link,
 int linkType)

Get the first master object.

Parameters:

link - Link object.

linkType - Link type.

Returns:

A master instance or null.

getMaster

public T getMaster(Id linkId)

Get the first master object.

Parameters:

linkId - Link Id.

Returns:

A master instance or null.

getMaster

public T getMaster(Id linkId,
 int linkType)

Get the first master object.

Parameters:

linkId - Link Id.

linkType - Link type.

Returns:

A master instance or null.

getLink

public T getLink(StoredObject master)

Get the first link object.

Parameters:

master - Master object.

Returns:

A master instance or null.

getLink

public T getLink(StoredObject master,
 int linkType)

Get the first link object.

Parameters:

master - Master object.

linkType - Link type.

Returns:

A master instance or null.

getLink

public T getLink(Id masterId)

Get the first link object.

Parameters:

masterId - Master Id.

Returns:

A master instance or null.

getLink

public T getLink(Id masterId,
 int linkType)

Get the first link object.

Parameters:

masterId - Master Id.

linkType - Link type.

Returns:

A master instance or null.

exists

public boolean exists()

Check whether any entry exists or not.

Returns:

True/false

query

public Query query()

Executes the query built using the current configurations of the QueryBuilder.

Returns:

The Query object representing the query configured with the specified parameters such as object class, columns, where clause, order by clause, distinct columns, transaction, and limits.

list

public ObjectIterator<T> list()

Retrieves an iterator containing the results that match the query constructed with the current configurations of QueryBuilder.

Returns:

An ObjectIterator containing objects of type T that satisfy the query criteria, including filters, ordering, limits, and other specified parameters.

count

public int count()

Counts the number of records that match the query constructed using the current configurations of the QueryBuilder.

Returns:

The number of records that match the specified query criteria.

queryLinks

public Query queryLinks(StoredObject parent)

Constructs a query to retrieve the links associated with the specified parent object.

Parameters:

parent - The parent object for which linked objects are to be queried.

Returns:

A Query object representing the links associated with the given parent object.

queryLinks

public Query queryLinks(Id parentId)

Constructs a query to retrieve the links associated with the specified parent object.

Parameters:

parentId - The parent object Id for which linked objects are to be queried.

Returns:

A Query object representing the links associated with the given parent object.

queryLinks

public Query queryLinks(StoredObject parent,
 int linkType)

Constructs a query to retrieve the links associated with the specified parent object and of a specific link type.

Parameters:

parent - The parent object for which linked objects of the specified link type are to be queried.

linkType - The type of links to filter the query results.

Returns:

A Query object representing the links of the given type associated with the specified parent object.

queryLinks

public Query queryLinks(Id parentId,
 int linkType)

Constructs a query to retrieve the links associated with the specified parent object and of a specific link type.

Parameters:

parentId - The parent object Id for which linked objects of the specified link type are to be queried.

linkType - The type of links to filter the query results.

Returns:

A Query object representing the links of the given type associated with the specified parent object.

existsLinks

public boolean existsLinks(StoredObject parent)

Check whether link objects exists associated with the specified parent object.

Parameters:

parent - The parent object for which linked objects are to be queried.

Returns:

True/false.

existsLinks

public boolean existsLinks(Id parentId)

Check whether link objects exists associated with the specified parent object.

Parameters:

parentId - The parent object Id for which linked objects are to be queried.

Returns:

True/false.

existsLinks

public boolean existsLinks(StoredObject parent,
 int linkType)

Check whether link objects exists associated with the specified parent object and of a specific link type.

Parameters:

parent - The parent object for which linked objects of the specified link type are to be queried.

linkType - The type of links to filter the query results.

Returns:

True/false.

existsLinks

public boolean existsLinks(Id parentId,
 int linkType)

Check whether link objects exists associated with the specified parent object and of a specific link type.

Parameters:

parentId - The parent object Id for which linked objects of the specified link type are to be queried.

linkType - The type of links to filter the query results.

Returns:

True/false.

listLinks

public ObjectIterator<T> listLinks(StoredObject parent)

Returns an iterator over the linked objects of the specified parent object.

Parameters:

parent - the parent StoredObject whose linked objects are to be listed

Returns:

an iterator over the linked objects of the specified parent

listLinks

public ObjectIterator<T> listLinks(Id parentId)

Returns an iterator over the linked objects of the specified parent object.

Parameters:

parentId - the parent object Id whose linked objects are to be listed

Returns:

an iterator over the linked objects of the specified parent

listLinks

public ObjectIterator<T> listLinks(StoredObject parent,
 int linkType)

Retrieves an iterator over objects that are linked to the given parent object with the specified link type.

Parameters:

parent - the parent object whose links are to be listed

linkType - the type of links to filter the results

Returns:

an iterator over the linked objects of the specified type

listLinks

public ObjectIterator<T> listLinks(Id parentId,
 int linkType)

Retrieves an iterator over objects that are linked to the given parent object with the specified link type.

Parameters:

parentId - the parent object Id whose links are to be listed

linkType - the type of links to filter the results

Returns:

an iterator over the linked objects of the specified type

countLinks

public int countLinks(StoredObject parent)

Counts the number of links associated with the given parent object.

Parameters:

parent - the parent object for which the links are to be counted

Returns:

the total number of links associated with the specified parent

countLinks

public int countLinks(Id parentId)

Counts the number of links associated with the given parent object.

Parameters:

parentId - the parent object Id for which the links are to be counted

Returns:

the total number of links associated with the specified parent

countLinks

public int countLinks(StoredObject parent,
 int linkType)

Counts the number of links of a specified type for a given parent object.

Parameters:

parent - the parent object whose links are to be counted

linkType - the type of links to be counted

Returns:

the count of links of the specified type for the given parent object

countLinks

public int countLinks(Id parentId,
 int linkType)

Counts the number of links of a specified type for a given parent object.

Parameters:

parentId - the parent object Id whose links are to be counted

linkType - the type of links to be counted

Returns:

the count of links of the specified type for the given parent object

existsMasters

public boolean existsMasters(StoredObject link)

Check whether master objects exists related to the given stored object link.

Parameters:

link - the StoredObject that serves as a reference for querying master objects

Returns:

True/false.

existsMasters

public boolean existsMasters(Id linkId)

Check whether master objects exists related to the given stored object link.

Parameters:

linkId - the link object that serves as a reference for querying master objects

Returns:

True/false.

existsMasters

public boolean existsMasters(StoredObject link,
 int linkType)

Check whether master objects exists associated with a given stored object link and link type.

Parameters:

link - the stored object link to query masters for

linkType - the type of link defining the relationship between the object and its masters

Returns:

True/false.

existsMasters

public boolean existsMasters(Id link,
 int linkType)

Check whether master objects exists associated with a given stored object link and link type.

Parameters:

link - the stored object link to query masters for

linkType - the type of link defining the relationship between the object and its masters

Returns:

True/false.

queryMasters

public Query queryMasters(StoredObject link)

Queries and retrieves master objects related to the given stored object link.

Parameters:

link - the StoredObject that serves as a reference for querying master objects

Returns:

a Query object containing the result set of master objects matching the criteria

queryMasters

public Query queryMasters(Id linkId)

Queries and retrieves master objects related to the given stored object link.

Parameters:

linkId - the object Id that serves as a reference for querying master objects

Returns:

a Query object containing the result set of master objects matching the criteria

queryMasters

public Query queryMasters(StoredObject link,
 int linkType)

Queries the master objects associated with a given stored object link and link type.

Parameters:

link - the stored object link to query masters for

linkType - the type of link defining the relationship between the object and its masters

Returns:

a Query object containing the results of the master objects query

queryMasters

public Query queryMasters(Id linkId,
 int linkType)

Queries the master objects associated with a given stored object link and link type.

Parameters:

linkId - the stored object link Id to query masters for

linkType - the type of link defining the relationship between the object and its masters

Returns:

a Query object containing the results of the master objects query

listMasters

public ObjectIterator<T> listMasters(StoredObject link)

Retrieves an iterator over master objects linked to the specified stored object.

Parameters:

link - the stored object for which the master objects are to be listed

Returns:

an iterator over the master objects associated with the given stored object

listMasters

public ObjectIterator<T> listMasters(Id linkId)

Retrieves an iterator over master objects linked to the specified stored object.

Parameters:

linkId - the link object Id for which the master objects are to be listed

Returns:

an iterator over the master objects associated with the given stored object

listMasters

public ObjectIterator<T> listMasters(StoredObject link,
 int linkType)

Retrieves an iterator over the master objects linked to the specified stored object.

Parameters:

link - The stored object for which to list the master objects.

linkType - The type of the link used to filter the master objects.

Returns:

An iterator over the master objects linked to the specified stored object.

listMasters

public ObjectIterator<T> listMasters(Id linkId,
 int linkType)

Retrieves an iterator over the master objects linked to the specified stored object.

Parameters:

linkId - The link object Id for which to list the master objects.

linkType - The type of the link used to filter the master objects.

Returns:

An iterator over the master objects linked to the specified stored object.

querySQL

public String querySQL()

Constructs and returns an SQL query string based on the given parameters and object class. This method uses the StoredObjectUtility class to create an SQL statement that includes the specified column selections, filtering conditions, ordering, and other query attributes.

Returns:

a String representing the constructed SQL query based on the provided parameters.

countMasters

public int countMasters(StoredObject link)

Counts the number of master objects associated with the given link.

Parameters:

link - The link object representing the link for which the count of masters is required.

Returns:

The count of master objects associated with the provided link.

countMasters

public int countMasters(Id link)

Counts the number of master objects associated with the given link.

Parameters:

link - The link object Id representing the link for which the count of masters is required.

Returns:

The count of master objects associated with the provided link.

countMasters

public int countMasters(StoredObject link,
 int linkType)

Counts the number of master objects associated with a given link and link type.

Parameters:

link - the link object representing the link.

linkType - an integer representing the type of link.

Returns:

the count of master objects associated with the specified link and link type.

countMasters

public int countMasters(Id linkId,
 int linkType)

Counts the number of master objects associated with a given link and link type.

Parameters:

linkId - the link object Id representing the link.

linkType - an integer representing the type of link.

Returns:

the count of master objects associated with the specified link and link type.

getExistsCondition

public static <O extends StoredObject> String getExistsCondition(Class<O> objectClass,
 String attributeName)

Create an "exists condition" that can be used for retrieving or querying StoredObject instances.

Type Parameters:

O - Type of this object class.

Parameters:

objectClass - The object class against which the existence should be checked.

attributeName - Attribute name that matches the Id of the object that is going to be retrieved or queried.

Returns:

Condition string suitable for retrieving or querying another type of StoredObject instances where this object is related.

getExistsCondition

public static <O extends StoredObject> String getExistsCondition(Class<O> objectClass,
 String attributeName,
 String condition)

Create an "exists condition" that can be used for retrieving or querying StoredObject instances.

Type Parameters:

O - Type of this object class.

Parameters:

objectClass - The object class against which the existence should be checked.

attributeName - Attribute name that matches the Id of the object that is going to be retrieved or queried.

condition - Condition to be applied to this object class. Null should be passed if no condition needs to be applied.

Returns:

Condition string suitable for retrieving or querying another type of StoredObject instances where this object is related.

getNotExistsCondition

public static <O extends StoredObject> String getNotExistsCondition(Class<O> objectClass,
 String attributeName)

Create a "not exists condition" that can be used for retrieving or querying StoredObject instances.

Type Parameters:

O - Type of this object class.

Parameters:

objectClass - The object class against which the existence should be checked.

attributeName - Attribute name that matches the Id of the object that is going to be retrieved or queried.

Returns:

Condition string suitable for retrieving or querying another type of StoredObject instances where this object is related.

getNotExistsCondition

public static <O extends StoredObject> String getNotExistsCondition(Class<O> objectClass,
 String attributeName,
 String condition)

Create a "not exists condition" that can be used for retrieving or querying StoredObject instances.

Type Parameters:

O - Type of this object class.

Parameters:

objectClass - The object class against which the existence should be checked.

attributeName - Attribute name that matches the Id of the object that is going to be retrieved or queried.

condition - Condition to be applied to this object class. Null should be passed if no condition needs to be applied.

Returns:

Condition string suitable for retrieving or querying another type of StoredObject instances where this object is related.

getInCondition

public static <O extends StoredObject> String getInCondition(String attributeName,
 Class<O> objectClass)

getInCondition

public static <O extends StoredObject> String getInCondition(String attributeName,
 Class<O> objectClass,
 boolean any)

getInCondition

public static <O extends StoredObject> String getInCondition(String attributeName,
 Class<O> objectClass,
 String condition)

getInCondition

public static <O extends StoredObject> String getInCondition(String attributeName,
 Class<O> objectClass,
 String condition,
 boolean any)

getNotInCondition

public static <O extends StoredObject> String getNotInCondition(String attributeName,
 Class<O> objectClass)

getNotInCondition

public static <O extends StoredObject> String getNotInCondition(String attributeName,
 Class<O> objectClass,
 boolean any)

getNotInCondition

public static <O extends StoredObject> String getNotInCondition(String attributeName,
 Class<O> objectClass,
 String condition)

getNotInCondition

public static <O extends StoredObject> String getNotInCondition(String attributeName,
 Class<O> objectClass,
 String condition,
 boolean any)