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

All Superinterfaces:

Converter, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

public interface EclipseLinkConvert
extends Converter

EclipseLink convert (not to be confused with EclipseLink 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

Nested Class Summary

static class

EclipseLinkConvert.ConverterTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.Converter

Converter.ParentAdapter<M extends AttributeMapping>

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	CLASS_INSTANCE_CONVERTER Reserved name for specifying a class instance converter.
static org.eclipse.jpt.common.utility.transformer.Transformer<Converter,EclipseLinkConvert>	CONVERTER_TRANSFORMER A transformer that returns an EclipseLinkConvert if the passed in Converter can be cast as such; otherwise, it returns null.
static String	DEFAULT_CONVERTER_NAME
static String	DEFAULT_CONVERTER_NAME_PROPERTY
static String	NO_CONVERTER Reserved name for specifying no converter.
static String[]	RESERVED_CONVERTER_NAMES
static String	SERIALIZED_CONVERTER Reserved name for specifying a serialized object converter.
static String	SPECIFIED_CONVERTER_NAME_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Method Summary

String	getConverterName()
Class<EclipseLinkConvert>	getConverterType() Return the converter's type.
String	getDefaultConverterName()
EclipseLinkPersistenceUnit	getPersistenceUnit() Return the persistence unit if the context model is within a persistence unit.
String	getSpecifiedConverterName()
void	setSpecifiedConverterName(String converterName)

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

getParent

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

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

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

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

getAdapter

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

getResourceType

Field Detail

SPECIFIED_CONVERTER_NAME_PROPERTY

static final String SPECIFIED_CONVERTER_NAME_PROPERTY

See Also:

Constant Field Values

DEFAULT_CONVERTER_NAME_PROPERTY

static final String DEFAULT_CONVERTER_NAME_PROPERTY

See Also:

Constant Field Values

SERIALIZED_CONVERTER

static final 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 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 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 String[] RESERVED_CONVERTER_NAMES

DEFAULT_CONVERTER_NAME

static final String DEFAULT_CONVERTER_NAME

See Also:

Constant Field Values

CONVERTER_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<Converter,EclipseLinkConvert> CONVERTER_TRANSFORMER

A transformer that returns an EclipseLinkConvert if the passed in Converter can be cast as such; otherwise, it returns null.

Method Detail

getConverterType

Class<EclipseLinkConvert> getConverterType()

Description copied from interface: Converter

Return the converter's type.

Specified by:

getConverterType in interface Converter

getPersistenceUnit

EclipseLinkPersistenceUnit getPersistenceUnit()

Description copied from interface: JpaContextModel

Return the persistence unit if the context model is within a persistence unit. Otherwise throw an exception.

Specified by:

getPersistenceUnit in interface JpaContextModel

getConverterName

String getConverterName()

getSpecifiedConverterName

String getSpecifiedConverterName()

setSpecifiedConverterName

void setSpecifiedConverterName(String converterName)

getDefaultConverterName

String getDefaultConverterName()