org.eclipse.jpt.core
Interface JpaFactory


public interface JpaFactory

Use JpaFactory to create any core (e.g. JpaProject), resource (e.g. PersistenceResource), or context (e.g. AttributeMapping) model objects. Assumes a base JPA project context structure corresponding to the JPA spec: RootContent |- persistence.xml |- persistence unit(s) |- mapping file(s) (e.g. orm.xml) | |- persistent type mapping(s) (e.g. Entity) | |- persistent attribute mapping(s) (e.g. Basic) |- persistent type mapping(s) ... and associated objects.

See Also:
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.

Method Summary
 ClassRef buildClassRef(PersistenceUnit parent, java.lang.String className)
           
 ClassRef buildClassRef(PersistenceUnit parent, XmlJavaClassRef xmlClassRef)
           
 EntityMappings buildEntityMappings(OrmXml parent, XmlEntityMappings entityMappings)
           
 JavaAssociationOverride buildJavaAssociationOverride(JavaJpaContextNode parent, AssociationOverride.Owner owner)
           
 JavaAttributeOverride buildJavaAttributeOverride(JavaJpaContextNode parent, AttributeOverride.Owner owner)
           
 JavaBasicMapping buildJavaBasicMapping(JavaPersistentAttribute parent)
           
 JavaColumn buildJavaColumn(JavaJpaContextNode parent, JavaColumn.Owner owner)
           
 JavaDiscriminatorColumn buildJavaDiscriminatorColumn(JavaEntity parent, JavaNamedColumn.Owner owner)
           
 JavaEmbeddable buildJavaEmbeddable(JavaPersistentType parent)
           
 JavaEmbeddedIdMapping buildJavaEmbeddedIdMapping(JavaPersistentAttribute parent)
           
 JavaEmbeddedMapping buildJavaEmbeddedMapping(JavaPersistentAttribute parent)
           
 JavaEntity buildJavaEntity(JavaPersistentType parent)
           
 JavaGeneratedValue buildJavaGeneratedValue(JavaAttributeMapping parent)
           
 JavaIdMapping buildJavaIdMapping(JavaPersistentAttribute parent)
           
 JavaJoinColumn buildJavaJoinColumn(JavaJpaContextNode parent, JavaJoinColumn.Owner owner)
           
 JavaJoinTable buildJavaJoinTable(JavaRelationshipMapping parent)
           
 JavaManyToManyMapping buildJavaManyToManyMapping(JavaPersistentAttribute parent)
           
 JavaManyToOneMapping buildJavaManyToOneMapping(JavaPersistentAttribute parent)
           
 JavaMappedSuperclass buildJavaMappedSuperclass(JavaPersistentType parent)
           
 JavaNamedNativeQuery buildJavaNamedNativeQuery(JavaJpaContextNode parent)
           
 JavaNamedQuery buildJavaNamedQuery(JavaJpaContextNode parent)
           
 JavaAttributeMapping buildJavaNullAttributeMapping(JavaPersistentAttribute parent)
           
 JavaTypeMapping buildJavaNullTypeMapping(JavaPersistentType parent)
           
 JavaOneToManyMapping buildJavaOneToManyMapping(JavaPersistentAttribute parent)
           
 JavaOneToOneMapping buildJavaOneToOneMapping(JavaPersistentAttribute parent)
           
 JavaPersistentAttribute buildJavaPersistentAttribute(JavaPersistentType parent)
           
 JavaPersistentType buildJavaPersistentType(JpaContextNode parent, JavaResourcePersistentType resourcePersistentType)
           
 JavaPrimaryKeyJoinColumn buildJavaPrimaryKeyJoinColumn(JavaJpaContextNode parent, JavaBaseJoinColumn.Owner owner)
           
 JavaQueryHint buildJavaQueryHint(JavaQuery parent)
           
 JavaSecondaryTable buildJavaSecondaryTable(JavaEntity parent)
           
 JavaSequenceGenerator buildJavaSequenceGenerator(JavaJpaContextNode parent)
           
 JavaTable buildJavaTable(JavaEntity parent)
           
 JavaTableGenerator buildJavaTableGenerator(JavaJpaContextNode parent)
           
 JavaTransientMapping buildJavaTransientMapping(JavaPersistentAttribute parent)
           
 JavaUniqueConstraint buildJavaUniqueConstraint(JavaJpaContextNode parent, UniqueConstraint.Owner owner)
           
 JavaVersionMapping buildJavaVersionMapping(JavaPersistentAttribute parent)
           
 JpaDataSource buildJpaDataSource(JpaProject jpaProject, java.lang.String connectionProfileName)
           
 JpaFile buildJpaFile(JpaProject jpaProject, org.eclipse.core.resources.IFile file, ResourceModel resourceModel)
          Construct a JPA file for the specified file and with the specified resource model, to be added to the specified JPA project.
 JpaProject buildJpaProject(JpaProject.Config config)
          Construct a JpaProject for the specified config, to be added to the specified JPA project.
 MappingFileRef buildMappingFileRef(PersistenceUnit parent, XmlMappingFileRef xmlMappingFileRef)
          xmlMappingFileRef is allowed to be null, this would be used for the implied mapping file ref
 OrmAssociationOverride buildOrmAssociationOverride(OrmJpaContextNode parent, AssociationOverride.Owner owner, XmlAssociationOverride associationOverride)
           
 OrmAttributeOverride buildOrmAttributeOverride(OrmJpaContextNode parent, AttributeOverride.Owner owner, XmlAttributeOverride xmlAttributeOverride)
           
 OrmBasicMapping buildOrmBasicMapping(OrmPersistentAttribute parent)
           
 OrmColumn buildOrmColumn(OrmJpaContextNode parent, OrmColumn.Owner owner)
           
 OrmDiscriminatorColumn buildOrmDiscriminatorColumn(OrmEntity parent, OrmNamedColumn.Owner owner)
           
 OrmEmbeddable buildOrmEmbeddable(OrmPersistentType parent)
           
 OrmEmbeddedIdMapping buildOrmEmbeddedIdMapping(OrmPersistentAttribute parent)
           
 OrmEmbeddedMapping buildOrmEmbeddedMapping(OrmPersistentAttribute parent)
           
 OrmEntity buildOrmEntity(OrmPersistentType parent)
           
 OrmGeneratedValue buildOrmGeneratedValue(OrmJpaContextNode parent)
           
 OrmIdMapping buildOrmIdMapping(OrmPersistentAttribute parent)
           
 OrmJoinColumn buildOrmJoinColumn(OrmJpaContextNode parent, OrmJoinColumn.Owner owner)
           
 OrmJoinTable buildOrmJoinTable(OrmRelationshipMapping parent)
           
 OrmManyToManyMapping buildOrmManyToManyMapping(OrmPersistentAttribute parent)
           
 OrmManyToOneMapping buildOrmManyToOneMapping(OrmPersistentAttribute parent)
           
 OrmMappedSuperclass buildOrmMappedSuperclass(OrmPersistentType parent)
           
 OrmNamedNativeQuery buildOrmNamedNativeQuery(OrmJpaContextNode parent)
           
 OrmNamedQuery buildOrmNamedQuery(OrmJpaContextNode parent)
           
 OrmAttributeMapping buildOrmNullAttributeMapping(OrmPersistentAttribute parent)
           
 OrmOneToManyMapping buildOrmOneToManyMapping(OrmPersistentAttribute parent)
           
 OrmOneToOneMapping buildOrmOneToOneMapping(OrmPersistentAttribute parent)
           
 OrmPersistentAttribute buildOrmPersistentAttribute(OrmPersistentType parent, java.lang.String mappingKey)
           
 OrmPersistentType buildOrmPersistentType(EntityMappings parent, java.lang.String mappingKey)
           
 OrmPrimaryKeyJoinColumn buildOrmPrimaryKeyJoinColumn(OrmJpaContextNode parent, OrmBaseJoinColumn.Owner owner)
           
 OrmQueryHint buildOrmQueryHint(OrmQuery parent)
           
 OrmSecondaryTable buildOrmSecondaryTable(OrmEntity parent, XmlSecondaryTable xmlSecondaryTable)
           
 OrmSequenceGenerator buildOrmSequenceGenerator(OrmJpaContextNode parent)
           
 OrmTable buildOrmTable(OrmEntity parent)
           
 OrmTableGenerator buildOrmTableGenerator(OrmJpaContextNode parent)
           
 OrmTransientMapping buildOrmTransientMapping(OrmPersistentAttribute parent)
           
 OrmUniqueConstraint buildOrmUniqueConstraint(OrmJpaContextNode parent, UniqueConstraint.Owner owner, XmlUniqueConstraint xmlUniqueConstraint)
           
 OrmVersionMapping buildOrmVersionMapping(OrmPersistentAttribute parent)
           
 OrmXml buildOrmXml(MappingFileRef parent, OrmResource ormResource)
           
 Persistence buildPersistence(PersistenceXml parent, XmlPersistence xmlPersistence)
           
 PersistenceUnit buildPersistenceUnit(Persistence parent, XmlPersistenceUnit persistenceUnit)
           
 PersistenceUnitDefaults buildPersistenceUnitDefaults(PersistenceUnitMetadata parent, XmlEntityMappings entityMappings)
           
 PersistenceUnitMetadata buildPersistenceUnitMetadata(EntityMappings parent, XmlEntityMappings entityMappings)
           
 PersistenceXml buildPersistenceXml(JpaRootContextNode parent, PersistenceResource persistenceResource)
           
 Property buildProperty(PersistenceUnit parent, XmlProperty property)
           
 ResourceModel buildResourceModel(JpaProject jpaProject, org.eclipse.core.resources.IFile file)
          Build a resource model to be associated with the given file.
 JpaRootContextNode buildRootContext(JpaProject jpaProject)
          Build a (/an updated) root context node to be associated with the given JPA project.
 boolean hasRelevantContent(org.eclipse.core.resources.IFile file)
          Return true if a resource model will be provided for the given file (this method should be moved to JpaPlatform)
 

