EclipseLink1.0 - 20080707 API Reference

org.eclipse.persistence.mappings.transformers
Class FieldTransformerAdapter

java.lang.Object
  extended by org.eclipse.persistence.mappings.transformers.FieldTransformerAdapter
All Implemented Interfaces:
java.io.Serializable, FieldTransformer
Direct Known Subclasses:
ConstantTransformer

public class FieldTransformerAdapter
extends java.lang.Object
implements FieldTransformer

Purpose: Provides an empty implementation of FieldTransformer. Users who do not require the full FieldTransformer API can subclass this class and implement only the methods required.

Version:
$Header: /cvsroot/org.eclipse/www/eclipselink/api/1.0/org/eclipse/persistence/mappings/transformers/FieldTransformerAdapter.html,v 1.8 2008/07/08 20:20:38 pkrogh Exp $
See Also:
org.eclipse.persistence.mappings.FieldTransformer, Serialized Form
Author:
mmacivor
Since:
10

Constructor Summary
FieldTransformerAdapter()
           
 
Method Summary
 java.lang.Object buildFieldValue(java.lang.Object object, java.lang.String fieldName, Session session)
           
 void initialize(AbstractTransformationMapping mapping)
          Initialize this transformer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldTransformerAdapter

public FieldTransformerAdapter()
Method Detail

initialize

public void initialize(AbstractTransformationMapping mapping)
Description copied from interface: FieldTransformer
Initialize this transformer. Only required if the user needs some special information from the mapping in order to do the transformation

Specified by:
initialize in interface FieldTransformer
Parameters:
mapping - - the mapping this transformer is associated with.

buildFieldValue

public java.lang.Object buildFieldValue(java.lang.Object object,
                                        java.lang.String fieldName,
                                        Session session)
Specified by:
buildFieldValue in interface FieldTransformer
Parameters:
object - - an instance of the domain class which contains the attribute
fieldName - - the name of the field being transformed. Used if the user wants to use this transformer for multiple fields.
session - - the current session
Returns:
- The value to be written for the field associated with this transformer

EclipseLink1.0 - 20080707 API Reference