com.sleepycat.je.sync

Interface RecordConverter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RecordMapping

public interface RecordConverter
extends java.io.Serializable

Provides custom data conversion between records in an external table/view and raw data records in a local database.

This low-level interface is implemented by the RecordMapping class, which is normally used whenever a JE binding is available. When a binding is not available, or the RecordMapping class is not sufficient, the user may implement this interface directly.

Method Summary

Modifier and Type	Method and Description
void	convertExternalToLocal(java.lang.Object[] externalFieldValues, DatabaseEntry localKey, DatabaseEntry localData) Converts an array of external record values to a local raw data record.
void	convertLocalToExternal(DatabaseEntry localKey, DatabaseEntry localData, java.lang.Object[] externalFieldValues) Converts the local raw data record to an array of external record values.
java.lang.String[]	getExternalFieldNames() Returns an array of the names of fields in the external RDBMS.
java.lang.Class[]	getExternalFieldTypes() Returns an array of the types of fields in the external RDBMS.
void	initializeConverter(java.lang.Class[] externalFieldTypes, java.lang.String[] externalFieldNames) Initializes the converter with the external field/column names and data types.

Method Detail

initializeConverter

void initializeConverter(java.lang.Class[] externalFieldTypes,
                         java.lang.String[] externalFieldNames)

Initializes the converter with the external field/column names and data types. The array of external field values will correspond by inddex to the two arrays given here.

convertLocalToExternal

void convertLocalToExternal(DatabaseEntry localKey,
                            DatabaseEntry localData,
                            java.lang.Object[] externalFieldValues)

Converts the local raw data record to an array of external record values.

convertExternalToLocal

void convertExternalToLocal(java.lang.Object[] externalFieldValues,
                            DatabaseEntry localKey,
                            DatabaseEntry localData)

Converts an array of external record values to a local raw data record.

If localData is non-empty (DatabaseEntry.getSize() returns greater than zero), updates the existing record; otherwise, creates a new local record.

getExternalFieldTypes

java.lang.Class[] getExternalFieldTypes()

Returns an array of the types of fields in the external RDBMS.

Returns:

an array of the fields' types in the external RDBMS.

getExternalFieldNames

java.lang.String[] getExternalFieldNames()

Returns an array of the names of fields in the external RDBMS.

Returns:

an array of fields' names in the external RDBMS.