Top Description Methods
org.hibernate.annotations

public @Interface Formula

extends Annotation
Annotations
@Target:METHOD, FIELD
@Retention:RUNTIME
Imports
java.lang.annotation.Retention, .Target

Defines a formula (derived value) which is a SQL fragment that acts as a @Column alternative in most cases. Represents read-only state. In certain cases @ColumnTransformer might be a better option, especially as it leaves open the option of still being writable.
    // perform calculations
    @Formula( "sub_total + (sub_total * tax)" )
    long getTotalCost() { ... }
    // call database functions ( e.g. MySQL upper() and substring() )
    @Formula( "upper( substring( middle_name, 1 ) )" )
    Character getMiddleInitial() { ... }
    // this might be better handled through @ColumnTransformer
    @Formula( "decrypt(credit_card_num)" )
    String getCreditCardNumber() { ... }
Authors
Emmanuel Bernard, Steve Ebersole
See Also
ColumnTransformer

Method Summary

Modifier and TypeMethod and Description
public String
value()

The formula string.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String value()

The formula string.