org.eclipse.jpt.jpa.core
Interface JpaFactory

All Known Subinterfaces:

JpaFactory2_0

public interface JpaFactory

Use a JPA factory to build any core (e.g. JpaProject) model object or any Java (e.g. JavaEntity), ORM (e.g. EntityMappings), or persistence (e.g. PersistenceUnit) context model objects.

Assumes a base JPA project context structure corresponding to the JPA spec:

• RootContext
  • persistence.xml
    • persistence unit(s)
      • mapping file(s) (e.g. orm.xml)
        • type mapping(s) (e.g. Entity)
          • attribute mapping(s) (e.g. Basic)
      • type mapping(s)

... and associated objects.

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

See Also:

GenericJpaFactory

Method Summary

JpaContextModelRoot	buildContextModelRoot(JpaProject jpaProject) Build a (/an updated) context model root for the specified JPA project.
JavaSpecifiedAssociationOverride	buildJavaAssociationOverride(JavaAssociationOverrideContainer parent, AssociationOverrideAnnotation annotation)
JavaAssociationOverrideContainer	buildJavaAssociationOverrideContainer(JavaAssociationOverrideContainer.ParentAdapter parentAdapter)
JavaSpecifiedAttributeOverride	buildJavaAttributeOverride(JavaAttributeOverrideContainer parent, AttributeOverrideAnnotation annotation)
JavaAttributeOverrideContainer	buildJavaAttributeOverrideContainer(JavaAttributeOverrideContainer.ParentAdapter parentAdapter)
JavaBaseEnumeratedConverter	buildJavaBaseEnumeratedConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter, BaseEnumeratedAnnotation annotation)
JavaBaseTemporalConverter	buildJavaBaseTemporalConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter, BaseTemporalAnnotation annotation)
JavaBasicMapping	buildJavaBasicMapping(JavaSpecifiedPersistentAttribute parent)
JavaSpecifiedColumn	buildJavaColumn(JavaSpecifiedColumn.ParentAdapter parentAdapter)
JavaSpecifiedDiscriminatorColumn	buildJavaDiscriminatorColumn(JavaSpecifiedDiscriminatorColumn.ParentAdapter parentAdapter)
JavaEmbeddable	buildJavaEmbeddable(JavaPersistentType parent, EmbeddableAnnotation embeddableAnnotation)
JavaEmbeddedIdMapping	buildJavaEmbeddedIdMapping(JavaSpecifiedPersistentAttribute parent)
JavaEmbeddedMapping	buildJavaEmbeddedMapping(JavaSpecifiedPersistentAttribute parent)
JavaEntity	buildJavaEntity(JavaPersistentType parent, EntityAnnotation entityAnnotation)
JavaGeneratedValue	buildJavaGeneratedValue(JavaAttributeMapping parent, GeneratedValueAnnotation generatedValueAnnotation)
JavaGeneratorContainer	buildJavaGeneratorContainer(JavaGeneratorContainer.Parent parentAdapter)
JavaIdMapping	buildJavaIdMapping(JavaSpecifiedPersistentAttribute parent)
JavaSpecifiedJoinColumn	buildJavaJoinColumn(JoinColumn.ParentAdapter parentAdapter, CompleteJoinColumnAnnotation joinColumnAnnotation)
JavaSpecifiedJoinTable	buildJavaJoinTable(JavaSpecifiedJoinTable.ParentAdapter parentAdapter)
JavaLobConverter	buildJavaLobConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter, LobAnnotation annotation)
JavaManyToManyMapping	buildJavaManyToManyMapping(JavaSpecifiedPersistentAttribute parent)
JavaManyToOneMapping	buildJavaManyToOneMapping(JavaSpecifiedPersistentAttribute parent)
JavaMappedSuperclass	buildJavaMappedSuperclass(JavaPersistentType parent, MappedSuperclassAnnotation mappedSuperclassAnnotation)
JavaNamedNativeQuery	buildJavaNamedNativeQuery(JavaQueryContainer parent, NamedNativeQueryAnnotation namedNativeQueryAnnotation)
JavaNamedQuery	buildJavaNamedQuery(JavaQueryContainer parent, NamedQueryAnnotation namedQueryAnnotation)
JavaAttributeMapping	buildJavaNullAttributeMapping(JavaSpecifiedPersistentAttribute parent)
JavaTypeMapping	buildJavaNullTypeMapping(JavaPersistentType parent)
JavaOneToManyMapping	buildJavaOneToManyMapping(JavaSpecifiedPersistentAttribute parent)
JavaOneToOneMapping	buildJavaOneToOneMapping(JavaSpecifiedPersistentAttribute parent)
Orderable	buildJavaOrderable(JavaAttributeMapping parent)
JavaSpecifiedOverrideRelationship	buildJavaOverrideRelationship(JavaSpecifiedAssociationOverride parent)
JavaSpecifiedPersistentAttribute	buildJavaPersistentAttribute(PersistentType parent, Accessor accessor)
JavaSpecifiedPersistentAttribute	buildJavaPersistentField(PersistentType parent, JavaResourceField resourceField)
JavaSpecifiedPersistentAttribute	buildJavaPersistentProperty(PersistentType parent, JavaResourceMethod resourceGetter, JavaResourceMethod resourceSetter)
JavaPersistentType	buildJavaPersistentType(PersistentType.Parent parent, JavaResourceType jrt)
JavaSpecifiedPrimaryKeyJoinColumn	buildJavaPrimaryKeyJoinColumn(BaseJoinColumn.ParentAdapter parentAdapter, PrimaryKeyJoinColumnAnnotation pkJoinColumnAnnotation)
JavaQueryContainer	buildJavaQueryContainer(JavaQueryContainer.Parent parent)
JavaQueryHint	buildJavaQueryHint(JavaQuery parent, QueryHintAnnotation queryHintAnnotation)
JavaSpecifiedSecondaryTable	buildJavaSecondaryTable(JavaSpecifiedSecondaryTable.ParentAdapter parentAdapter, SecondaryTableAnnotation tableAnnotation)
JavaSequenceGenerator	buildJavaSequenceGenerator(JavaGeneratorContainer parent, SequenceGeneratorAnnotation sequenceGeneratorAnnotation)
JavaSpecifiedTable	buildJavaTable(JavaTable.ParentAdapter parentAdapter)
JavaTableGenerator	buildJavaTableGenerator(JavaGeneratorContainer parent, TableGeneratorAnnotation tableGeneratorAnnotation)
JavaTransientMapping	buildJavaTransientMapping(JavaSpecifiedPersistentAttribute parent)
JavaSpecifiedUniqueConstraint	buildJavaUniqueConstraint(SpecifiedUniqueConstraint.Parent parent, UniqueConstraintAnnotation constraintAnnotation)
JavaVersionMapping	buildJavaVersionMapping(JavaSpecifiedPersistentAttribute parent)
JavaVirtualAssociationOverride	buildJavaVirtualAssociationOverride(JavaAssociationOverrideContainer parent, String name)
JavaVirtualAttributeOverride	buildJavaVirtualAttributeOverride(JavaAttributeOverrideContainer parent, String name)
VirtualColumn	buildJavaVirtualColumn(VirtualColumn.ParentAdapter parentAdapter)
VirtualJoinColumn	buildJavaVirtualJoinColumn(JoinColumn.ParentAdapter parentAdapter, JoinColumn overriddenColumn)
VirtualJoinTable	buildJavaVirtualJoinTable(VirtualJoinTable.ParentAdapter parentAdapter, JoinTable overriddenTable)
VirtualOverrideRelationship	buildJavaVirtualOverrideRelationship(JavaVirtualAssociationOverride parent)
VirtualUniqueConstraint	buildJavaVirtualUniqueConstraint(JpaContextModel parent, UniqueConstraint overriddenUniqueConstraint)
JpaDataSource	buildJpaDataSource(JpaProject jpaProject, String connectionProfileName)
JpaFile	buildJpaFile(JpaProject jpaProject, IFile file, IContentType contentType, JptResourceModel resourceModel) Construct a JPA file for the specified JPA project, file, content type, and resource model.
JpaProject	buildJpaProject(JpaProject.Config config) Construct a JpaProject for the specified config, to be added to the specified JPA project.
MappingFile	buildMappingFile(MappingFileRef parent, Object resourceMappingFile)
PersistenceXml	buildPersistenceXml(JpaContextModelRoot parent, JptXmlResource resource)

