org.eclipse.jpt.jpa.core.context
Interface JpaContextModel

All Superinterfaces:

IAdaptable, JpaModel, JptResourceTypeReference, Model

All Known Subinterfaces:

Accessor, AccessReference, AssociationOverride, AssociationOverride2_0, AssociationOverrideContainer, AssociationOverrideContainer2_0, AttributeMapping, AttributeMapping2_0, AttributeOverride, AttributeOverrideContainer, BaseColumn, BaseEmbeddedMapping, BaseEnumeratedConverter, BaseJoinColumn, BaseTemporalConverter, BasicMapping, Cacheable2_0, CacheableReference2_0, Cascade, Cascade2_0, ClassRef, CollectionMapping, CollectionMapping2_0, CollectionTable2_0, Column, ColumnMapping, Converter, ConvertibleKeyMapping2_0, ConvertibleMapping, DatabaseGenerator, DerivableIdMapping2_0, DerivedIdentity2_0, DerivedIdentityStrategy2_0, EclipseLinkArrayMapping2_3, EclipseLinkBasicCollectionMapping, EclipseLinkBasicMapMapping, EclipseLinkBasicMapping, EclipseLinkCaching, EclipseLinkChangeTracking, EclipseLinkConversionValue, EclipseLinkConvert, EclipseLinkConverter, EclipseLinkConverterClassConverter, EclipseLinkConverterContainer, EclipseLinkCustomConverter, EclipseLinkCustomizer, EclipseLinkElementCollectionMapping2_0, EclipseLinkEmbeddable, EclipseLinkEntity, EclipseLinkEntityMappings, EclipseLinkGeneratorContainer, EclipseLinkIdMapping, EclipseLinkIdMapping2_0, EclipseLinkJavaCaching, EclipseLinkJavaConverterContainer, EclipseLinkJavaConverterContainer.Parent, EclipseLinkJavaConvertibleMapping, EclipseLinkJavaEmbeddable, EclipseLinkJavaEntity, EclipseLinkJavaMappedSuperclass, EclipseLinkJavaMultitenancy2_3, EclipseLinkJavaNonEmbeddableTypeMapping, EclipseLinkJavaOneToManyRelationship, EclipseLinkJavaOneToManyRelationship2_0, EclipseLinkJavaSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkJavaTypeMapping, EclipseLinkJavaUuidGenerator, EclipseLinkJoinFetch, EclipseLinkJoinFetchMapping, EclipseLinkManyToManyMapping, EclipseLinkManyToManyMapping2_0, EclipseLinkManyToOneMapping, EclipseLinkManyToOneMapping2_0, EclipseLinkMappedSuperclass, EclipseLinkMultitenancy2_3, EclipseLinkMutable, EclipseLinkNonEmbeddableTypeMapping, EclipseLinkObjectTypeConverter, EclipseLinkOneToManyMapping, EclipseLinkOneToManyMapping2_0, EclipseLinkOneToManyRelationship, EclipseLinkOneToManyRelationship2_0, EclipseLinkOneToOneMapping, EclipseLinkOneToOneMapping2_0, EclipseLinkOrmConverterContainer, EclipseLinkOrmConverterContainer.Parent, EclipseLinkOrmConvertibleMapping, EclipseLinkOrmEmbeddable, EclipseLinkOrmEntity, EclipseLinkOrmMappedSuperclass, EclipseLinkOrmMultitenancy2_3, EclipseLinkOrmNonEmbeddableTypeMapping, EclipseLinkOrmOneToManyRelationship, EclipseLinkOrmOneToManyRelationship2_0, EclipseLinkOrmPersistentType, EclipseLinkOrmSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkOrmTypeMapping, EclipseLinkOrmUuidGenerator, EclipseLinkPersistenceUnitDefaults, EclipseLinkPrivateOwned, EclipseLinkReadOnly, EclipseLinkRelationshipMapping, EclipseLinkSpecifiedTenantDiscriminatorColumn2_3, EclipseLinkStructConverter, EclipseLinkStructureMapping2_3, EclipseLinkTenantDiscriminatorColumn2_3, EclipseLinkTimeOfDay, EclipseLinkTransformationMapping, EclipseLinkTypeConverter, EclipseLinkTypeMapping, EclipseLinkUuidGenerator, EclipseLinkVariableOneToOneMapping, EclipseLinkVersionMapping, EclipseLinkVirtualTenantDiscriminatorColumn2_3, ElementCollectionMapping2_0, Embeddable, EmbeddedIdMapping, EmbeddedIdMapping2_0, EmbeddedMapping, EmbeddedMapping2_0, Entity, EntityMappings, FetchableMapping, GeneratedValue, GeneratedValueMapping, Generator, GeneratorContainer, IdClassReference, IdDerivedIdentityStrategy2_0, IdMapping, IdMapping2_0, IdTypeMapping, JarFile, JarFileRef, JavaAssociationOverrideContainer, JavaAssociationOverrideContainer2_0, JavaAttributeMapping, JavaAttributeOverrideContainer, JavaAttributeOverrideContainer2_0, JavaBaseEmbeddedMapping, JavaBaseEnumeratedConverter, JavaBaseTemporalConverter, JavaBasicMapping, JavaCacheableReference2_0, JavaCollectionMapping2_0, JavaCollectionTable2_0, JavaColumnMapping, JavaConverter, JavaConvertibleKeyMapping2_0, JavaConvertibleMapping, JavaDatabaseGenerator, JavaDerivedIdentity2_0, JavaElementCollectionMapping2_0, JavaEmbeddable, JavaEmbeddedIdMapping, JavaEmbeddedMapping, JavaEmbeddedMapping2_0, JavaEntity, JavaEntity2_0, JavaGeneratedValue, JavaGeneratedValueMapping, JavaGenerator, JavaGeneratorContainer, JavaGeneratorContainer.Parent, JavaIdClassReference, JavaIdMapping, JavaIdTypeMapping, JavaJoinColumnRelationship, JavaJoinTableRelationship, JavaLobConverter, JavaManagedType, JavaManyToManyMapping, JavaManyToManyRelationship, JavaManyToOneMapping, JavaManyToOneRelationship, JavaManyToOneRelationship2_0, JavaMappedByRelationship, JavaMappedSuperclass, JavaMappingJoinColumnRelationship, JavaMappingJoinTableRelationship, JavaMappingRelationship, JavaNamedNativeQuery, JavaNamedQuery, JavaNamedQuery2_0, JavaOneToManyMapping, JavaOneToManyRelationship, JavaOneToManyRelationship2_0, JavaOneToOneMapping, JavaOneToOneRelationship, JavaOneToOneRelationship2_0, JavaOrderable2_0, JavaOverrideContainer, JavaOverrideContainer2_0, JavaPersistentAttribute, JavaPersistentType, JavaPrimaryKeyJoinColumnRelationship, JavaQuery, JavaQueryContainer, JavaQueryContainer.Parent, JavaQueryHint, JavaRelationshipMapping, JavaSequenceGenerator, JavaSequenceGenerator2_0, JavaSingleRelationshipMapping, JavaSingleRelationshipMapping2_0, JavaSpecifiedAssociationOverride, JavaSpecifiedAssociationOverride2_0, JavaSpecifiedAttributeOverride, JavaSpecifiedBaseColumn, JavaSpecifiedBaseJoinColumn, JavaSpecifiedColumn, JavaSpecifiedDiscriminatorColumn, JavaSpecifiedJoinColumn, JavaSpecifiedJoinColumnRelationshipStrategy, JavaSpecifiedJoinTable, JavaSpecifiedJoinTableRelationshipStrategy, JavaSpecifiedNamedColumn, JavaSpecifiedOrderColumn2_0, JavaSpecifiedOverride, JavaSpecifiedOverrideRelationship, JavaSpecifiedOverrideRelationship2_0, JavaSpecifiedPersistentAttribute, JavaSpecifiedPrimaryKeyJoinColumn, JavaSpecifiedPrimaryKeyJoinColumnRelationshipStrategy, JavaSpecifiedReferenceTable, JavaSpecifiedSecondaryTable, JavaSpecifiedTable, JavaSpecifiedUniqueConstraint, JavaTable, JavaTableGenerator, JavaTransientMapping, JavaTypeMapping, JavaVersionMapping, JavaVirtualAssociationOverride, JavaVirtualAttributeOverride, JavaVirtualOverride, JoinColumn, JoinColumnRelationship, JoinColumnRelationshipStrategy, JoinTable, JoinTableRelationship, JoinTableRelationshipStrategy, JpaContextRoot, JpaContextRoot2_0, JpaNamedContextModel, JpaStructureNode, LobConverter, ManagedType, ManyToManyMapping, ManyToManyMapping2_0, ManyToManyRelationship, ManyToOneMapping, ManyToOneMapping2_0, ManyToOneRelationship, ManyToOneRelationship2_0, MappedByRelationship, MappedSuperclass, MappingFile, MappingFile.Root, MappingFilePersistenceUnitDefaults, MappingFilePersistenceUnitDefaults2_0, MappingFilePersistenceUnitMetadata, MappingFilePersistenceUnitMetadata2_0, MappingFileRef, MappingRelationship, MapsIdDerivedIdentityStrategy2_0, MultiRelationshipMapping, MultiRelationshipMapping2_0, NamedColumn, NamedDiscriminatorColumn, NamedNativeQuery, NamedQuery, NamedQuery2_0, OneToManyMapping, OneToManyMapping2_0, OneToManyRelationship, OneToManyRelationship2_0, OneToOneMapping, OneToOneMapping2_0, OneToOneRelationship, OneToOneRelationship2_0, OptionalMapping, Orderable, Orderable2_0, OrderBy, OrmAssociationOverrideContainer, OrmAssociationOverrideContainer2_0, OrmAttributeMapping, OrmAttributeOverrideContainer, OrmBaseEmbeddedMapping, OrmBaseEnumeratedConverter, OrmBaseTemporalConverter, OrmBasicMapping, OrmCacheableReference2_0, OrmCascade, OrmCascade2_0, OrmCollectionMapping2_0, OrmCollectionTable2_0, OrmColumnMapping, OrmConverter, OrmConvertibleKeyMapping2_0, OrmConvertibleMapping, OrmDerivedIdentity2_0, OrmElementCollectionMapping2_0, OrmEmbeddable, OrmEmbeddedIdMapping, OrmEmbeddedMapping, OrmEmbeddedMapping2_0, OrmEntity, OrmEntity2_0, OrmGeneratedValue, OrmGeneratedValueMapping, OrmGenerator, OrmGeneratorContainer, OrmIdClassReference, OrmIdDerivedIdentityStrategy2_0, OrmIdMapping, OrmIdTypeMapping, OrmJoinColumnRelationship, OrmJoinTableRelationship, OrmLobConverter, OrmManagedType, OrmManyToManyMapping, OrmManyToManyRelationship, OrmManyToOneMapping, OrmManyToOneRelationship, OrmManyToOneRelationship2_0, OrmMappedByRelationship, OrmMappedSuperclass, OrmMappingJoinColumnRelationship, OrmMappingJoinTableRelationship, OrmMappingRelationship, OrmMapsIdDerivedIdentityStrategy2_0, OrmMultiRelationshipMapping, OrmNamedNativeQuery, OrmNamedQuery, OrmNamedQuery2_0, OrmOneToManyMapping, OrmOneToManyRelationship, OrmOneToManyRelationship2_0, OrmOneToOneMapping, OrmOneToOneRelationship, OrmOneToOneRelationship2_0, OrmOrderable2_0, OrmOverrideContainer, OrmPersistenceUnitDefaults, OrmPersistenceUnitDefaults2_0, OrmPersistenceUnitMetadata, OrmPersistenceUnitMetadata2_0, OrmPersistentAttribute, OrmPersistentType, OrmPrimaryKeyJoinColumnRelationship, OrmQuery, OrmQueryContainer, OrmQueryHint, OrmRelationshipMapping, OrmSequenceGenerator, OrmSequenceGenerator2_0, OrmSingleRelationshipMapping, OrmSingleRelationshipMapping2_0, OrmSpecifiedAssociationOverride, OrmSpecifiedAssociationOverride2_0, OrmSpecifiedAttributeOverride, OrmSpecifiedBaseColumn, OrmSpecifiedBaseJoinColumn, OrmSpecifiedColumn, OrmSpecifiedDiscriminatorColumn, OrmSpecifiedJoinColumn, OrmSpecifiedJoinColumnRelationshipStrategy, OrmSpecifiedJoinTable, OrmSpecifiedJoinTableRelationshipStrategy, OrmSpecifiedMappedByRelationshipStrategy, OrmSpecifiedNamedColumn, OrmSpecifiedOrderColumn2_0, OrmSpecifiedOverride, OrmSpecifiedOverrideRelationship, OrmSpecifiedOverrideRelationship2_0, OrmSpecifiedPersistentAttribute, OrmSpecifiedPrimaryKeyJoinColumn, OrmSpecifiedPrimaryKeyJoinColumnRelationshipStrategy, OrmSpecifiedReferenceTable, OrmSpecifiedSecondaryTable, OrmSpecifiedTable, OrmSpecifiedUniqueConstraint, OrmTable, OrmTableGenerator, OrmTransientMapping, OrmTypeMapping, OrmVersionMapping, OrmVirtualAssociationOverride, OrmVirtualAttributeOverride, OrmVirtualOverride, OrmVirtualPrimaryKeyJoinColumn, OrmVirtualSecondaryTable, OrmXml, OrphanRemovable2_0, OrphanRemovalMapping2_0, Override_, OverrideContainer, OverrideRelationship, OverrideRelationship2_0, Persistence, Persistence2_0, PersistenceUnit, PersistenceUnit.Property, PersistenceUnit2_0, PersistenceXml, PersistenceXml2_0, PersistentAttribute, PersistentAttribute2_0, PersistentType, PersistentType.Parent, PersistentType2_0, PrimaryKeyJoinColumn, PrimaryKeyJoinColumnRelationship, Query, QueryContainer, QueryHint, ReferenceTable, Relationship, RelationshipMapping, RelationshipMapping2_0, RelationshipStrategy, SecondaryTable, SequenceGenerator, SequenceGenerator2_0, SingleRelationshipMapping, SingleRelationshipMapping2_0, SpecifiedAccessReference, SpecifiedAssociationOverride, SpecifiedAttributeOverride, SpecifiedBaseColumn, SpecifiedBaseJoinColumn, SpecifiedColumn, SpecifiedDiscriminatorColumn, SpecifiedJoinColumn, SpecifiedJoinColumnRelationship, SpecifiedJoinColumnRelationshipStrategy, SpecifiedJoinTable, SpecifiedJoinTableRelationship, SpecifiedJoinTableRelationshipStrategy, SpecifiedMappedByRelationshipStrategy, SpecifiedMappingRelationshipStrategy2_0, SpecifiedNamedColumn, SpecifiedNamedDiscriminatorColumn, SpecifiedOrderColumn2_0, SpecifiedOverride, SpecifiedOverrideRelationship, SpecifiedOverrideRelationship2_0, SpecifiedPersistentAttribute, SpecifiedPersistentAttribute2_0, SpecifiedPrimaryKeyJoinColumn, SpecifiedPrimaryKeyJoinColumnRelationshipStrategy, SpecifiedReferenceTable, SpecifiedRelationship, SpecifiedRelationshipStrategy, SpecifiedSecondaryTable, SpecifiedTable, SpecifiedTableColumn, SpecifiedUniqueConstraint, SpecifiedUniqueConstraint.Parent, Table, TableColumn, TableGenerator, TransientMapping, TypeMapping, UniqueConstraint, VersionMapping, VirtualAssociationOverride, VirtualAttributeOverride, VirtualBaseColumn, VirtualBaseJoinColumn, VirtualColumn, VirtualJoinColumn, VirtualJoinColumnRelationship, VirtualJoinColumnRelationshipStrategy, VirtualJoinTable, VirtualJoinTableRelationship, VirtualJoinTableRelationshipStrategy, VirtualNamedColumn, VirtualNamedDiscriminatorColumn, VirtualOverride, VirtualOverrideRelationship, VirtualOverrideRelationship2_0, VirtualPrimaryKeyJoinColumn, VirtualReferenceTable, VirtualRelationship, VirtualRelationshipStrategy, VirtualSecondaryTable, VirtualTable, VirtualTableColumn, VirtualUniqueConstraint, XmlFile, XmlFile.Root