Method Detail

buildJpaProject

JpaProject buildJpaProject(JpaProject.Config config)
                           throws org.eclipse.core.runtime.CoreException
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).

Throws:
org.eclipse.core.runtime.CoreException

buildJpaDataSource

JpaDataSource buildJpaDataSource(JpaProject jpaProject,
                                 java.lang.String connectionProfileName)

buildJpaFile

JpaFile buildJpaFile(JpaProject jpaProject,
                     org.eclipse.core.resources.IFile file,
                     ResourceModel resourceModel)
Construct a JPA file for the specified file and with the specified resource model, to be added to the specified JPA project. This should be non-null iff (if and only if) hasRelevantContent(IFile) returns true.


hasRelevantContent

boolean hasRelevantContent(org.eclipse.core.resources.IFile file)
Return true if a resource model will be provided for the given file (this method should be moved to JpaPlatform)


buildResourceModel

ResourceModel buildResourceModel(JpaProject jpaProject,
                                 org.eclipse.core.resources.IFile file)
Build a resource model to be associated with the given file. This should be non-null iff (if and only if) hasRelevantContent(IFile) returns true.


buildRootContext

JpaRootContextNode buildRootContext(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:
JpaProject.update(ProgressMonitor)

buildPersistenceXml

PersistenceXml buildPersistenceXml(JpaRootContextNode parent,
                                   PersistenceResource persistenceResource)

buildPersistence

Persistence buildPersistence(PersistenceXml parent,
                             XmlPersistence xmlPersistence)

buildPersistenceUnit

PersistenceUnit buildPersistenceUnit(Persistence parent,
                                     XmlPersistenceUnit persistenceUnit)

buildMappingFileRef

MappingFileRef buildMappingFileRef(PersistenceUnit parent,
                                   XmlMappingFileRef xmlMappingFileRef)
xmlMappingFileRef is allowed to be null, this would be used for the implied mapping file ref


buildClassRef

ClassRef buildClassRef(PersistenceUnit parent,
                       XmlJavaClassRef xmlClassRef)

buildClassRef

ClassRef buildClassRef(PersistenceUnit parent,
                       java.lang.String className)

buildProperty

Property buildProperty(PersistenceUnit parent,
                       XmlProperty property)

buildOrmXml

OrmXml buildOrmXml(MappingFileRef parent,
                   OrmResource ormResource)

buildEntityMappings

EntityMappings buildEntityMappings(OrmXml parent,
                                   XmlEntityMappings entityMappings)

buildPersistenceUnitMetadata

PersistenceUnitMetadata buildPersistenceUnitMetadata(EntityMappings parent,
                                                     XmlEntityMappings entityMappings)

buildPersistenceUnitDefaults

PersistenceUnitDefaults buildPersistenceUnitDefaults(PersistenceUnitMetadata parent,
                                                     XmlEntityMappings entityMappings)

buildOrmPersistentType

OrmPersistentType buildOrmPersistentType(EntityMappings parent,
                                         java.lang.String mappingKey)

buildOrmEntity

OrmEntity buildOrmEntity(OrmPersistentType parent)

buildOrmMappedSuperclass

OrmMappedSuperclass buildOrmMappedSuperclass(OrmPersistentType parent)

buildOrmEmbeddable

OrmEmbeddable buildOrmEmbeddable(OrmPersistentType parent)

buildOrmPersistentAttribute

OrmPersistentAttribute buildOrmPersistentAttribute(OrmPersistentType parent,
                                                   java.lang.String mappingKey)

buildOrmTable

OrmTable buildOrmTable(OrmEntity parent)

buildOrmSecondaryTable

OrmSecondaryTable buildOrmSecondaryTable(OrmEntity parent,
                                         XmlSecondaryTable xmlSecondaryTable)

buildOrmPrimaryKeyJoinColumn

OrmPrimaryKeyJoinColumn buildOrmPrimaryKeyJoinColumn(OrmJpaContextNode parent,
                                                     OrmBaseJoinColumn.Owner owner)

buildOrmJoinTable

OrmJoinTable buildOrmJoinTable(OrmRelationshipMapping parent)

buildOrmJoinColumn

OrmJoinColumn buildOrmJoinColumn(OrmJpaContextNode parent,
                                 OrmJoinColumn.Owner owner)

buildOrmAttributeOverride

OrmAttributeOverride buildOrmAttributeOverride(OrmJpaContextNode parent,
                                               AttributeOverride.Owner owner,
                                               XmlAttributeOverride xmlAttributeOverride)

buildOrmAssociationOverride

OrmAssociationOverride buildOrmAssociationOverride(OrmJpaContextNode parent,
                                                   AssociationOverride.Owner owner,
                                                   XmlAssociationOverride associationOverride)

buildOrmDiscriminatorColumn

OrmDiscriminatorColumn buildOrmDiscriminatorColumn(OrmEntity parent,
                                                   OrmNamedColumn.Owner owner)

buildOrmColumn

OrmColumn buildOrmColumn(OrmJpaContextNode parent,
                         OrmColumn.Owner owner)

buildOrmGeneratedValue

OrmGeneratedValue buildOrmGeneratedValue(OrmJpaContextNode parent)

buildOrmSequenceGenerator

OrmSequenceGenerator buildOrmSequenceGenerator(OrmJpaContextNode parent)

buildOrmTableGenerator

OrmTableGenerator buildOrmTableGenerator(OrmJpaContextNode parent)

buildOrmNamedNativeQuery

OrmNamedNativeQuery buildOrmNamedNativeQuery(OrmJpaContextNode parent)

buildOrmNamedQuery

OrmNamedQuery buildOrmNamedQuery(OrmJpaContextNode parent)

buildOrmQueryHint

OrmQueryHint buildOrmQueryHint(OrmQuery parent)

buildOrmBasicMapping

OrmBasicMapping buildOrmBasicMapping(OrmPersistentAttribute parent)

buildOrmManyToManyMapping

OrmManyToManyMapping buildOrmManyToManyMapping(OrmPersistentAttribute parent)

buildOrmOneToManyMapping

OrmOneToManyMapping buildOrmOneToManyMapping(OrmPersistentAttribute parent)

buildOrmManyToOneMapping

OrmManyToOneMapping buildOrmManyToOneMapping(OrmPersistentAttribute parent)

buildOrmOneToOneMapping

OrmOneToOneMapping buildOrmOneToOneMapping(OrmPersistentAttribute parent)

buildOrmEmbeddedIdMapping

OrmEmbeddedIdMapping buildOrmEmbeddedIdMapping(OrmPersistentAttribute parent)

buildOrmEmbeddedMapping

OrmEmbeddedMapping buildOrmEmbeddedMapping(OrmPersistentAttribute parent)

buildOrmIdMapping

OrmIdMapping buildOrmIdMapping(OrmPersistentAttribute parent)

buildOrmTransientMapping

OrmTransientMapping buildOrmTransientMapping(OrmPersistentAttribute parent)

buildOrmVersionMapping

OrmVersionMapping buildOrmVersionMapping(OrmPersistentAttribute parent)

buildOrmNullAttributeMapping

OrmAttributeMapping buildOrmNullAttributeMapping(OrmPersistentAttribute parent)

buildOrmUniqueConstraint

OrmUniqueConstraint buildOrmUniqueConstraint(OrmJpaContextNode parent,
                                             UniqueConstraint.Owner owner,
                                             XmlUniqueConstraint xmlUniqueConstraint)

buildJavaPersistentType

JavaPersistentType buildJavaPersistentType(JpaContextNode parent,
                                           JavaResourcePersistentType resourcePersistentType)

buildJavaEntity

JavaEntity buildJavaEntity(JavaPersistentType parent)

buildJavaMappedSuperclass

JavaMappedSuperclass buildJavaMappedSuperclass(JavaPersistentType parent)

buildJavaEmbeddable

JavaEmbeddable buildJavaEmbeddable(JavaPersistentType parent)

buildJavaNullTypeMapping

JavaTypeMapping buildJavaNullTypeMapping(JavaPersistentType parent)

buildJavaPersistentAttribute

JavaPersistentAttribute buildJavaPersistentAttribute(JavaPersistentType parent)

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)