Method Detail

buildJpaProject

JpaProject buildJpaProject(JpaProject.Config config)

Construct a JpaProject for the specified config, to be added to the specified JPA project. Return null if unable to create the JPA file (e.g. the content type is unrecognized).

buildJpaDataSource

JpaDataSource buildJpaDataSource(JpaProject jpaProject,
                                 String connectionProfileName)

buildJpaFile

JpaFile buildJpaFile(JpaProject jpaProject,
                     IFile file,
                     IContentType contentType,
                     JptResourceModel resourceModel)

Construct a JPA file for the specified JPA project, file, content type, and resource model.

buildContextModelRoot

JpaContextModelRoot buildContextModelRoot(JpaProject jpaProject)

Build a (/an updated) context model root for the specified JPA project. The root will be built once, but updated many times.

See Also:

AbstractJpaProject.update(org.eclipse.core.runtime.IProgressMonitor)

buildPersistenceXml

PersistenceXml buildPersistenceXml(JpaContextModelRoot parent,
                                   JptXmlResource resource)

buildMappingFile

MappingFile buildMappingFile(MappingFileRef parent,
                             Object resourceMappingFile)

buildJavaPersistentType

JavaPersistentType buildJavaPersistentType(PersistentType.Parent parent,
                                           JavaResourceType jrt)

