@Documented
@Retention(value=java.lang.annotation.RetentionPolicy.RUNTIME)
@Target(value=java.lang.annotation.ElementType.FIELD)

Annotation that allows for the field of a data class for a given DataSet to be mapped to a column of a SQL result set that is returned by invoking a method decorated by a Select annotation.

Overview

The ResultColumn annotation is used to decorate a field within a data class, allowing the application developer to specify an alternative name for the column returned in a SQL result set.

The ResultColumn annotation can also be used to indicate that a data class field is to be used to uniquely identify a row when a DataSet is used in a disconnected mode. There must be at least one column specified to uniquely identify a row for a disconnected DataSet otherwise a SQLRuntimeException will be thrown.

In the example below, the ResultColumn annotation is used to specify that the Mammal.weight field corresponds to the column kilos in the result set that is returned by invoking the method getAllMammals.

 public class Mammal {
     public String name;
     public String description;
     public @ResultColumn("kilos") int weight;
 }
 

 // Obtain an instance of the Query interface, Queries
 Queries myQueries = con.createQueryObject(Queries.class)
 DataSet<Mammal> rows = myQueries.getAllMammals();
 for( Mammal row :rows) {
     System.out.print("name: " + row.name + ", weight: " + row.weight);
 }
 

since

1.6