buildJavaTable

JavaTable buildJavaTable(JavaEntity parent)

buildJavaJoinTable

JavaJoinTable buildJavaJoinTable(JavaRelationshipMapping parent)

buildJavaColumn

JavaColumn buildJavaColumn(JavaJpaContextNode parent,
                           JavaColumn.Owner owner)

buildJavaDiscriminatorColumn

JavaDiscriminatorColumn buildJavaDiscriminatorColumn(JavaEntity parent,
                                                     JavaNamedColumn.Owner owner)

buildJavaJoinColumn

JavaJoinColumn buildJavaJoinColumn(JavaJpaContextNode parent,
                                   JavaJoinColumn.Owner owner)

buildJavaSecondaryTable

JavaSecondaryTable buildJavaSecondaryTable(JavaEntity parent)

buildJavaSequenceGenerator

JavaSequenceGenerator buildJavaSequenceGenerator(JavaJpaContextNode parent)

buildJavaTableGenerator

JavaTableGenerator buildJavaTableGenerator(JavaJpaContextNode parent)

buildJavaGeneratedValue

JavaGeneratedValue buildJavaGeneratedValue(JavaAttributeMapping parent)

buildJavaPrimaryKeyJoinColumn

JavaPrimaryKeyJoinColumn buildJavaPrimaryKeyJoinColumn(JavaJpaContextNode parent,
                                                       JavaBaseJoinColumn.Owner owner)

buildJavaAttributeOverride

JavaAttributeOverride buildJavaAttributeOverride(JavaJpaContextNode parent,
                                                 AttributeOverride.Owner owner)

buildJavaAssociationOverride

JavaAssociationOverride buildJavaAssociationOverride(JavaJpaContextNode parent,
                                                     AssociationOverride.Owner owner)

buildJavaNamedQuery

JavaNamedQuery buildJavaNamedQuery(JavaJpaContextNode parent)

buildJavaNamedNativeQuery

JavaNamedNativeQuery buildJavaNamedNativeQuery(JavaJpaContextNode parent)

buildJavaQueryHint

JavaQueryHint buildJavaQueryHint(JavaQuery parent)

buildJavaUniqueConstraint

JavaUniqueConstraint buildJavaUniqueConstraint(JavaJpaContextNode parent,
                                               UniqueConstraint.Owner owner)