All Known Implementing Classes:

org.eclipse.jpt.jpa.core.internal.context.AbstractJpaContextModel, org.eclipse.jpt.jpa.core.internal.context.persistence.AbstractPersistenceUnit, org.eclipse.jpt.jpa.core.internal.context.persistence.AbstractPersistenceXmlContextModel, EclipseLinkPersistenceUnit

public interface JpaContextModel
extends JpaModel, JptResourceTypeReference

Common protocol for JPA models that have a context, as opposed to resource models.

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.0

Nested Class Summary

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

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

TRANSFORMER

Method Summary

Iterable<String>	getCompletionProposals(int pos) Return the content assist proposals for the specified position in the file.
Catalog	getContextDefaultDbCatalog()
Schema	getContextDefaultDbSchema()
SchemaContainer	getContextDefaultDbSchemaContainer()
MappingFile.Root	getMappingFileRoot() Return the mapping file root if the context model is within a mapping file.
JpaContextModel	getParent() Return the JPA node's parent.
PersistenceUnit	getPersistenceUnit() Return the persistence unit if the context model is within a persistence unit.
TextRange	getValidationTextRange()
void	synchronizeWithResourceModel() The resource model has changed; synchronize the context model with it.
void	update() Some non-trivial state in the JPA project has changed; update the state of the context model that is dependent on yet other parts of the model's JPA project.
void	validate(List<IMessage> messages, IReporter reporter) Add the model's validation messages to the specified "collecting parameter".

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

