org.sormula.annotation

Annotation Type Row

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Row

Defines class attributes for a row class. Annotates a row class or Table subclass. This annotation is only required if table name is different from class name or if a name translator is needed.

Since:

1.0

Author:

Jeff Miller

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	fetchSize JDBC fetch size to use for prepared statement Table.selectAll(), Table.selectAllCustom(String, Object...), or other Table select method that does not use a where condition..
FieldAccessType	fieldAccess Specifies how all fields in row be accessed when no Column annotation is specified or when Column.fieldAccess() is FieldAccessType.Default.
boolean	inhertedFields Indicates that declared fields from the entire class hierarchy are to be used.
java.lang.Class<? extends NameTranslator>[]	nameTranslators Classes for providing sql names in place of class and field names.
java.lang.String[]	primaryKeyFields Defines the primary keys for table.
boolean	readOnly Indicates if operations using this row should never modify the database.
int	selectInitialCapacity Initial capacity of collection/map that will contain the results from Table.selectAll(), Table.selectAllCustom(String, Object...), or other Table select method that does not use a where condition.
java.lang.String	tableName SQL table name for row.

Element Detail

tableName

public abstract java.lang.String tableName

SQL table name for row. If not specified then tableName is Class.getSimpleName() or obtained by NameTranslator.translate(String, Class)

Returns:

name of table for row

Default:

""

nameTranslators

public abstract java.lang.Class<? extends NameTranslator>[] nameTranslators

Classes for providing sql names in place of class and field names. Each translator is applied in the order provided.

Returns:

translators for mapping java names to sql names

Default:

{}

readOnly

public abstract boolean readOnly

Indicates if operations using this row should never modify the database. Set to true as a way to safe-guard against accidental modification of a table.

Returns:

true to to fail with ReadOnlyException when modify operations are used; false to allow all operations

Since:

4.2

Default:

false

selectInitialCapacity

public abstract int selectInitialCapacity

Initial capacity of collection/map that will contain the results from Table.selectAll(), Table.selectAllCustom(String, Object...), or other Table select method that does not use a 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 for a select

Since:

3.0

Default:

20

inhertedFields

public abstract boolean inhertedFields

Indicates that declared fields from the entire class hierarchy are to be used. Super class fields are read prior to subclass fields.

Returns:

true to use declared fields in super class(es); false to use declared fields only from class with Row annotation

Since:

3.0

Default:

false

fetchSize

public abstract int fetchSize

JDBC fetch size to use for prepared statement Table.selectAll(), Table.selectAllCustom(String, Object...), or other Table select method that does not use a where condition.. 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

primaryKeyFields

public abstract java.lang.String[] primaryKeyFields

Defines the primary keys for table. Use this instead of Column.primaryKey() or Column.identity(). The advantage of this annotation is that the order of the keys listed is the order used by SqlOperation.setParameters(Object...). Some JVM's do not reflect the fields in order of declaration so this method provides a predictable order for primary keys.

Returns:

names of fields that are the primary keys; empty array to obtain primary keys from Column annotations

Since:

3.0

Default:

{}

fieldAccess

public abstract FieldAccessType fieldAccess

Specifies how all fields in row be accessed when no Column annotation is specified or when Column.fieldAccess() is FieldAccessType.Default.

Use FieldAccessType.Method to read/write all field values with getter/setter. Public getter/setter methods are required.

Use FieldAccessType.Direct to read/write all field values with direct access Field.equals(Object) and Field.set(Object, Object). No getter/setter are required.

If no Row annotation is specified or fieldAccess() is FieldAccessType.Default then Column.fieldAccess() is used and fieldAccess() is ignored.

If both fieldAccess() and Column.fieldAccess() are FieldAccessType.Default, then getter/setter methods are used. This is the behavior of versions prior to 3.4.

Returns:

FieldAccessType.Method, FieldAccessType.Direct, or FieldAccessType.Default

Since:

3.4

Default:

org.sormula.reflect.FieldAccessType.Default