org.sormula.annotation

Annotation Type Where

@Inherited
 @Repeatable(value=Wheres.class)
 @Target(value={TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
public @interface Where

Defines columns to be used in a where condition for a row class. Use this to annotate a row class, Table subclass, or SqlOperation.

Since:

1.0

Author:

Jeff Miller

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Name of where condition.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	fetchSize JDBC fetch size to use for prepared statement.
java.lang.String[]	fieldNames Define condition where all fields in the condition use "=" comparison operator and are joined logically by "AND" boolean operator.
int	maximumRows Limits the number of rows to read by invoking ScalarSelectOperation.setMaximumRowsRead(int).
int	selectInitialCapacity Initial capacity of collection/map that will contain the results from SelectOperation that uses this where condition.
WhereField[]	whereFields Define condition where one or more fields use comparison operator or boolean operator other than the defaults.

Element Detail

name

public abstract java.lang.String name

Name of where condition. Must be unique among all where conditions for a row class.

Returns:

name of where condition

See Also:

SqlOperation.setWhere(String)

fieldNames

public abstract java.lang.String[] fieldNames

Define condition where all fields in the condition use "=" comparison operator and are joined logically by "AND" boolean operator. This is a typical type of where condition and allows for simpler annotation syntax. Use this instead of whereFields().

Returns:

array of field names to be used in where condition

Default:

{}

whereFields

public abstract WhereField[] whereFields

Define condition where one or more fields use comparison operator or boolean operator other than the defaults. Use this instead of fieldNames().

Returns:

array of column conditions in where condition

Default:

{}

selectInitialCapacity

public abstract int selectInitialCapacity

Initial capacity of collection/map that will contain the results from SelectOperation that uses this where condition. Sets this value with SelectOperation.setDefaultReadAllSize(int).

For queries that return large result sets, setting the initial capacity close to the number of rows in result set may improve performance since collection/map that holds results will not need to be resized as much.

Returns:

initial capacity of results collection/map

Since:

3.0

Default:

20

fetchSize

public abstract int fetchSize

JDBC fetch size to use for prepared statement. Setting fetch size may improve memory and/or performance for large result sets.

Returns:

fetchSize number of rows that should be fetched from the database when more rows are needed; zero to ignore

Since:

3.0

See Also:

Statement.setFetchSize(int)

Default:

0

maximumRows

public abstract int maximumRows

Limits the number of rows to read by invoking ScalarSelectOperation.setMaximumRowsRead(int).

Returns:

maximum number of rows to read from a result set; Integer.MAX_VALUE means no limit

Since:

3.0

Default:

2147483647