org.eclipse.jpt.jpa.eclipselink.core.context
Interface EclipseLinkConvert

All Superinterfaces:

Converter, org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

public interface EclipseLinkConvert
extends Converter

EclipseLink convert (not to be confused with Eclipse converter)

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.1

Version:

2.1

Field Summary

static java.lang.String	CLASS_INSTANCE_CONVERTER Reserved name for specifying a class instance converter.
static java.lang.String	CONVERTER_PROPERTY
static java.lang.String	DEFAULT_CONVERTER_NAME
static java.lang.String	DEFAULT_CONVERTER_NAME_PROPERTY
static java.lang.String	NO_CONVERTER Reserved name for specifying no converter.
static java.lang.String[]	RESERVED_CONVERTER_NAMES
static java.lang.String	SERIALIZED_CONVERTER Reserved name for specifying a serialized object converter.
static java.lang.String	SPECIFIED_CONVERTER_NAME_PROPERTY

Method Summary

EclipseLinkConverter	getConverter() Return the mapping's converter.
java.lang.String	getConverterName()
java.lang.String	getDefaultConverterName()
java.lang.String	getSpecifiedConverterName()
void	setConverter(java.lang.Class<? extends EclipseLinkConverter> converterType) Possible values for the converter type are: EclipseLinkCustomConverter EclipseLinkTypeConverter EclipseLinkObjectTypeConverter EclipseLinkStructConverter null
void	setSpecifiedConverterName(java.lang.String converterName)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.Converter

getParent, getType

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

getJpaProject, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.IResourcePart

getResource

Field Detail

SPECIFIED_CONVERTER_NAME_PROPERTY

static final java.lang.String SPECIFIED_CONVERTER_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_CONVERTER_NAME_PROPERTY

static final java.lang.String DEFAULT_CONVERTER_NAME_PROPERTY

See Also:

Constant Field Values

SERIALIZED_CONVERTER

static final java.lang.String SERIALIZED_CONVERTER

Reserved name for specifying a serialized object converter. In this case a corresponding @CustomConverter is unnecessary.

See Also:

Constant Field Values

CLASS_INSTANCE_CONVERTER

static final java.lang.String CLASS_INSTANCE_CONVERTER

Reserved name for specifying a class instance converter. Will use a ClassInstanceConverter on the associated mapping. When using a ClassInstanceConverter the database representation is a String representing the Class name and the object-model representation is an instance of that class built with the zero-argument constructor. In this case a corresponding @CustomConverter is unnecessary.

See Also:

Constant Field Values

NO_CONVERTER

static final java.lang.String NO_CONVERTER

Reserved name for specifying no converter. This can be used to override a situation where either another converter is defaulted or another converter is set. In this case a corresponding @CustomConverter is unnecessary.

See Also:

Constant Field Values

RESERVED_CONVERTER_NAMES

static final java.lang.String[] RESERVED_CONVERTER_NAMES

DEFAULT_CONVERTER_NAME

static final java.lang.String DEFAULT_CONVERTER_NAME

See Also:

Constant Field Values

CONVERTER_PROPERTY

static final java.lang.String CONVERTER_PROPERTY

See Also:

Constant Field Values

Method Detail

getConverterName

java.lang.String getConverterName()

getSpecifiedConverterName

java.lang.String getSpecifiedConverterName()

setSpecifiedConverterName

void setSpecifiedConverterName(java.lang.String converterName)

getDefaultConverterName

java.lang.String getDefaultConverterName()

getConverter

EclipseLinkConverter getConverter()

Return the mapping's converter.

setConverter

void setConverter(java.lang.Class<? extends EclipseLinkConverter> converterType)

Possible values for the converter type are:

• EclipseLinkCustomConverter
• EclipseLinkTypeConverter
• EclipseLinkObjectTypeConverter
• EclipseLinkStructConverter
• null