EclipseLink 2.0.0, build 'v20091127-r5931' API Reference

org.eclipse.persistence.annotations
Annotation Type ReadTransformer


@Target(value={METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface ReadTransformer

Annotation for org.eclipse.persistence.mappings.TransformationMapping. Unless the TransformationMapping is write-only, it should have a ReadTransformer, it defines transformation of database column(s) value(s) into attribute value. Also unless it's a read-only mapping, either WriteTransformer annotation or WriteTransformers annotation should be specified. Each WriteTransformer defines transformation of the attribute value to a single database column value (column is specified in the WriteTransformer).

See Also:
Transformation, WriteTransformer, Transformation can be specified within an Entity, MappedSuperclass and Embeddable class.
Author:
Andrei Ilitchev

Optional Element Summary
 java.lang.String method
          The mapped class must have a method with this name which returns a value to be assigned to the attribute (not assigns the value to the attribute).
 java.lang.Class transformerClass
          User-defined class that must implement the org.eclipse.persistence.mappings.transformers.AttributeTransformer interface.
 

transformerClass

public abstract java.lang.Class transformerClass
User-defined class that must implement the org.eclipse.persistence.mappings.transformers.AttributeTransformer interface. The class will be instantiated, its buildAttributeValue will be used to create the value to be assigned to the attribute. Either transformerClass or method must be specified, but not both.

Default:
void.class

method

public abstract java.lang.String method
The mapped class must have a method with this name which returns a value to be assigned to the attribute (not assigns the value to the attribute). Either transformerClass or method must be specified, but not both.

Default:
""

EclipseLink 2.0.0, build 'v20091127-r5931' API Reference