buildJavaEntity

JavaEntity buildJavaEntity(JavaPersistentType parent,
                           EntityAnnotation entityAnnotation)

buildJavaMappedSuperclass

JavaMappedSuperclass buildJavaMappedSuperclass(JavaPersistentType parent,
                                               MappedSuperclassAnnotation mappedSuperclassAnnotation)

buildJavaEmbeddable

JavaEmbeddable buildJavaEmbeddable(JavaPersistentType parent,
                                   EmbeddableAnnotation embeddableAnnotation)

buildJavaNullTypeMapping

JavaTypeMapping buildJavaNullTypeMapping(JavaPersistentType parent)

buildJavaPersistentAttribute

JavaSpecifiedPersistentAttribute buildJavaPersistentAttribute(PersistentType parent,
                                                              Accessor accessor)

buildJavaPersistentField

JavaSpecifiedPersistentAttribute buildJavaPersistentField(PersistentType parent,
                                                          JavaResourceField resourceField)

buildJavaPersistentProperty

JavaSpecifiedPersistentAttribute buildJavaPersistentProperty(PersistentType parent,
                                                             JavaResourceMethod resourceGetter,
                                                             JavaResourceMethod resourceSetter)

buildJavaBasicMapping

JavaBasicMapping buildJavaBasicMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaEmbeddedIdMapping

JavaEmbeddedIdMapping buildJavaEmbeddedIdMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaEmbeddedMapping

JavaEmbeddedMapping buildJavaEmbeddedMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaIdMapping

JavaIdMapping buildJavaIdMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaManyToManyMapping

JavaManyToManyMapping buildJavaManyToManyMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaManyToOneMapping

JavaManyToOneMapping buildJavaManyToOneMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaOneToManyMapping

JavaOneToManyMapping buildJavaOneToManyMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaOneToOneMapping

JavaOneToOneMapping buildJavaOneToOneMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaTransientMapping

JavaTransientMapping buildJavaTransientMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaVersionMapping

JavaVersionMapping buildJavaVersionMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaNullAttributeMapping

JavaAttributeMapping buildJavaNullAttributeMapping(JavaSpecifiedPersistentAttribute parent)

buildJavaGeneratorContainer

JavaGeneratorContainer buildJavaGeneratorContainer(JavaGeneratorContainer.Parent parentAdapter)

buildJavaTable

JavaSpecifiedTable buildJavaTable(JavaTable.ParentAdapter parentAdapter)

buildJavaJoinTable

JavaSpecifiedJoinTable buildJavaJoinTable(JavaSpecifiedJoinTable.ParentAdapter parentAdapter)

buildJavaVirtualJoinTable

VirtualJoinTable buildJavaVirtualJoinTable(VirtualJoinTable.ParentAdapter parentAdapter,
                                           JoinTable overriddenTable)

buildJavaColumn

JavaSpecifiedColumn buildJavaColumn(JavaSpecifiedColumn.ParentAdapter parentAdapter)

buildJavaVirtualColumn

VirtualColumn buildJavaVirtualColumn(VirtualColumn.ParentAdapter parentAdapter)

buildJavaDiscriminatorColumn

JavaSpecifiedDiscriminatorColumn buildJavaDiscriminatorColumn(JavaSpecifiedDiscriminatorColumn.ParentAdapter parentAdapter)

buildJavaJoinColumn

JavaSpecifiedJoinColumn buildJavaJoinColumn(JoinColumn.ParentAdapter parentAdapter,
                                            CompleteJoinColumnAnnotation joinColumnAnnotation)

buildJavaVirtualJoinColumn

VirtualJoinColumn buildJavaVirtualJoinColumn(JoinColumn.ParentAdapter parentAdapter,
                                             JoinColumn overriddenColumn)

