org.jboss.forge.addon.javaee.jpa

Interface PersistenceOperations

public interface PersistenceOperations

Defines JPA specific operations

Author:

Lincoln Baxter, III

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_UNIT_DESC
static String	DEFAULT_UNIT_SUFFIX

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.shrinkwrap.descriptor.api.persistence.PersistenceUnitCommon	getExistingPersistenceUnit(Project project, String unitName) Get the object representing the persistence unit, null is returned when no persistence unit was found.
List<JavaResource>	getProjectEntities(Project project) Returns the list of all the JPA entities of the project
JavaResource	newEmbeddableEntity(DirectoryResource target, String entityName, String entityPackage) Creates a new JavaResource for an embeddable entity in the specified project.
org.jboss.forge.roaster.model.source.JavaClassSource	newEmbeddableEntity(org.jboss.forge.roaster.model.source.JavaClassSource source) Given a JavaClassSource it decorates the source with code for an embeddable entity
JavaResource	newEmbeddableEntity(Project project, String entityName, String entityPackage) Creates a new JavaResource for an embeddable entity in the specified target.
JavaResource	newEntity(DirectoryResource target, String entityName, String entityPackage, javax.persistence.GenerationType idStrategy) Creates a new JavaResource in the specified target.
JavaResource	newEntity(DirectoryResource target, String entityName, String entityPackage, javax.persistence.GenerationType idStrategy, String tableName) Creates a new JavaResource in the specified target.
org.jboss.forge.roaster.model.source.JavaClassSource	newEntity(org.jboss.forge.roaster.model.source.JavaClassSource source, javax.persistence.GenerationType idStrategy, String tableName) Given a JavaClassSource it decorates the source with code for an entity
JavaResource	newEntity(Project project, String entityName, String entityPackage, javax.persistence.GenerationType idStrategy) Creates a new JavaResource in the specified project.
JavaResource	newEntity(Project project, String entityName, String entityPackage, javax.persistence.GenerationType idStrategy, String tableName) Creates a new JavaResource in the specified project.
FileResource<?>	setup(String unitName, Project project, JPADataSource dataSource, boolean configureMetadata) Setups JPA in the project for the given attributes.

Field Detail

DEFAULT_UNIT_SUFFIX

static final String DEFAULT_UNIT_SUFFIX

See Also:

Constant Field Values

DEFAULT_UNIT_DESC

static final String DEFAULT_UNIT_DESC

See Also:

Constant Field Values

Method Detail

setup

FileResource<?> setup(String unitName,
                    Project project,
                    JPADataSource dataSource,
                    boolean configureMetadata)

Setups JPA in the project for the given attributes. If persistence unit with the name already exists, the unit will be overwritten.

Parameters:

unitName - Name of the created Persistence Unit

project - Project for which the JPA is being set up

dataSource - JPA data-source configuration

configureMetadata - configure the metadata

getExistingPersistenceUnit

org.jboss.shrinkwrap.descriptor.api.persistence.PersistenceUnitCommon getExistingPersistenceUnit(Project project,
                                                                                               String unitName)

Get the object representing the persistence unit, null is returned when no persistence unit was found.

Parameters:

unitName - Name of the Persistence Unit

project - Project in which the JPA is being looked for

newEntity

JavaResource newEntity(Project project,
                     String entityName,
                     String entityPackage,
                     javax.persistence.GenerationType idStrategy,
                     String tableName)
                       throws FileNotFoundException

Creates a new JavaResource in the specified project. If no project is available, use newEntity(DirectoryResource, String, String, GenerationType)

Parameters:

project - the current project to create the entity. Must not be null

entityName - the name of the entity

entityPackage - the package of the entity to be created

idStrategy - the ID strategy chosen for this entity

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEntity

JavaResource newEntity(DirectoryResource target,
                     String entityName,
                     String entityPackage,
                     javax.persistence.GenerationType idStrategy,
                     String tableName)

Creates a new JavaResource in the specified target. If a project is available, use newEntity(Project, String, String, GenerationType)

Parameters:

target - the target directory resource to create this class

entityName - the name of the entity

entityPackage - the package of the entity to be created

idStrategy - the ID strategy chosen for this entity

tableName - the table name (optional)

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEntity

JavaResource newEntity(Project project,
                     String entityName,
                     String entityPackage,
                     javax.persistence.GenerationType idStrategy)
                       throws FileNotFoundException

Creates a new JavaResource in the specified project. If no project is available, use newEntity(DirectoryResource, String, String, GenerationType)

Parameters:

project - the current project to create the entity. Must not be null

entityName - the name of the entity

entityPackage - the package of the entity to be created

idStrategy - the ID strategy chosen for this entity

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEntity

JavaResource newEntity(DirectoryResource target,
                     String entityName,
                     String entityPackage,
                     javax.persistence.GenerationType idStrategy)

Creates a new JavaResource in the specified target. If a project is available, use newEntity(Project, String, String, GenerationType)

Parameters:

target - the target directory resource to create this class

entityName - the name of the entity

entityPackage - the package of the entity to be created

idStrategy - the ID strategy chosen for this entity

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEntity

org.jboss.forge.roaster.model.source.JavaClassSource newEntity(org.jboss.forge.roaster.model.source.JavaClassSource source,
                                                             javax.persistence.GenerationType idStrategy,
                                                             String tableName)

Given a JavaClassSource it decorates the source with code for an entity

Parameters:

source - source of the class to decorate

idStrategy - the ID strategy chosen for this entity

tableName - the table name chose for this entity

Returns:

the decorated java resource

newEmbeddableEntity

JavaResource newEmbeddableEntity(DirectoryResource target,
                               String entityName,
                               String entityPackage)

Creates a new JavaResource for an embeddable entity in the specified project. If a project is available, use newEmbeddableEntity(Project, String, String)

Parameters:

target - the target directory resource to create this class

entityName - the name of the entity

entityPackage - the package of the entity to be created

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEmbeddableEntity

JavaResource newEmbeddableEntity(Project project,
                               String entityName,
                               String entityPackage)
                                 throws FileNotFoundException

Creates a new JavaResource for an embeddable entity in the specified target. If no project is available, use newEmbeddableEntity(DirectoryResource, String, String)

Parameters:

project - the current project to create the entity. Must not be null

entityName - the name of the entity

entityPackage - the package of the entity to be created

Returns:

the created java resource

Throws:

FileNotFoundException - if something wrong happens while saving the JavaClass

newEmbeddableEntity

org.jboss.forge.roaster.model.source.JavaClassSource newEmbeddableEntity(org.jboss.forge.roaster.model.source.JavaClassSource source)

Given a JavaClassSource it decorates the source with code for an embeddable entity

Parameters:

source - source of the class to decorate

Returns:

the decorated java resource

getProjectEntities

List<JavaResource> getProjectEntities(Project project)

Returns the list of all the JPA entities of the project

Parameters:

project - the current project

Returns:

the list of all the entities of the project