Module eclipselink

Package org.eclipse.persistence.mappings.transformers

Interface FieldTransformer

All Superinterfaces:

CoreFieldTransformer<Session>, Serializable

All Known Implementing Classes:

ConstantTransformer, FieldTransformerAdapter, MethodBasedFieldTransformer, NamespaceURITransformer, QNameTransformer

public interface FieldTransformer
extends CoreFieldTransformer<Session>

PUBLIC: This interface is used by the Transformation Mapping to build the value for a specific field. The user must provide implementations of this interface to the Transformation Mapping.

Author:

mmacivor

Since:

10.1.3

Field Summary

Fields inherited from interface org.eclipse.persistence.core.mappings.transformers.CoreFieldTransformer

BUILD_FIELD_VALUE_METHOD

Method Summary

Modifier and Type	Method	Description
Object	buildFieldValue(Object instance, String fieldName, Session session)
void	initialize(AbstractTransformationMapping mapping)	Initialize this transformer.

Method Detail

initialize

void initialize(AbstractTransformationMapping mapping)

Initialize this transformer. Only required if the user needs some special information from the mapping in order to do the transformation

Parameters:

mapping - - the mapping this transformer is associated with.

buildFieldValue

Object buildFieldValue(Object instance,
                       String fieldName,
                       Session session)

Specified by:

buildFieldValue in interface CoreFieldTransformer<Session>

Parameters:

instance - - an instance of the domain class which contains the attribute

session - - the current session

fieldName - - the name of the field being transformed. Used if the user wants to use this transformer for multiple fields.

Returns:

- The value to be written for the field associated with this transformer