com.abubusoft.kripton.android.annotation

Annotation Type BindSqlSelect

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface BindSqlSelect

Allow to query a database table. When you define the query through interface's method you can define query parameter by a DAO's associated bean instance, or directly with fields.

Query parameters

Almost all parameters used in method can be used as query parameter.

 @BindSqlSelect(where = "name=${name} and surname=${surname}")
 Person selectOne(String name, @BindSqlParam("surname") String temp);
 

Parameters of where condition are linked to method parameters with the syntax ${<name of parameter>}

Return query result

There are many return type allowed for method which define a query:

• a DAO's associated bean instance
• list of associated bean
• set of associated bean
• Cursor: it is possible to wrap cursor with the cursor wrapper generated for bean associated to DAO. For example, given a Person and PersonDAO, will be generated BindPersonCursor
• It is possible to set return type as Void and define a OnReadBeanListener which a method void onRead(E bean, int row, int rowCount) allow to manage each row of result with only one bean (reused) instance.
• It is possible to set return type as Void and define a OnReadCursorListener which a method void onRead(Cursor cursor) allows to manage resultset iteration with a cursor.

Since:

05/mag/2016

Author:

Francesco Benincasa (abubusoft@gmail.com)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	distinct if true, set distinct clause
String[]	excludedFields properties to exclude from SELECT statement.
String	groupBy having statement
String	having having statement
String	orderBy order statement
int	pageSize Allow to define limit for query result.
String[]	value properties to include into SELECT command
String	where where condition

Element Detail

distinct

public abstract boolean distinct

if true, set distinct clause

Returns:

distinct clause

Default:

false

value

public abstract String[] value

properties to include into SELECT command

Returns:

property's names to include

Default:

{}

excludedFields

public abstract String[] excludedFields

properties to exclude from SELECT statement.

Returns:

property's names to exclude

Default:

{}

where

public abstract String where

where condition

Returns:

where condition

Default:

""

having

public abstract String having

having statement

Returns:

having statement

Default:

""

groupBy

public abstract String groupBy

having statement

Returns:

groupBy statement

Default:

""

orderBy

public abstract String orderBy

order statement

Returns:

order statement

Default:

""

pageSize

public abstract int pageSize

Allow to define limit for query result. Default no limit is defined.

Returns:

Default:

0