org.eclipse.jpt.jpa.core.context.orm
Interface OrmManagedType

All Superinterfaces:

DeleteTypeRefactoringParticipant, IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, ManagedType, Model, TypeRefactoringParticipant

All Known Subinterfaces:

EclipseLinkOrmPersistentType, OrmPersistentType

public interface OrmManagedType
extends ManagedType, DeleteTypeRefactoringParticipant, TypeRefactoringParticipant

Context managed type.

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:

3.3

Nested Class Summary

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

ManagedType.NameTransformer

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

JptResourceTypeReference.ResourceTypeTransformer

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

DeleteTypeRefactoringParticipant.DeleteTypeEditsTransformer

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

TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer

Field Summary

static String	CLASS_PROPERTY
static String	JAVA_MANAGED_TYPE_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.context.ManagedType

NAME_PROPERTY, NAME_TRANSFORMER

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

RESOURCE_TYPE_TRANSFORMER

Method Summary

void	addXmlManagedTypeTo(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings) Add the managed type's XML managed type to the appropriate list in the specified XML entity mappings.
void	dispose()
String	getClass_() Member class names will be qualified with a '$' between each declaring class name and member class name.
String	getDefaultPackage() Return the managed type's default package, as set in its entity mappings.
JavaManagedType	getJavaManagedType() Return the Java managed type that is referred to by the orm.xml managed type.
EntityMappings	getParent() Return the JPA node's parent.
Class<? extends OrmManagedType>	getType() Return the managed type's type.
org.eclipse.jpt.jpa.core.resource.orm.XmlManagedType	getXmlManagedType()
int	getXmlSequence() Managed types are in a sequence in the orm schema.
void	removeXmlManagedTypeFrom(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings) Remove the managed type's XML managed type from the appropriate list in the specified XML entity mappings.
void	setClass(String class_)

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

getJavaResourceType, getName, getSimpleName, getTypeQualifiedName, isFor, isIn

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

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

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

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

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

createDeleteTypeEdits

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

createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits

Field Detail

CLASS_PROPERTY

static final String CLASS_PROPERTY

See Also:

Constant Field Values

JAVA_MANAGED_TYPE_PROPERTY

static final String JAVA_MANAGED_TYPE_PROPERTY

See Also:

Constant Field Values

Method Detail

getClass_

String getClass_()

Member class names will be qualified with a '$' between each declaring class name and member class name. NB: This may be an unqualified name to be prefixed by the entity mappings's 'package' value.

See Also:

EntityMappings.getPackage()

setClass

void setClass(String class_)

See Also:

getClass_()

getParent

EntityMappings getParent()

Description copied from interface: JpaNode

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JpaContextNode

Specified by:

getParent in interface JpaNode

getXmlManagedType

org.eclipse.jpt.jpa.core.resource.orm.XmlManagedType getXmlManagedType()

getType

Class<? extends OrmManagedType> getType()

Return the managed type's type.

Specified by:

getType in interface ManagedType

See Also:

OrmManagedTypeDefinition.getContextType(), JavaManagedTypeDefinition.getType()

getXmlSequence

int getXmlSequence()

Managed types are in a sequence in the orm schema. We must keep the list of managed in the appropriate order so the wtp xml translators will write them to the xml in that order and they will adhere to the schema.

Each concrete implementation must implement this method and return an int that matches its order in the schema.

addXmlManagedTypeTo

void addXmlManagedTypeTo(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings)

Add the managed type's XML managed type to the appropriate list in the specified XML entity mappings.

removeXmlManagedTypeFrom

void removeXmlManagedTypeFrom(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings)

Remove the managed type's XML managed type from the appropriate list in the specified XML entity mappings.

getJavaManagedType

JavaManagedType getJavaManagedType()

Return the Java managed type that is referred to by the orm.xml managed type. Return null if it is missing.

getDefaultPackage

String getDefaultPackage()

Return the managed type's default package, as set in its entity mappings.

dispose

void dispose()