buildJavaSecondaryTable

JavaSpecifiedSecondaryTable buildJavaSecondaryTable(JavaSpecifiedSecondaryTable.ParentAdapter parentAdapter,
                                                    SecondaryTableAnnotation tableAnnotation)

buildJavaSequenceGenerator

JavaSequenceGenerator buildJavaSequenceGenerator(JavaGeneratorContainer parent,
                                                 SequenceGeneratorAnnotation sequenceGeneratorAnnotation)

buildJavaTableGenerator

JavaTableGenerator buildJavaTableGenerator(JavaGeneratorContainer parent,
                                           TableGeneratorAnnotation tableGeneratorAnnotation)

buildJavaGeneratedValue

JavaGeneratedValue buildJavaGeneratedValue(JavaAttributeMapping parent,
                                           GeneratedValueAnnotation generatedValueAnnotation)

buildJavaPrimaryKeyJoinColumn

JavaSpecifiedPrimaryKeyJoinColumn buildJavaPrimaryKeyJoinColumn(BaseJoinColumn.ParentAdapter parentAdapter,
                                                                PrimaryKeyJoinColumnAnnotation pkJoinColumnAnnotation)

buildJavaAttributeOverrideContainer

JavaAttributeOverrideContainer buildJavaAttributeOverrideContainer(JavaAttributeOverrideContainer.ParentAdapter parentAdapter)

buildJavaAttributeOverride

JavaSpecifiedAttributeOverride buildJavaAttributeOverride(JavaAttributeOverrideContainer parent,
                                                          AttributeOverrideAnnotation annotation)

buildJavaVirtualAttributeOverride

JavaVirtualAttributeOverride buildJavaVirtualAttributeOverride(JavaAttributeOverrideContainer parent,
                                                               String name)

buildJavaAssociationOverrideContainer

JavaAssociationOverrideContainer buildJavaAssociationOverrideContainer(JavaAssociationOverrideContainer.ParentAdapter parentAdapter)

buildJavaAssociationOverride

JavaSpecifiedAssociationOverride buildJavaAssociationOverride(JavaAssociationOverrideContainer parent,
                                                              AssociationOverrideAnnotation annotation)

buildJavaVirtualAssociationOverride

JavaVirtualAssociationOverride buildJavaVirtualAssociationOverride(JavaAssociationOverrideContainer parent,
                                                                   String name)

buildJavaOverrideRelationship

JavaSpecifiedOverrideRelationship buildJavaOverrideRelationship(JavaSpecifiedAssociationOverride parent)

buildJavaVirtualOverrideRelationship

VirtualOverrideRelationship buildJavaVirtualOverrideRelationship(JavaVirtualAssociationOverride parent)

buildJavaQueryContainer

JavaQueryContainer buildJavaQueryContainer(JavaQueryContainer.Parent parent)

buildJavaNamedQuery

JavaNamedQuery buildJavaNamedQuery(JavaQueryContainer parent,
                                   NamedQueryAnnotation namedQueryAnnotation)

buildJavaNamedNativeQuery

JavaNamedNativeQuery buildJavaNamedNativeQuery(JavaQueryContainer parent,
                                               NamedNativeQueryAnnotation namedNativeQueryAnnotation)

buildJavaQueryHint

JavaQueryHint buildJavaQueryHint(JavaQuery parent,
                                 QueryHintAnnotation queryHintAnnotation)

buildJavaUniqueConstraint

JavaSpecifiedUniqueConstraint buildJavaUniqueConstraint(SpecifiedUniqueConstraint.Parent parent,
                                                        UniqueConstraintAnnotation constraintAnnotation)

buildJavaVirtualUniqueConstraint

VirtualUniqueConstraint buildJavaVirtualUniqueConstraint(JpaContextModel parent,
                                                         UniqueConstraint overriddenUniqueConstraint)

buildJavaBaseEnumeratedConverter

JavaBaseEnumeratedConverter buildJavaBaseEnumeratedConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter,
                                                             BaseEnumeratedAnnotation annotation)

buildJavaBaseTemporalConverter

JavaBaseTemporalConverter buildJavaBaseTemporalConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter,
                                                         BaseTemporalAnnotation annotation)

buildJavaLobConverter

JavaLobConverter buildJavaLobConverter(Converter.ParentAdapter<JavaAttributeMapping> parentAdapter,
                                       LobAnnotation annotation)

buildJavaOrderable

Orderable buildJavaOrderable(JavaAttributeMapping parent)