Method Detail

getPersistenceUnit

PersistenceUnit getPersistenceUnit()

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

getMappingFileRoot

MappingFile.Root getMappingFileRoot()

Return the mapping file root if the context model is within a mapping file. Otherwise throw an exception.

getParent

JpaContextModel getParent()

Description copied from interface: JpaModel

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

Specified by:

getParent in interface JpaModel

getContextDefaultDbSchemaContainer

SchemaContainer getContextDefaultDbSchemaContainer()

getContextDefaultDbCatalog

Catalog getContextDefaultDbCatalog()

getContextDefaultDbSchema

Schema getContextDefaultDbSchema()

getValidationTextRange

TextRange getValidationTextRange()

validate

void validate(List<IMessage> messages,
              IReporter reporter)

Add the model's validation messages to the specified "collecting parameter".

getCompletionProposals

Iterable<String> getCompletionProposals(int pos)

Return the content assist proposals for the specified position in the file.

synchronizeWithResourceModel

void synchronizeWithResourceModel()

The resource model has changed; synchronize the context model with it. This will probably trigger a call to update().

update

void update()

Some non-trivial state in the JPA project has changed; update the state of the context model that is dependent on yet other parts of the model's JPA project. If the dependent state changes also, yet another update will be triggered, possibly followed by yet more updates; until the JPA project's state quiesces.