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

JavaAssociationOverride	buildJavaAssociationOverride(JavaAssociationOverrideContainer parent, AssociationOverrideAnnotation annotation)
JavaAssociationOverrideContainer	buildJavaAssociationOverrideContainer(JpaContextNode parent, JavaAssociationOverrideContainer.Owner owner)
JavaAttributeOverride	buildJavaAttributeOverride(JavaAttributeOverrideContainer parent, AttributeOverrideAnnotation annotation)
JavaAttributeOverrideContainer	buildJavaAttributeOverrideContainer(JpaContextNode parent, JavaAttributeOverrideContainer.Owner owner)
JavaBaseEnumeratedConverter	buildJavaBaseEnumeratedConverter(JavaAttributeMapping parent, BaseEnumeratedAnnotation annotation, Converter.Owner owner)
JavaBaseTemporalConverter	buildJavaBaseTemporalConverter(JavaAttributeMapping parent, BaseTemporalAnnotation annotation, Converter.Owner owner)
JavaBasicMapping	buildJavaBasicMapping(JavaPersistentAttribute parent)
JavaColumn	buildJavaColumn(JpaContextNode parent, JavaColumn.Owner owner)
JavaDiscriminatorColumn	buildJavaDiscriminatorColumn(JavaEntity parent, ReadOnlyNamedDiscriminatorColumn.Owner owner)
JavaEmbeddable	buildJavaEmbeddable(JavaPersistentType parent, EmbeddableAnnotation embeddableAnnotation)
JavaEmbeddedIdMapping	buildJavaEmbeddedIdMapping(JavaPersistentAttribute parent)
JavaEmbeddedMapping	buildJavaEmbeddedMapping(JavaPersistentAttribute parent)
JavaEntity	buildJavaEntity(JavaPersistentType parent, EntityAnnotation entityAnnotation)
JavaGeneratedValue	buildJavaGeneratedValue(JavaAttributeMapping parent, GeneratedValueAnnotation generatedValueAnnotation)
JavaGeneratorContainer	buildJavaGeneratorContainer(JavaGeneratorContainer.ParentAdapter parentAdapter)
JavaIdMapping	buildJavaIdMapping(JavaPersistentAttribute parent)
JavaJoinColumn	buildJavaJoinColumn(JpaContextNode parent, ReadOnlyJoinColumn.Owner owner, CompleteJoinColumnAnnotation joinColumnAnnotation)
JavaJoinTable	buildJavaJoinTable(JavaJoinTableRelationshipStrategy parent, ReadOnlyTable.Owner owner)
JavaLobConverter	buildJavaLobConverter(JavaAttributeMapping parent, LobAnnotation annotation, Converter.Owner owner)
JavaManyToManyMapping	buildJavaManyToManyMapping(JavaPersistentAttribute parent)
JavaManyToOneMapping	buildJavaManyToOneMapping(JavaPersistentAttribute parent)
JavaMappedSuperclass	buildJavaMappedSuperclass(JavaPersistentType parent, MappedSuperclassAnnotation mappedSuperclassAnnotation)
JavaNamedNativeQuery	buildJavaNamedNativeQuery(JavaQueryContainer parent, NamedNativeQueryAnnotation namedNativeQueryAnnotation)
JavaNamedQuery	buildJavaNamedQuery(JavaQueryContainer parent, NamedQueryAnnotation namedQueryAnnotation)
JavaAttributeMapping	buildJavaNullAttributeMapping(JavaPersistentAttribute parent)
JavaTypeMapping	buildJavaNullTypeMapping(JavaPersistentType parent)
JavaOneToManyMapping	buildJavaOneToManyMapping(JavaPersistentAttribute parent)
JavaOneToOneMapping	buildJavaOneToOneMapping(JavaPersistentAttribute parent)
Orderable	buildJavaOrderable(JavaAttributeMapping parent)
JavaOverrideRelationship	buildJavaOverrideRelationship(JavaAssociationOverride parent)
JavaPersistentAttribute	buildJavaPersistentAttribute(PersistentType parent, Accessor accessor)
JavaPersistentAttribute	buildJavaPersistentField(PersistentType parent, JavaResourceField resourceField)
JavaPersistentAttribute	buildJavaPersistentProperty(PersistentType parent, JavaResourceMethod resourceGetter, JavaResourceMethod resourceSetter)
JavaPersistentType	buildJavaPersistentType(PersistentType.Owner owner, JavaResourceType jrt)
JavaPrimaryKeyJoinColumn	buildJavaPrimaryKeyJoinColumn(JpaContextNode parent, ReadOnlyBaseJoinColumn.Owner owner, PrimaryKeyJoinColumnAnnotation pkJoinColumnAnnotation)
JavaQueryContainer	buildJavaQueryContainer(JpaContextNode parent, JavaQueryContainer.Owner owner)
JavaQueryHint	buildJavaQueryHint(JavaQuery parent, QueryHintAnnotation queryHintAnnotation)
JavaSecondaryTable	buildJavaSecondaryTable(JavaEntity parent, ReadOnlyTable.Owner owner, SecondaryTableAnnotation tableAnnotation)
JavaSequenceGenerator	buildJavaSequenceGenerator(JavaGeneratorContainer parent, SequenceGeneratorAnnotation sequenceGeneratorAnnotation)
JavaTable	buildJavaTable(JavaEntity parent, ReadOnlyTable.Owner owner)
JavaTableGenerator	buildJavaTableGenerator(JavaGeneratorContainer parent, TableGeneratorAnnotation tableGeneratorAnnotation)
JavaTransientMapping	buildJavaTransientMapping(JavaPersistentAttribute parent)
JavaUniqueConstraint	buildJavaUniqueConstraint(JpaContextNode parent, ReadOnlyUniqueConstraint.Owner owner, UniqueConstraintAnnotation constraintAnnotation)
JavaVersionMapping	buildJavaVersionMapping(JavaPersistentAttribute parent)
JavaVirtualAssociationOverride	buildJavaVirtualAssociationOverride(JavaAssociationOverrideContainer parent, String name)
JavaVirtualAttributeOverride	buildJavaVirtualAttributeOverride(JavaAttributeOverrideContainer parent, String name)
VirtualColumn	buildJavaVirtualColumn(JpaContextNode parent, VirtualColumn.Owner owner)
VirtualJoinColumn	buildJavaVirtualJoinColumn(JpaContextNode parent, ReadOnlyJoinColumn.Owner owner, ReadOnlyJoinColumn overriddenColumn)
VirtualJoinTable	buildJavaVirtualJoinTable(VirtualJoinTableRelationshipStrategy parent, ReadOnlyTable.Owner owner, ReadOnlyJoinTable overriddenTable)
VirtualOverrideRelationship	buildJavaVirtualOverrideRelationship(JavaVirtualAssociationOverride parent)
VirtualUniqueConstraint	buildJavaVirtualUniqueConstraint(JpaContextNode parent, ReadOnlyUniqueConstraint 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(JpaRootContextNode parent, JptXmlResource resource)
JpaRootContextNode	buildRootContextNode(JpaProject jpaProject) Build a (/an updated) root context node to be associated with the given JPA project.

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.

buildRootContextNode

JpaRootContextNode buildRootContextNode(JpaProject jpaProject)

Build a (/an updated) root context node to be associated with the given JPA project. The root context node will be built once, but updated many times.

See Also:

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

buildPersistenceXml

PersistenceXml buildPersistenceXml(JpaRootContextNode parent,
                                   JptXmlResource resource)

buildMappingFile

MappingFile buildMappingFile(MappingFileRef parent,
                             Object resourceMappingFile)

buildJavaPersistentType

JavaPersistentType buildJavaPersistentType(PersistentType.Owner owner,
                                           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

JavaPersistentAttribute buildJavaPersistentAttribute(PersistentType parent,
                                                     Accessor accessor)

buildJavaPersistentField

JavaPersistentAttribute buildJavaPersistentField(PersistentType parent,
                                                 JavaResourceField resourceField)

buildJavaPersistentProperty

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

buildJavaBasicMapping

JavaBasicMapping buildJavaBasicMapping(JavaPersistentAttribute parent)

buildJavaEmbeddedIdMapping

JavaEmbeddedIdMapping buildJavaEmbeddedIdMapping(JavaPersistentAttribute parent)

buildJavaEmbeddedMapping

JavaEmbeddedMapping buildJavaEmbeddedMapping(JavaPersistentAttribute parent)

buildJavaIdMapping

JavaIdMapping buildJavaIdMapping(JavaPersistentAttribute parent)

buildJavaManyToManyMapping

JavaManyToManyMapping buildJavaManyToManyMapping(JavaPersistentAttribute parent)

buildJavaManyToOneMapping

JavaManyToOneMapping buildJavaManyToOneMapping(JavaPersistentAttribute parent)

buildJavaOneToManyMapping

JavaOneToManyMapping buildJavaOneToManyMapping(JavaPersistentAttribute parent)

buildJavaOneToOneMapping

JavaOneToOneMapping buildJavaOneToOneMapping(JavaPersistentAttribute parent)

buildJavaTransientMapping

JavaTransientMapping buildJavaTransientMapping(JavaPersistentAttribute parent)

buildJavaVersionMapping

JavaVersionMapping buildJavaVersionMapping(JavaPersistentAttribute parent)

buildJavaNullAttributeMapping

JavaAttributeMapping buildJavaNullAttributeMapping(JavaPersistentAttribute parent)

buildJavaGeneratorContainer

JavaGeneratorContainer buildJavaGeneratorContainer(JavaGeneratorContainer.ParentAdapter parentAdapter)

buildJavaTable

JavaTable buildJavaTable(JavaEntity parent,
                         ReadOnlyTable.Owner owner)

buildJavaJoinTable

JavaJoinTable buildJavaJoinTable(JavaJoinTableRelationshipStrategy parent,
                                 ReadOnlyTable.Owner owner)

buildJavaVirtualJoinTable

VirtualJoinTable buildJavaVirtualJoinTable(VirtualJoinTableRelationshipStrategy parent,
                                           ReadOnlyTable.Owner owner,
                                           ReadOnlyJoinTable overriddenTable)

buildJavaColumn

JavaColumn buildJavaColumn(JpaContextNode parent,
                           JavaColumn.Owner owner)

buildJavaVirtualColumn

VirtualColumn buildJavaVirtualColumn(JpaContextNode parent,
                                     VirtualColumn.Owner owner)

buildJavaDiscriminatorColumn

JavaDiscriminatorColumn buildJavaDiscriminatorColumn(JavaEntity parent,
                                                     ReadOnlyNamedDiscriminatorColumn.Owner owner)

buildJavaJoinColumn

JavaJoinColumn buildJavaJoinColumn(JpaContextNode parent,
                                   ReadOnlyJoinColumn.Owner owner,
                                   CompleteJoinColumnAnnotation joinColumnAnnotation)

buildJavaVirtualJoinColumn

VirtualJoinColumn buildJavaVirtualJoinColumn(JpaContextNode parent,
                                             ReadOnlyJoinColumn.Owner owner,
                                             ReadOnlyJoinColumn overriddenColumn)

buildJavaSecondaryTable

JavaSecondaryTable buildJavaSecondaryTable(JavaEntity parent,
                                           ReadOnlyTable.Owner owner,
                                           SecondaryTableAnnotation tableAnnotation)

buildJavaSequenceGenerator

JavaSequenceGenerator buildJavaSequenceGenerator(JavaGeneratorContainer parent,
                                                 SequenceGeneratorAnnotation sequenceGeneratorAnnotation)

buildJavaTableGenerator

JavaTableGenerator buildJavaTableGenerator(JavaGeneratorContainer parent,
                                           TableGeneratorAnnotation tableGeneratorAnnotation)

buildJavaGeneratedValue

JavaGeneratedValue buildJavaGeneratedValue(JavaAttributeMapping parent,
                                           GeneratedValueAnnotation generatedValueAnnotation)

buildJavaPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn buildJavaPrimaryKeyJoinColumn(JpaContextNode parent,
                                                       ReadOnlyBaseJoinColumn.Owner owner,
                                                       PrimaryKeyJoinColumnAnnotation pkJoinColumnAnnotation)

buildJavaAttributeOverrideContainer

JavaAttributeOverrideContainer buildJavaAttributeOverrideContainer(JpaContextNode parent,
                                                                   JavaAttributeOverrideContainer.Owner owner)

buildJavaAttributeOverride

JavaAttributeOverride buildJavaAttributeOverride(JavaAttributeOverrideContainer parent,
                                                 AttributeOverrideAnnotation annotation)

buildJavaVirtualAttributeOverride

JavaVirtualAttributeOverride buildJavaVirtualAttributeOverride(JavaAttributeOverrideContainer parent,
                                                               String name)

buildJavaAssociationOverrideContainer

JavaAssociationOverrideContainer buildJavaAssociationOverrideContainer(JpaContextNode parent,
                                                                       JavaAssociationOverrideContainer.Owner owner)

buildJavaAssociationOverride

JavaAssociationOverride buildJavaAssociationOverride(JavaAssociationOverrideContainer parent,
                                                     AssociationOverrideAnnotation annotation)

buildJavaVirtualAssociationOverride

JavaVirtualAssociationOverride buildJavaVirtualAssociationOverride(JavaAssociationOverrideContainer parent,
                                                                   String name)

buildJavaOverrideRelationship

JavaOverrideRelationship buildJavaOverrideRelationship(JavaAssociationOverride parent)

buildJavaVirtualOverrideRelationship

VirtualOverrideRelationship buildJavaVirtualOverrideRelationship(JavaVirtualAssociationOverride parent)

buildJavaQueryContainer

JavaQueryContainer buildJavaQueryContainer(JpaContextNode parent,
                                           JavaQueryContainer.Owner owner)

buildJavaNamedQuery

JavaNamedQuery buildJavaNamedQuery(JavaQueryContainer parent,
                                   NamedQueryAnnotation namedQueryAnnotation)

buildJavaNamedNativeQuery

JavaNamedNativeQuery buildJavaNamedNativeQuery(JavaQueryContainer parent,
                                               NamedNativeQueryAnnotation namedNativeQueryAnnotation)

buildJavaQueryHint

JavaQueryHint buildJavaQueryHint(JavaQuery parent,
                                 QueryHintAnnotation queryHintAnnotation)

buildJavaUniqueConstraint

JavaUniqueConstraint buildJavaUniqueConstraint(JpaContextNode parent,
                                               ReadOnlyUniqueConstraint.Owner owner,
                                               UniqueConstraintAnnotation constraintAnnotation)

buildJavaVirtualUniqueConstraint

VirtualUniqueConstraint buildJavaVirtualUniqueConstraint(JpaContextNode parent,
                                                         ReadOnlyUniqueConstraint overriddenUniqueConstraint)

buildJavaBaseEnumeratedConverter

JavaBaseEnumeratedConverter buildJavaBaseEnumeratedConverter(JavaAttributeMapping parent,
                                                             BaseEnumeratedAnnotation annotation,
                                                             Converter.Owner owner)

buildJavaBaseTemporalConverter

JavaBaseTemporalConverter buildJavaBaseTemporalConverter(JavaAttributeMapping parent,
                                                         BaseTemporalAnnotation annotation,
                                                         Converter.Owner owner)

buildJavaLobConverter

JavaLobConverter buildJavaLobConverter(JavaAttributeMapping parent,
                                       LobAnnotation annotation,
                                       Converter.Owner owner)

buildJavaOrderable

Orderable buildJavaOrderable(JavaAttributeMapping parent)