Author: fdesbois Date: 2010-12-29 17:15:42 +0100 (Wed, 29 Dec 2010) New Revision: 445 Url: http://nuiton.org/repositories/revision/sandbox/445 Log: Update jpa tests : - Add QueryWrapper - Add OrderBy - Update DAO - Add PaginationData - Move DataProvider, use inheritance between tests Added: jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseValidationTest.java jpa2-validation/trunk/jsr303-validation/src/test/resources/test-validation-spring-context.xml jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/CountQueryWrapper.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/EntityQueryWrapper.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderBy.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByAsc.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByDesc.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByRandom.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationData.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/QueryWrapper.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/Search.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/query/ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationDataTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/sample/ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseJpaTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-jpa-spring-context.xml Removed: jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseTest.java jpa2-validation/trunk/jsr303-validation/src/test/resources/META-INF/persistence.xml jpa2-validation/trunk/jsr303-validation/src/test/resources/test-spring-context.xml jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/Search.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/SearchImpl.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/sample/ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-context.xml Modified: jpa2-validation/trunk/jsr303-validation/pom.xml jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/CustomerValidationTest.java jpa2-validation/trunk/jsr317-jpa2/pom.xml jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/config/UpdateTechnicalFieldListener.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAO.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImpl.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImpl.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContext.java jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContextImpl.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/EntityManagerTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/MetaModelTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImplTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImplTest.java jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/sample/DataSampleProvider.java jpa2-validation/trunk/pom.xml Modified: jpa2-validation/trunk/jsr303-validation/pom.xml =================================================================== --- jpa2-validation/trunk/jsr303-validation/pom.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr303-validation/pom.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -69,7 +69,15 @@ </dependency> <!-- TESTS --> + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>jsr317-jpa2</artifactId> + <version>${project.version}</version> + <classifier>tests</classifier> + </dependency> + + <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> </dependency> Modified: jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/CustomerValidationTest.java =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/CustomerValidationTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/CustomerValidationTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -9,7 +9,7 @@ import org.apache.commons.logging.LogFactory; import org.junit.Assert; import org.junit.Test; -import org.nuiton.sandbox.jsr303.validation.test.BaseTest; +import org.nuiton.sandbox.jsr303.validation.test.BaseValidationTest; import org.nuiton.sandbox.jsr317.jpa2.entity.Customer; import org.nuiton.sandbox.jsr317.jpa2.persistence.CustomerDAO; import org.springframework.beans.factory.annotation.Autowired; @@ -21,7 +21,7 @@ * @author fdesbois <florian.desbois@wiztivi.com> * @version $Id: CustomerValidationTest.java 48934 2010-11-18 16:17:46Z fdesbois $ */ -public class CustomerValidationTest extends BaseTest { +public class CustomerValidationTest extends BaseValidationTest { private static final Log log = LogFactory.getLog(CustomerValidationTest.class); @@ -39,6 +39,8 @@ try { // ---- EXECUTE ---- // userDAO.save(user); + // Need manual flush because test have @Transactional annotation + modelContext.flushSession(); Assert.fail(); } catch (ConstraintViolationException ex) { @@ -72,6 +74,8 @@ try { log.info("test 2 : update the same user with fake email : throw ConstraintViolationException"); user = userDAO.update(user); + // Need manual flush because test have @Transactional annotation + modelContext.flushSession(); Assert.fail(); } catch (ConstraintViolationException ex) { Deleted: jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseTest.java =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,115 +0,0 @@ -package org.nuiton.sandbox.jsr303.validation.test; - -import javax.validation.ConstraintViolation; -import javax.validation.ConstraintViolationException; -import javax.validation.Validator; - -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.junit.Assert; -import org.junit.Rule; -import org.junit.rules.TestName; -import org.junit.runner.RunWith; -import org.junit.runners.model.FrameworkMethod; -import org.nuiton.sandbox.jsr317.jpa2.persistence.BaseDAOImpl.SaveStrategy; -import org.nuiton.sandbox.jsr317.jpa2.persistence.ModelContext; -import org.nuiton.sandbox.jsr317.jpa2.sample.DataSampleProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; - -/** - * Created on 26 oct. 2010 - * - * @author fdesbois <florian.desbois@wiztivi.com> - * @version $Id: BaseTest.java 48934 2010-11-18 16:17:46Z fdesbois $ - */ -@RunWith(SpringJUnit4ClassRunner.class) -@ContextConfiguration(locations = {"/test-spring-context.xml"}) -public abstract class BaseTest { - - private static final Log logger = LogFactory.getLog(BaseTest.class); - - @Autowired - protected ModelContext modelContext; - - @Autowired - protected DataSampleProvider dataProvider; - - @Autowired - protected Validator validator; - - @Rule - public TestName rule = new TestName() { - - @Override - public void starting(FrameworkMethod method) { - super.starting(method); - - // Apply persist flush saveStrategy for all tests, this will effectively keep instance in session and flush - // it after each {@link BaseDAO#save()} call - modelContext.setSaveStrategy(SaveStrategy.PERSIST_FLUSH); - - // Use DataProvider depends on annotation declaration in tests -// useDataProvider(method.getAnnotation(UseDataProvider.class)); - } - -// protected void useDataProvider(UseDataProvider useDataProvider) { -// boolean useData = DataSampleProvider.isUseDataProviderFromMethod(BaseTest.this.getClass(), useDataProvider); -// -// if (useData) { -// try { -// dataProvider.createAllData(); -// } catch (ConstraintViolationException ex) { -// logger.error(ex); -// if (logger.isInfoEnabled()) { -// for (ConstraintViolation<?> constraint : ex.getConstraintViolations()) { -// logger.info("constraint.getRootBeanClass = " + constraint.getRootBeanClass()); -// logger.info("constraint.getPropertyPath = " + constraint.getPropertyPath()); -// logger.info("constraint.getMessageTemplate = " + constraint.getMessageTemplate()); -// logger.info("constraint.getInvalidValue = " + constraint.getInvalidValue()); -// } -// } -// throw new TivimmoRuntimeException("Error while creating all data", ex); -// } catch (Exception ex) { -// logger.error(ex.getClass().getSimpleName(), ex); -// throw new TivimmoRuntimeException("Error while creating all data", ex); -// } -// } -// } - }; - - protected interface ConstraintChecker { - - void execute(); - } - - protected void assertConstraintViolationException(ConstraintChecker checker, String field, Class<?> annotationClass) { - - try { - checker.execute(); - Assert.fail(); - - } catch (ConstraintViolationException ex) { - - if (logger.isDebugEnabled()) { - logger.debug("Expected error", ex); - } - - ConstraintViolation<?> constraint = ex.getConstraintViolations().iterator().next(); - Assert.assertEquals(field, constraint.getPropertyPath().toString()); - Assert.assertTrue(constraint.getMessageTemplate().contains(annotationClass.getSimpleName())); - - if (logger.isDebugEnabled()) { - logger.debug("constraint.getMessageTemplate = " + constraint.getMessageTemplate()); - logger.debug("constraint.getMessage = " + constraint.getMessage()); - logger.debug("constraint.getInvalidValue = " + constraint.getInvalidValue()); - logger.debug("constraint.getLeafBean = " + constraint.getLeafBean()); - logger.debug("constraint.getPropertyPath = " + constraint.getPropertyPath()); - logger.debug("constraint.getRootBean = " + constraint.getRootBean()); - logger.debug("constraint.getRootBeanClass = " + constraint.getRootBeanClass()); - } - - } - } -} Copied: jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseValidationTest.java (from rev 444, jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseTest.java) =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseValidationTest.java (rev 0) +++ jpa2-validation/trunk/jsr303-validation/src/test/java/org/nuiton/sandbox/jsr303/validation/test/BaseValidationTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,113 @@ +package org.nuiton.sandbox.jsr303.validation.test; + +import javax.validation.ConstraintViolation; +import javax.validation.ConstraintViolationException; +import javax.validation.Validator; +import java.lang.annotation.Annotation; + +import org.junit.Assert; +import org.junit.Rule; +import org.junit.rules.TestWatchman; +import org.nuiton.sandbox.jsr317.jpa2.persistence.ModelContext; +import org.nuiton.sandbox.jsr317.jpa2.sample.DataProviderLimit; +import org.nuiton.sandbox.jsr317.jpa2.test.BaseJpaTest; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.test.context.ContextConfiguration; + +/** + * Created on 26 oct. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: BaseValidationTest.java 48934 2010-11-18 16:17:46Z fdesbois $ + */ +@ContextConfiguration(locations = { "/test-validation-spring-context.xml" }) +public abstract class BaseValidationTest extends BaseJpaTest { + + @Autowired + protected ModelContext modelContext; + + @Autowired + protected Validator validator; + + protected class ValidationTestRule extends JpaTestRule { + + @Override + protected void createData(DataProviderLimit limit) { + try { + dataProvider.createData(limit); + modelContext.flushSession(); + } catch (ConstraintViolationException ex) { + logger.error(ex); + if (logger.isInfoEnabled()) { + for (ConstraintViolation<?> constraint : ex.getConstraintViolations()) { + logger.info("constraint.getRootBeanClass = " + constraint.getRootBeanClass()); + logger.info("constraint.getPropertyPath = " + constraint.getPropertyPath()); + logger.info("constraint.getMessageTemplate = " + constraint.getMessageTemplate()); + logger.info("constraint.getInvalidValue = " + constraint.getInvalidValue()); + } + } + throw new RuntimeException("Error while creating all data", ex); + } catch (Exception ex) { + logger.error(ex.getClass().getSimpleName(), ex); + throw new RuntimeException("Error while creating all data", ex); + } + } + } + + protected interface ConstraintChecker { + + void execute() throws Exception; + } + + @Rule + public TestWatchman rule = new ValidationTestRule(); + + protected void assertConstraintViolationException(ConstraintChecker checker, String expectedField, + Class<?> expectedAnnotation) throws Exception { + + try { + checker.execute(); + Assert.fail("No ConstraintViolationException was thrown"); + } catch (ConstraintViolationException ex) { + + boolean constraintFound = false; + for (ConstraintViolation<?> constraintViolation : ex.getConstraintViolations()) { + ConstraintViolation<?> constraint = constraintViolation; + + String propertyPath = getConstraintPropertyPath(constraint); + Class<? extends Annotation> annotationType = getConstraintAnnotationType(constraint); + + if (logger.isDebugEnabled()) { + logger.debug("Constraint error " + annotationType.getSimpleName() + " on property " + propertyPath + + " from bean " + constraint.getRootBeanClass().getSimpleName()); + } + + if (logger.isTraceEnabled()) { + logger.trace("constraint.getMessageTemplate = " + constraint.getMessageTemplate()); + logger.trace("constraint.getMessage = " + constraint.getMessage()); + logger.trace("constraint.getInvalidValue = " + constraint.getInvalidValue()); + logger.trace("constraint.getLeafBean = " + constraint.getLeafBean()); + logger.trace("constraint.getPropertyPath = " + constraint.getPropertyPath()); + logger.trace("constraint.getRootBean = " + constraint.getRootBean()); + logger.trace("constraint.getRootBeanClass = " + constraint.getRootBeanClass()); + } + + if (propertyPath.equals(expectedField) && annotationType.equals(expectedAnnotation)) { + constraintFound = true; + } + } + + Assert.assertTrue("No constraint typed by '" + expectedAnnotation.getSimpleName() + "' was found" + + " for field '" + expectedField + "'", constraintFound); + } + } + + protected Class<? extends Annotation> getConstraintAnnotationType(ConstraintViolation<?> constraint) { + return constraint.getConstraintDescriptor().getAnnotation().annotationType(); + } + + protected String getConstraintPropertyPath(ConstraintViolation<?> constraint) { + return constraint.getPropertyPath().toString(); + } + +} Deleted: jpa2-validation/trunk/jsr303-validation/src/test/resources/META-INF/persistence.xml =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/resources/META-INF/persistence.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr303-validation/src/test/resources/META-INF/persistence.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -1,12 +0,0 @@ -<persistence xmlns="http://java.sun.com/xml/ns/persistence" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd" - version="2.0"> - - <persistence-unit name="jsr303-test" transaction-type="RESOURCE_LOCAL"> - <class>org.nuiton.sandbox.jsr317.jpa2.entity.CustomerImpl</class> - <class>org.nuiton.sandbox.jsr317.jpa2.entity.CountryImpl</class> - <!--<validation-mode>NONE</validation-mode>--> - </persistence-unit> - -</persistence> \ No newline at end of file Deleted: jpa2-validation/trunk/jsr303-validation/src/test/resources/test-spring-context.xml =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/resources/test-spring-context.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr303-validation/src/test/resources/test-spring-context.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -1,51 +0,0 @@ -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:context="http://www.springframework.org/schema/context" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd - http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> - - <!-- TEST CONFIGURATION :: sample used to fill database --> - <context:component-scan base-package="org.nuiton.sandbox.jsr317.jpa2.sample"/> - - <!-- SERVICES CONFIGURATION --> - <import resource="classpath:/jsr303-spring-context.xml"/> - - <!-- MODEL INJECTION and JPA CONFIGURATION --> - <import resource="classpath:/jsr317-spring-context.xml"/> - - <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> - <property name="url" - value="jdbc:h2:file:./target/surefire-data/jsr303"/> - <property name="username" value="sa"/> - <property name="password" value=""/> - </bean> - - <bean id="transactionManager" - class="org.springframework.orm.jpa.JpaTransactionManager"> - <property name="entityManagerFactory" ref="entityManagerFactory"/> - </bean> - - <bean id="entityManagerFactory" - class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> - <property name="dataSource" ref="dataSource"/> - <property name="jpaVendorAdapter"> - <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"> - <property name="showSql" value="false"/> - <property name="generateDdl" value="true"/> - <property name="databasePlatform" value="org.hibernate.dialect.H2Dialect"/> - </bean> - </property> - <property name="jpaProperties"> - <props> - <prop key="hibernate.hbm2ddl.auto">create</prop> - <!-- IdGenerator Strategy : one unique number for each row for all database --> - <prop key="hibernate.id.new_generator_mappings">true</prop> - </props> - </property> - <property name="loadTimeWeaver"> - <bean class="org.springframework.instrument.classloading.InstrumentationLoadTimeWeaver"/> - </property> - </bean> - -</beans> \ No newline at end of file Copied: jpa2-validation/trunk/jsr303-validation/src/test/resources/test-validation-spring-context.xml (from rev 444, jpa2-validation/trunk/jsr303-validation/src/test/resources/test-spring-context.xml) =================================================================== --- jpa2-validation/trunk/jsr303-validation/src/test/resources/test-validation-spring-context.xml (rev 0) +++ jpa2-validation/trunk/jsr303-validation/src/test/resources/test-validation-spring-context.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,56 @@ +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:context="http://www.springframework.org/schema/context" + xmlns:tx="http://www.springframework.org/schema/tx" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd + http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd + http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd"> + + <!-- TEST CONFIGURATION :: sample used to fill database --> + <context:component-scan base-package="org.nuiton.sandbox.jsr317.jpa2.sample"/> + + <!-- SERVICES CONFIGURATION --> + <import resource="classpath:/jsr303-spring-context.xml"/> + + <!-- MODEL INJECTION and JPA CONFIGURATION --> + <import resource="classpath:/jsr317-spring-context.xml"/> + + <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> + <property name="url" + value="jdbc:h2:file:./target/surefire-data/jsr303"/> + <property name="username" value="sa"/> + <property name="password" value=""/> + </bean> + + <!-- For @Transactional annotations --> + <tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true"/> + + <bean id="transactionManager" + class="org.springframework.orm.jpa.JpaTransactionManager"> + <property name="entityManagerFactory" ref="entityManagerFactory"/> + </bean> + + <bean id="entityManagerFactory" + class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean"> + <property name="dataSource" ref="dataSource"/> + <property name="jpaVendorAdapter"> + <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter"> + <property name="showSql" value="false"/> + <property name="generateDdl" value="true"/> + <property name="databasePlatform" value="org.hibernate.dialect.H2Dialect"/> + </bean> + </property> + <property name="jpaProperties"> + <props> + <prop key="hibernate.hbm2ddl.auto">create</prop> + <!-- IdGenerator Strategy : one unique number for each row for all database --> + <prop key="hibernate.id.new_generator_mappings">true</prop> + </props> + </property> + <property name="loadTimeWeaver"> + <bean class="org.springframework.instrument.classloading.InstrumentationLoadTimeWeaver"/> + </property> + </bean> + +</beans> \ No newline at end of file Modified: jpa2-validation/trunk/jsr317-jpa2/pom.xml =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/pom.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/pom.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -24,6 +24,11 @@ <!--<version>1.4.2</version>--> <!--</dependency>--> + <dependency> + <groupId>commons-lang</groupId> + <artifactId>commons-lang</artifactId> + </dependency> + <!-- SPRING --> <dependency> <groupId>org.springframework</groupId> @@ -169,6 +174,17 @@ </executions> </plugin> + <plugin> + <artifactId>maven-jar-plugin</artifactId> + <executions> + <execution> + <goals> + <goal>test-jar</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> </build> Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/config/UpdateTechnicalFieldListener.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/config/UpdateTechnicalFieldListener.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/config/UpdateTechnicalFieldListener.java 2010-12-29 16:15:42 UTC (rev 445) @@ -51,6 +51,7 @@ Date createDate = new Date(); entity.setCreateDate(createDate); + entity.setUpdateDate(createDate); if (log.isTraceEnabled()) { log.trace("PrePersist :: " + entity + " _ createDate = " + createDate); Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAO.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAO.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAO.java 2010-12-29 16:15:42 UTC (rev 445) @@ -22,7 +22,8 @@ E newInstance(); /** - * Create the {@code element}, i.e, persist it. The {@code element} need to be instantiated using {@link #newInstance()}. + * Create the {@code element}, i.e, persist it. The {@code element} need to be instantiated using {@link + * #newInstance()}. * * @param element the object to create. * @see EntityManager#persist(Object) @@ -30,8 +31,8 @@ void create(E element); /** - * Update the {@code element}. If element is not present in session, it will be retrieved from database and attached to it. The update - * is directly executed (flushed) to have proper data in resulting object. + * Update the {@code element}. If element is not present in session, it will be retrieved from database and attached + * to it. The update is directly executed (flushed) to have proper data in resulting object. * * @param element the object to update * @return the object updated attached to the session @@ -40,15 +41,17 @@ E update(E element); /** - * Save the {@code element} will create it if no id is defined or update it otherwise. Updated or created element will be returned as result. + * Save the {@code element} will create it if no id is defined or update it otherwise. Updated or created element + * will be returned as result. * - * @param element Element to save - * @return the element saved this way + * @param element Element to save + * @return the element saved this way */ E save(E element); - + /** - * Remove the {@code element}. The reference is still available after removal but the next read will return a null value using the element id. + * Remove the {@code element}. The reference is still available after removal but the next read will return a null + * value using the element id. * * @param element the object to remove */ @@ -57,7 +60,7 @@ /** * Read an element using it's {@code id}. * - * @param id Id of the element to read + * @param id Id of the element to read * @return the element if found or null otherwise */ E read(K id); @@ -72,21 +75,11 @@ /** * Return the number of existing elements. * - * @return the number of existing elements + * @return the number of existing elements */ int count(); /** - * Clear the current session. Needed after some error occurs. - */ - void clearSession(); - - /** - * Flush the current session. Needed to manually commit the session. - */ - void flushSession(); - - /** * Delete all existing elements of E type */ void deleteAll(); Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImpl.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImpl.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImpl.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,18 +1,18 @@ package org.nuiton.sandbox.jsr317.jpa2.persistence; import javax.persistence.EntityManager; -import javax.persistence.NoResultException; -import javax.persistence.NonUniqueResultException; import javax.persistence.PersistenceContext; import javax.persistence.TypedQuery; -import javax.persistence.criteria.CriteriaBuilder; -import javax.persistence.criteria.CriteriaQuery; -import javax.persistence.criteria.Path; -import javax.persistence.criteria.Root; -import java.io.Serializable; +import java.lang.reflect.ParameterizedType; import java.util.List; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntityImpl; +import org.nuiton.sandbox.jsr317.jpa2.query.CountQueryWrapper; +import org.nuiton.sandbox.jsr317.jpa2.query.EntityQueryWrapper; +import org.nuiton.sandbox.jsr317.jpa2.query.QueryWrapper; /** * This class provides basic CRUD mechanism. @@ -22,11 +22,18 @@ * @param <C> the Entity contract (interface) * @param <E> the Entity class for JPA */ -public abstract class BaseDAOImpl<C extends BaseEntity, E extends BaseEntityImpl, K extends Serializable> implements BaseDAO<C, K> { +public abstract class BaseDAOImpl<C extends BaseEntity, E extends BaseEntityImpl> implements BaseDAO<C, Long> { + protected final Log logger = LogFactory.getLog(getClass()); + public enum SaveStrategy { - PERSIST(true, false), PERSIST_FLUSH(true, true), MERGE(false, false), MERGE_FLUSH(false, true); + DEFAULT(false, false), + PERSIST(true, false), + PERSIST_FLUSH(true, true), + MERGE(false, false), + MERGE_FLUSH(false, true); + boolean flush; boolean persist; @@ -45,125 +52,21 @@ } } - protected abstract class QueryWrapper<E extends BaseEntity, R> { + /** + * EntityManager used as persistence context to manage entities. + */ + @PersistenceContext + protected EntityManager entityManager; - protected CriteriaBuilder builder; - - protected CriteriaQuery<R> criteria; - - protected Root<E> root; - - protected TypedQuery<R> query; - - public Root<E> root() { - if (root == null) { - root = criteria().from(entityClass()); - } - return root; - } - - public CriteriaQuery<R> criteria() { - if (criteria == null) { - criteria = builder().createQuery(resultClass()); - } - return criteria; - } - - public CriteriaBuilder builder() { - if (builder == null) { - builder = em.getCriteriaBuilder(); - } - return builder; - } - - public TypedQuery<R> computeCriteria() { - return em.createQuery(criteria); - } - - public TypedQuery<R> query() { - if (query == null) { - query = computeCriteria(); - } - return query; - } - - public <T> void whereEqual(Path<? extends T> propertyPath, T value) { - criteria().where( - builder().equal( - propertyPath, - value - ) - ); - } - - public <T> void whereEqual(String property, T value) { - whereEqual(root().<T>get(property), value); - } - - @SuppressWarnings({"unchecked"}) - protected Class<E> entityClass() { - // Use entityClass defined in DAO - return (Class<E>) getEntityClass(); - } - - protected abstract Class<R> resultClass(); - - } - - protected class BaseQueryWrapper<C extends BaseEntity, E extends BaseEntityImpl> extends QueryWrapper<E, E> { - - @Override - protected Class<E> resultClass() { - return entityClass(); - } - - @SuppressWarnings({"unchecked"}) - public List<C> listResult() { - List<E> results = query().getResultList(); - return (List<C>) results; - } - - @SuppressWarnings({"unchecked"}) - public C singleResult() throws NonUniqueResultException, NoResultException { - E result = query().getSingleResult(); - return (C) result; - } - } - - protected class CountQueryWrapper<E extends BaseEntity> extends QueryWrapper<E, Long> { - - public int count() { - criteria().select(builder.count(root())); - return executeCount(); - } - - public int countDistinct() { - criteria().select(builder.countDistinct(root())); - return executeCount(); - } - - protected int executeCount() { - // Create the query and retrieve the single result corresponding to the count value - TypedQuery<Long> query = computeCriteria(); - return query.getSingleResult().intValue(); - } - - @Override - protected Class<Long> resultClass() { - return Long.class; - } - } - /** - * Memorizes the Entity Class. + * Class of the interface */ - private Class<E> entityClass; + protected Class<C> interfaceClass; /** - * Private EntityManager through Hibernate implementation. + * Class of the entity implementation */ - @PersistenceContext - protected EntityManager em; + protected Class<E> entityClass; /** * The SaveStrategy defined how the save method should be executed, look at {@link #save(BaseEntity)} implementation @@ -174,10 +77,34 @@ * Constructor to be called by siblings. */ public BaseDAOImpl() { - entityClass = getEntityClass(); - saveStrategy = SaveStrategy.PERSIST; + initClasses(); + saveStrategy = SaveStrategy.DEFAULT; } + @SuppressWarnings({"unchecked"}) + private void initClasses() throws ClassCastException { + ParameterizedType genericSuperclass = (ParameterizedType) getClass().getGenericSuperclass(); + entityClass = (Class<E>) genericSuperclass.getActualTypeArguments()[1]; + interfaceClass = (Class<C>) genericSuperclass.getActualTypeArguments()[0]; + if (logger.isTraceEnabled()) { + logger.trace("Initialize classes for DAO " + getClass().getName() + + " :: entityClass = " + entityClass.getName() + + " _ interfaceClass = " + interfaceClass.getName()); + } + } + + public EntityManager getEntityManager() { + return entityManager; + } + + public Class<E> getEntityClass() { + return entityClass; + } + + public Class<C> getInterfaceClass() { + return interfaceClass; + } + public SaveStrategy getSaveStrategy() { return saveStrategy; } @@ -186,21 +113,41 @@ this.saveStrategy = saveStrategy; } + @SuppressWarnings({"unchecked"}) + @Override + public C newInstance() { + C result; + try { + // unchecked because entityClass implements interfaceClass (BaseDAOImpl implements BaseDAO) + result = (C) entityClass.newInstance(); + } catch (InstantiationException ex) { + throw new Error(ex); + } catch (IllegalAccessException ex) { + throw new Error(ex); + } + return result; + } + /** * {@inheritDoc} */ @Override public void create(C element) { - em.persist(element); + if (logger.isTraceEnabled()) { + logger.trace("Persist element type : " + element.getClass().getName()); + } + entityManager.persist(element); } /** * {@inheritDoc} */ @Override - public C update(C entity) { - C result = em.merge(entity); - em.flush(); + public C update(C element) { + if (logger.isTraceEnabled()) { + logger.trace("Merge element type : " + element.getClass().getName() + " (ID = " + element.getId() + ")"); + } + C result = entityManager.merge(element); return result; } @@ -212,16 +159,32 @@ // Keep instance by default C result = element; - // Type of save, if persist the element need to be in session for an update - if (saveStrategy.isPersist()) { - em.persist(element); - } else { - result = em.merge(element); + if (logger.isTraceEnabled()) { + logger.trace("SaveStrategy :: " + saveStrategy); } - // Explicit flush - if (saveStrategy.isFlush()) { - em.flush(); + // Default strategy use create and update methods + if (SaveStrategy.DEFAULT.equals(saveStrategy)) { + + if (element.getCreateDate() == null) { + create(element); + } else { + result = update(element); + } + + } else { + + // Type of save, if persist the element need to be in session for an update + if (saveStrategy.isPersist()) { + entityManager.persist(element); + } else { + result = entityManager.merge(element); + } + + // Explicit flush + if (saveStrategy.isFlush()) { + entityManager.flush(); + } } return result; @@ -232,9 +195,7 @@ */ @Override public void delete(final C entity) { - if (entity != null) { - em.remove(entity); - } + entityManager.remove(entity); } /** @@ -242,11 +203,11 @@ */ @SuppressWarnings({"unchecked"}) @Override - public C read(final K id) { + public C read(final Long id) { if (id == null) { return null; } - return (C) em.find(entityClass, id); + return (C) entityManager.find(entityClass, id); } /** @@ -255,7 +216,7 @@ @Override public List<C> readAll() { - BaseQueryWrapper<C, E> query = new BaseQueryWrapper<C, E>(); + EntityQueryWrapper<C, E> query = newQueryWrapper(); query.criteria().select(query.root()); @@ -266,9 +227,9 @@ protected List<C> readAllByProperty(String property, Object value) { - BaseQueryWrapper<C, E> query = new BaseQueryWrapper<C, E>(); + EntityQueryWrapper<C, E> query = newQueryWrapper(); - query.whereEqual(property, value); + query.addEqual(property, value); List<C> results = query.listResult(); @@ -286,7 +247,7 @@ */ @Override public int count() { - CountQueryWrapper<E> query = new CountQueryWrapper<E>(); + CountQueryWrapper<E> query = newCountQueryWrapper(); return query.count(); } @@ -307,16 +268,6 @@ } @Override - public void clearSession() { - em.clear(); - } - - @Override - public void flushSession() { - em.flush(); - } - - @Override public void deleteAll() { List<C> elements = readAll(); for (C element : elements) { @@ -324,33 +275,16 @@ } } - /** - * Set the limit of the {@code query} depends on {@code search} parameters. - * - * @param query Query to add limit parameters - * @param search Search containing limit parameters - */ - protected void setSearchLimit(TypedQuery<?> query, Search search) { - int start = 0; - if (search.getStartIndex() != null) { - start = search.getStartIndex(); - query.setFirstResult(start); - } + public EntityQueryWrapper<C, E> newQueryWrapper() { + return new EntityQueryWrapper<C, E>(entityManager, entityClass); + } - if (search.getEndIndex() != null) { - query.setMaxResults(search.getEndIndex() - start + 1); - } + public <R> QueryWrapper<E, R> newCustomQueryWrapper(Class<R> resultClass) { + return new QueryWrapper<E, R>(entityManager, entityClass, resultClass); } - /** - * {@inheritDoc} - */ - @Override - public abstract C newInstance(); + public CountQueryWrapper<E> newCountQueryWrapper() { + return new CountQueryWrapper<E>(entityManager, entityClass); + } - /** - * @return the entityClass to manipulate as persistent object (defined in mapping). - */ - protected abstract Class<E> getEntityClass(); - } Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImpl.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImpl.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImpl.java 2010-12-29 16:15:42 UTC (rev 445) @@ -15,19 +15,9 @@ * @version $Id$ */ @Repository -public class CustomerDAOImpl extends BaseDAOImpl<Customer, CustomerImpl, Long> implements CustomerDAO { +public class CustomerDAOImpl extends BaseDAOImpl<Customer, CustomerImpl> implements CustomerDAO { @Override - public Customer newInstance() { - return new CustomerImpl(); - } - - @Override - protected Class<CustomerImpl> getEntityClass() { - return CustomerImpl.class; - } - - @Override public Address newInstanceAddress() { return new AddressImpl(); } @@ -36,4 +26,5 @@ public AccessCode newInstanceAccessCode() { return new AccessCodeImpl(); } + } Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContext.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContext.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContext.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,5 +1,6 @@ package org.nuiton.sandbox.jsr317.jpa2.persistence; +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; import org.nuiton.sandbox.jsr317.jpa2.persistence.BaseDAOImpl.SaveStrategy; /** @@ -25,4 +26,25 @@ */ void flushSession(); + /** + * Create a new instance based on {@code pojoClass} to encapsulate given {@code id} into a proper persistent object + * needed in queries. + * + * @param entityClass Class of the pojo to instantiate + * @param id Id of this pojo + * @param <P> Type of the pojo + * @return a new instance of pojo + */ + <P extends BaseEntity> P newInstance(Class<P> entityClass, Long id); + + /** + * Retrieve the DAO corresponding to given {@code pojoClass}. + * + * @param entityClass The Class to retrieve DAO + * @param <P> Type of Pojo + * @param <D> Type of DAO + * @return the DAO corresponding + */ + <P extends BaseEntity, D extends BaseDAO<P, Long>> D getDAO(Class<P> entityClass); + } Modified: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContextImpl.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContextImpl.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/ModelContextImpl.java 2010-12-29 16:15:42 UTC (rev 445) @@ -2,8 +2,10 @@ import javax.persistence.EntityManager; import javax.persistence.PersistenceContext; +import java.util.HashMap; import java.util.Map; +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; import org.nuiton.sandbox.jsr317.jpa2.persistence.BaseDAOImpl.SaveStrategy; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationContext; @@ -24,16 +26,20 @@ @PersistenceContext protected EntityManager entityManager; - protected Map<String, BaseDAOImpl> daos; + protected Map<Class<? extends BaseEntity>, BaseDAOImpl> daos; /** * Retrieve daos from Spring applicationContext if needed. * * @return the registered DAOs */ - public Map<String, BaseDAOImpl> getDAOs() { + @SuppressWarnings({"unchecked"}) + public Map<Class<? extends BaseEntity>, BaseDAOImpl> getDAOs() { if (daos == null) { - daos = context.getBeansOfType(BaseDAOImpl.class); + daos = new HashMap<Class<? extends BaseEntity>, BaseDAOImpl>(); + for (BaseDAOImpl dao : context.getBeansOfType(BaseDAOImpl.class).values()) { + daos.put(dao.getInterfaceClass(), dao); + } } return daos; } @@ -50,4 +56,19 @@ entityManager.flush(); } + @SuppressWarnings({"unchecked"}) + @Override + public <P extends BaseEntity> P newInstance(Class<P> interfaceClass, Long id) { + BaseDAOImpl dao = getDAOs().get(interfaceClass); + BaseEntity pojo = dao.newInstance(); + pojo.setId(id); + return (P) pojo; + } + + @SuppressWarnings({"unchecked"}) + @Override + public <P extends BaseEntity, D extends BaseDAO<P, Long>> D getDAO(Class<P> interfaceClass) { + return (D) getDAOs().get(interfaceClass); + } + } Deleted: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/Search.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/Search.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/Search.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,26 +0,0 @@ -package org.nuiton.sandbox.jsr317.jpa2.persistence; - -import java.io.Serializable; - -/** - * Created on 2 nov. 2010 - * - * @author fdesbois <fdesbois@codelutin.com> - * @version $Id$ - */ -public interface Search extends Serializable { - - String getOrderBy(); - - void setOrderBy(String orderBy); - - Integer getStartIndex(); - - void setStartIndex(Integer startIndex); - - Integer getEndIndex(); - - /** @deprecated FIXME-fdesbois-2010-11-09 : criteria api need maxResults param so nbElementsByPage in PaginatedSearch */ - @Deprecated - void setEndIndex(Integer endIndex); -} Deleted: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/SearchImpl.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/SearchImpl.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/persistence/SearchImpl.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,48 +0,0 @@ -package org.nuiton.sandbox.jsr317.jpa2.persistence; - -/** - * Created on 2 nov. 2010 - * - * @author fdesbois <fdesbois@codelutin.com> - * @version $Id$ - */ -public class SearchImpl implements Search { - - public static final long serialVersionUID = 1L; - - private String orderBy; - - private Integer startIndex; - - private Integer endIndex; - - @Override - public String getOrderBy() { - return orderBy; - } - - @Override - public void setOrderBy(String orderBy) { - this.orderBy = orderBy; - } - - @Override - public Integer getStartIndex() { - return startIndex; - } - - @Override - public void setStartIndex(Integer startIndex) { - this.startIndex = startIndex; - } - - @Override - public Integer getEndIndex() { - return endIndex; - } - - @Override - public void setEndIndex(Integer endIndex) { - this.endIndex = endIndex; - } -} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/CountQueryWrapper.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/CountQueryWrapper.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/CountQueryWrapper.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,69 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.EntityManager; +import javax.persistence.TypedQuery; + +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntityImpl; + +/** + * Implementation of {@link QueryWrapper} with Long result class type used for counting. Ex : + * <pre> + * CountQueryWrapper<CustomerImpl> wrapper = new CountQueryWrapper<CustomerImpl>(entityManager, + * CustomerImpl.class); + * <p/> + * // Will retrieve all customers starting by toto + * wrapper.addPredicate( + * wrapper.builder().like( + * wrapper.root().get(Customer.PROPERTY_FIRST_NAME, "toto%") + * ) + * ); + * <p/> + * // Will retrieve the number of customers starting by toto + * int nbCustomers = wrapper.count(); + * </pre> + * <p/> + * Created on 18 nov. 2010 + * + * @param <E> Entity type + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: CountQueryWrapper.java 52639 2010-12-29 14:24:20Z fdesbois $ + */ +public class CountQueryWrapper<E extends BaseEntityImpl> extends QueryWrapper<E, Long> { + + public CountQueryWrapper(EntityManager entityManager, Class<E> entityClass) { + super(entityManager, entityClass, Long.class); + } + + /** + * Count the number of result for current criteria. + * + * @return the number of result + */ + public int count() { + criteria().select(builder.count(root())); + return executeCount(); + } + + /** + * Count the number of distinct result for current criteria. + * + * @return the number of distinct result + */ + public int countDistinct() { + criteria().select(builder.countDistinct(root())); + return executeCount(); + } + + /** + * Create the query using {@link #computeCriteria()} and execute it as single result. The Long result type is + * converted as Integer. COUNT constraint must be defined in SELECT to execute properly the counting. + * + * @return the count result for current criteria + */ + protected int executeCount() { + // Create the query and retrieve the single result corresponding to the count value + TypedQuery<Long> query = computeCriteria(); + return query.getSingleResult().intValue(); + } + +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/EntityQueryWrapper.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/EntityQueryWrapper.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/EntityQueryWrapper.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,162 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.EntityManager; +import javax.persistence.NoResultException; +import javax.persistence.NonUniqueResultException; +import javax.persistence.TypedQuery; +import javax.persistence.criteria.Expression; +import javax.persistence.criteria.Order; +import javax.persistence.criteria.Path; +import java.util.ArrayList; +import java.util.List; + +import org.apache.commons.lang.StringUtils; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntityImpl; + +/** + * EntityQueryWrapper is an extension of QueryWrapper using the entityClass as resultClass. This wrapper also provide + * safe typed method to return results with interface type and not implementation one. Ex : + * <pre> + * EntityQueryWrapper<Customer, CustomerImpl> wrapper = new EntityQueryWrapper<Customer, + * CustomerImpl>(entityManager, + * CustomerImpl.class); + * <p/> + * // Will retrieve all customers starting by toto + * wrapper.addPredicate( + * wrapper.builder().like( + * wrapper.root().get(Customer.PROPERTY_FIRST_NAME, "toto%") + * ) + * ); + * <p/> + * // Will retrieve the result list from the current query, calling the first time will compute the criteria + * List<Customer> customers = wrapper.listResult(); + * </pre> + * It's also possible to limit result using {@link #listResult(Integer, Integer)} + * <p/> + * Created on 18 nov. 2010 + * + * @param <C> Interface of the entity + * @param <E> Implementation of the entity + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: EntityQueryWrapper.java 52639 2010-12-29 14:24:20Z fdesbois $ + */ +public class EntityQueryWrapper<C extends BaseEntity, E extends BaseEntityImpl> extends QueryWrapper<E, E> { + + private static final Log logger = LogFactory.getLog(EntityQueryWrapper.class); + + // TODO-fdesbois-2010-12-29 : test if it's possible to have interfaceClass as resultClass, avoiding cast in listResult and singleResult + public EntityQueryWrapper(EntityManager entityManager, Class<E> entityClass) { + super(entityManager, entityClass, entityClass); + } + + /** + * Set the OrderBy in the query from an {@code orderByList}. Nothing will be done if the list is null. OrderBy can + * also define a referenceClass from {@link OrderBy#getReferenceClass()}, in this case, the path will be retrieved + * from the query, you must register query references using {@link #registerPath(Class, Path)} for different object + * supported. + * + * @param orderByList List of OrderBy to set + * @see OrderBy + * @see #registerPath(Class, Path) + */ + public void setOrderBy(OrderBy... orderByList) { + + if (orderByList == null) { + return; + } + + // List to add in the criteria + List<Order> orders = new ArrayList<Order>(); + + for (OrderBy orderBy : orderByList) { + + // Retrieve orderByPath from context using path() method if orderBy defined any referenceClass, otherwise + // the query root will be considered as orderByPath. + Path<?> orderByPath; + if (orderBy.getReferenceClass() != null) { + orderByPath = path(orderBy.getReferenceClass()); + } else { + orderByPath = root(); + } + + if (orderByPath == null) { + String msg = "Unknown path for OrderBy reference = " + orderBy.getReferenceClass() + "."; + if (paths != null) { + msg += " Available references are : [" + StringUtils.join(paths.keySet(), ";") + "]"; + } + throw new IllegalStateException(msg); + } + + if (logger.isDebugEnabled()) { + logger.debug("OrderBy based on rootPath type = " + orderByPath.getJavaType()); + } + + // Expression constructed for each orderBy, depends on the implementation + Expression<?> orderExpression = orderBy.getExpression(builder(), orderByPath); + + Order order; + if (orderBy.isAscending()) { + order = builder().asc(orderExpression); + } else { + order = builder().desc(orderExpression); + } + orders.add(order); + } + + criteria().orderBy(orders); + + } + + /** + * Return a result list from the current query. + * + * @return a List of results with entity interface type. + * @see TypedQuery#getResultList() + */ + @SuppressWarnings({"unchecked"}) + public List<C> listResult() { + List<E> results = query().getResultList(); + return (List<C>) results; + } + + /** + * Limit the result list with {@code startIndex} and {@code endIndex}. Values can be null. + * + * @param startIndex Index to start the result limitation + * @param endIndex Index to end the result limitation + * @return a List of limited results + * @see #listResult() + */ + public List<C> listResult(Integer startIndex, Integer endIndex) { + + int start = 0; + if (startIndex != null) { + start = startIndex; + query().setFirstResult(start); + } + + if (endIndex != null) { + query().setMaxResults(endIndex - start + 1); + } + + return listResult(); + } + + /** + * Return a single result from the current query. + * + * @return a single result with entity interface type + * @throws NonUniqueResultException for multiple results error + * @throws NoResultException for no result error + * @see TypedQuery#getSingleResult() + */ + @SuppressWarnings({"unchecked"}) + public C singleResult() throws NonUniqueResultException, NoResultException { + E result = query().getSingleResult(); + return (C) result; + } + +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderBy.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderBy.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderBy.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,42 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.criteria.CriteriaBuilder; +import javax.persistence.criteria.Expression; +import javax.persistence.criteria.Path; + +/** + * Api used to defined ordering in {@link Search} context. You can use different implementations : <ul> <li>{@link + * OrderByAsc} : simple ascending order</li> <li>{@link OrderByDesc} : simple descending order</li> <li>{@link + * OrderByRandom} : random order</li> </ul> + * <p/> + * Created on 17 nov. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: OrderBy.java 49443 2010-11-24 17:16:59Z fdesbois $ + */ +public interface OrderBy { + + /** + * Retrieve expression for criteria api based on {@code rootPath}. + * + * @param criteriaBuilder Criteria builder could be useful to create the expression + * @param rootPath Root path needed to retrieve expression + * @return the expression to use in criteria api + */ + Expression<?> getExpression(CriteriaBuilder criteriaBuilder, Path<?> rootPath); + + /** + * Flag used to check order type (ascending or descending) + * + * @return true if ascending order is defined, false for descending order + */ + boolean isAscending(); + + /** + * Reference class of the orderBy properties + * + * @return the base class for orderBy properties + */ + Class<?> getReferenceClass(); + +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByAsc.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByAsc.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByAsc.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,90 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.criteria.CriteriaBuilder; +import javax.persistence.criteria.Expression; +import javax.persistence.criteria.Path; +import java.util.Arrays; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +/** + * Ascending OrderBy. + * <p/> + * Created on 17 nov. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: OrderByAsc.java 51603 2010-12-15 15:09:17Z fdesbois $ + */ +public class OrderByAsc implements OrderBy { + + protected final Log logger = LogFactory.getLog(getClass()); + + protected String[] properties; + + protected boolean ascending; + + protected Class<?> referenceClass; + + /** + * Create OrderByAsc creating propertyPath by concatenation of all {@code properties}. Ex : new + * OrderByAsc("classifiedAd", "realEstate") will result as : rootPath.get("classifiedAd").get("realEstate") + * + * @param properties String to concatenate creating the ordering property for query. It's better to use property + * constants defined in each Pojo interface. + */ + public OrderByAsc(String... properties) { + this.properties = properties; + ascending = true; + } + + /** + * Create OrderByAsc creating propertyPath by concatenation of all {@code properties} based on {@code + * referenceClass} pojo. Ex : new OrderByAsc(VideoPartnerLocation.class, "highlighted") will result as : + * videoPartnerLocationPath.get("highlighted"). This case is specific, so dao method need to check referenceClass to + * ensure the path when {@link #getExpression(CriteriaBuilder, Path)} method is used. + * + * @param referenceClass Class reference for properties otherwise the default one from DAO will be used. + * @param properties String to concatenate creating the ordering property for query. It's better to use property + * constants defined in each Pojo interface. + */ + public OrderByAsc(Class<?> referenceClass, String... properties) { + this(properties); + this.referenceClass = referenceClass; + } + + @Override + public Class<?> getReferenceClass() { + return referenceClass; + } + + @Override + public Expression<?> getExpression(CriteriaBuilder criteriaBuilder, Path<?> rootPath) { + Path<?> path = rootPath; + for (String property : properties) { + + if (logger.isDebugEnabled()) { + logger.debug("OrderBy property = " + property); + } + + path = path.get(property); + } + return path; + } + + @Override + public boolean isAscending() { + return ascending; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder("[OrderBy"). + append(ascending ? "Asc" : "Desc"). + append("] properties = "). + append(Arrays.toString(properties)). + append(" _ referenceClass = "). + append(referenceClass); + return builder.toString(); + } +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByDesc.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByDesc.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByDesc.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,28 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +/** + * Descending OrderBy. + * <p/> + * Created on 17 nov. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: OrderByDesc.java 49443 2010-11-24 17:16:59Z fdesbois $ + */ +public class OrderByDesc extends OrderByAsc { + + /** + * {@inheritDoc} for Desc ordering + */ + public OrderByDesc(String... properties) { + super(properties); + ascending = false; + } + + /** + * {@inheritDoc} for Desc ordering + */ + public OrderByDesc(Class<?> referenceClass, String... properties) { + super(referenceClass, properties); + ascending = false; + } +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByRandom.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByRandom.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/OrderByRandom.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,52 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.criteria.CriteriaBuilder; +import javax.persistence.criteria.Expression; +import javax.persistence.criteria.Path; + +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; + +/** + * Random OrderBy. This OrderBy use a specific expression to calculate random based on a randomKey. + * <p/> + * Created on 17 nov. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: OrderByRandom.java 51603 2010-12-15 15:09:17Z fdesbois $ + */ +public class OrderByRandom implements OrderBy { + + private long randomKey; + + public OrderByRandom(long randomKey) { + this.randomKey = randomKey; + } + + @Override + public Expression<?> getExpression(CriteriaBuilder criteriaBuilder, Path<?> rootPath) { + // product = id * randomKey + Expression<Long> product = criteriaBuilder.prod(rootPath.<Long>get(BaseEntity.PROPERTY_ID), randomKey); + // modulo = product % 97 + Expression<Integer> modulo = criteriaBuilder.mod(criteriaBuilder.toInteger(product), 97); + // (id * randomKey) % 97 + return modulo; + } + + @Override + public boolean isAscending() { + // No ascending definition is needed for random + return true; + } + + @Override + public Class<?> getReferenceClass() { + return null; + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder("[OrderByRandom] key = ").append(randomKey); + return builder.toString(); + } + +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationData.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationData.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationData.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,209 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import java.io.Serializable; + +/** + * Simple bean to transport pagination data. Those data is necessary for any pagination. Generally, the {@link + * #PaginationData(int, int, int)} is used to set {@code nbElementsByPage}, {@code currentPage} and {@code + * nbPagesToRetrieve}, then {@code nbPages}, {@code nbElements}, {@code startIndex} and {@code endIndex} will be + * calculated from {@link #compute(int)} with given nbResults. + * <p/> + * Created on 15/12/10 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: PaginationData.java 52218 2010-12-22 14:37:02Z fdesbois $ + */ +public class PaginationData implements Serializable { + + public static final long serialVersionUID = 1L; + + private int currentPage = 1; + + private int nbPagesToRetrieve = 1; + + private int nbElementsByPage; + + private int nbResults; + + private int nbPages; + + private int maxAvailablePages; + + private int nbElements; + + private Integer startIndex; + + private Integer endIndex; + + /** + * Constructor of PaginationData, can't be initialized without giving {@code nbElementsByPage}, otherwise, this data + * can't be used. Default currentPage is 1 and nbPagesToRetrieve is 1 to retrieve first page results. + * + * @param nbElementsByPage Number of elements to display on each page. + */ + public PaginationData(int nbElementsByPage) { + this.nbElementsByPage = nbElementsByPage; + } + + /** + * Constructor of PaginationData with necessary {@code nbElementsByPage}. {@code currentPage} and {@code + * nbPagesToRetrieve} is also set to initialize properly the data at a given point and not from the beginning by + * default (currentPage = 1 and nbPagesToRetrieve = 1). + * + * @param nbElementsByPage Number of elements to display on each page. + * @param currentPage Current page to start + * @param nbPagesToRetrieve Number of pages to retrieve + * @see #PaginationData(int) + */ + public PaginationData(int nbElementsByPage, int currentPage, int nbPagesToRetrieve) { + this(nbElementsByPage); + this.currentPage = currentPage; + this.nbPagesToRetrieve = nbPagesToRetrieve; + } + + /** + * @return Current page to use : could be set in constructor {@link #PaginationData(int, int, int)}, default will be + * 1 + */ + public int getCurrentPage() { + return currentPage; + } + + /** + * @return Number of pages to retrieve : could be set in constructor {@link #PaginationData(int, int, int)}, default + * will be 1 + */ + public int getNbPagesToRetrieve() { + return nbPagesToRetrieve; + } + + /** + * @return Number of elements to display on each page : need to be set in one of the constructor + */ + public int getNbElementsByPage() { + return nbElementsByPage; + } + + /** + * @return Number of total existing results : need to be set using {@link #compute(int)} + */ + public int getNbResults() { + return nbResults; + } + + /** + * @return Number of total pages calculated on {@link #compute(int)} call (nbResults / nbElementsByPage) + */ + public int getNbPages() { + return nbPages; + } + + /** + * @return Number of available pages from current one calculated on {@link #compute(int)} call (nbPages - + * currentPage + 1) + */ + public int getMaxAvailablePages() { + return maxAvailablePages; + } + + /** + * @return Number of current elements calculated on {@link #compute(int)} call (nbPagesToRetrieve * + * nbElementsByPage) + */ + public int getNbElements() { + return nbElements; + } + + /** + * @return Start index of elements calculated on {@link #compute(int)} call (0 is the minimum, could be null) + */ + public Integer getStartIndex() { + return startIndex; + } + + /** + * @return End index of elements calculated on {@link #compute(int)} call (nbResults - 1 is the maximum, could be + * null) + */ + public Integer getEndIndex() { + return endIndex; + } + + /** + * Compute the data validating needed nbResults and nbElementsByPage for pagination and ensure bounds for + * currentPage and nbPagesToRetrieve. nbPages and maxAvailablePages will be updated. + * + * @param nbResults Number of results to compute the data + * @throws IllegalArgumentException if nbResults or nbElementsByPage can't be used (not positive) + */ + public void compute(int nbResults) throws IllegalArgumentException { + + if (nbResults < 0) { + throw new IllegalArgumentException("Pagination can't be computed if nbResults is not positive"); + } + + this.nbResults = nbResults; + + if (nbElementsByPage < 1) { + throw new IllegalArgumentException("Pagination can't be computed if nbElementsByPage is not positive"); + } + + // First step : calculate nbPages + Double computedValue = Math.ceil((double) nbResults / (double) nbElementsByPage); + nbPages = computedValue.intValue(); + + // Second step : update currentPage to avoid outOfBounds + if (currentPage > nbPages) { + currentPage = nbPages; + } + if (currentPage < 1) { + currentPage = 1; + } + + // Third step : calculate nbPagesToRetrieve depends on maxAvailablePages + maxAvailablePages = nbPages == 0 ? 0 : nbPages - currentPage + 1; + + if (nbPagesToRetrieve > maxAvailablePages) { + nbPagesToRetrieve = maxAvailablePages; + } + if (nbPagesToRetrieve < 1) { + nbPagesToRetrieve = 1; + } + + // Fourth step : calculate indexes + + // Number of elements to retrieve + if (nbResults != 0) { + nbElements = nbPagesToRetrieve * nbElementsByPage; + // Index to begin + startIndex = (currentPage - 1) * nbElementsByPage; + // Index to end + endIndex = startIndex + nbElements - 1; + + // UpperBound available + if (endIndex > nbResults) { + endIndex = nbResults; + } + + } else { + nbElements = 0; + startIndex = null; + endIndex = null; + } + } + + @Override + public String toString() { + return "PaginationData{" + + "currentPage=" + currentPage + + ", nbPagesToRetrieve=" + nbPagesToRetrieve + + ", nbElementsByPage=" + nbElementsByPage + + ", nbResults=" + nbResults + + ", nbPages=" + nbPages + + ", maxAvailablePages=" + maxAvailablePages + + ", nbElements=" + nbElements + + ", startIndex=" + startIndex + + ", endIndex=" + endIndex + + '}'; + } +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/QueryWrapper.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/QueryWrapper.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/QueryWrapper.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,316 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import javax.persistence.Entity; +import javax.persistence.EntityManager; +import javax.persistence.TypedQuery; +import javax.persistence.criteria.AbstractQuery; +import javax.persistence.criteria.CriteriaBuilder; +import javax.persistence.criteria.CriteriaQuery; +import javax.persistence.criteria.From; +import javax.persistence.criteria.Path; +import javax.persistence.criteria.Predicate; +import javax.persistence.criteria.Root; +import javax.persistence.criteria.Subquery; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntityImpl; + +/** + * QueryWrapper is used to contain instances used to create a query with Criteria Api. {@link #base()} is the main + * element where QL statements are called (WHERE, FROM, ORDER_BY, ...), then you need {@link #builder()} to create + * predicate expressions to use in criteria. The {@link #root()} element is also available depends on E type which + * extend the {@link BaseEntityImpl} type. Then you can retrieve {@link TypedQuery} based on criteria created using + * {@link #computeCriteria()} method or {@link #query()} if already defined. + * <p/> + * The simple way to use this wrapper is to add predicates using {@link #addPredicate(Predicate)} method and then + * execute the query retrieved using {@link #computeCriteria()}. Each predicate could be created using {@link + * #builder()} and {@link #root()} to create property paths. Ex : + * <pre> + * QueryWrapper<Customer, Customer> wrapper = new QueryWrapper<Customer, Customer>(entityManager, + * Customer.class, + * Customer.class); + * <p/> + * // Will retrieve all customers starting by toto + * wrapper.addPredicate( + * wrapper.builder().like( + * wrapper.root().get(Customer.PROPERTY_FIRST_NAME, "toto%") + * ) + * ); + * <p/> + * // Calling query() the first time will compute the criteria, each next calling will keep the same query + * List<Customer> customers = wrapper.query().getResultList(); + * </pre> + * <p/> + * Created on 18 nov. 2010 + * + * @param <E> EntityClass defined in DAO + * @param <R> ResultClass for TypedQuery + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: QueryWrapper.java 52639 2010-12-29 14:24:20Z fdesbois $ + * @see EntityQueryWrapper + * @see CountQueryWrapper + */ +public class QueryWrapper<E extends BaseEntityImpl, R> { + + private static final Log logger = LogFactory.getLog(QueryWrapper.class); + + /** + * {@link EntityManager} to retrieve {@link CriteriaBuilder} and construct the resulting {@link TypedQuery} + */ + protected EntityManager entityManager; + + /** + * {@link Entity} class where the query is based on ({@link Root} element as first {@link From}) + */ + protected Class<E> entityClass; + + /** + * Result class for {@link CriteriaQuery} and resulting {@link TypedQuery} + */ + protected Class<R> resultClass; + + /** + * Builder used to add constraints in the query + */ + protected CriteriaBuilder builder; + + /** + * Criteria where clauses are added (FROM, WHERE, SELECT, ...) + */ + protected CriteriaQuery<R> criteria; + + protected AbstractQuery<R> base; + + /** + * Root element based on {@link Entity} class + */ + protected From<?, E> root; + + protected Map<Class<?>, Path<?>> paths; + + /** + * Resulting query to execute based on result class + */ + protected TypedQuery<R> query; + + /** + * List of current predicates to add to the query (on {@link #computeCriteria()} ) + */ + protected List<Predicate> predicates; + + public QueryWrapper(EntityManager entityManager, Class<E> entityClass, Class<R> resultClass) { + this.entityManager = entityManager; + this.entityClass = entityClass; + this.resultClass = resultClass; + } + + /** + * CriteriaBuilder element used to create predicate expression for criteria. + * + * @return the CriteriaBuilder + */ + public CriteriaBuilder builder() { + if (builder == null) { + builder = entityManager.getCriteriaBuilder(); + } + return builder; + } + + /** + * CriteriaQuery element used to apply QL clauses (WHERE, FROM, ...). It's better to use {@link #base()} method if + * you don't need specific treatment on {@link CriteriaQuery} type. + * + * @return the Criteria based on resultClass + * @see #base() + */ + public CriteriaQuery<R> criteria() { + if (criteria == null) { + criteria = builder().createQuery(resultClass); + } + return criteria; + } + + /** + * Retrieve base {@link AbstractQuery} of the wrapper, could be a {@link CriteriaQuery} or a {@link Subquery}. If + * not manually defined using {@link #setBase(AbstractQuery)}, the default criteria will be created using {@link + * #criteria()}. It seems better to use this method as far as possible instead of {@link #criteria()} to manage also + * subqueries if needed. + * + * @return the {@link AbstractQuery} base of the wrapper + * @see #criteria() + * @see #setBase(AbstractQuery) + */ + public AbstractQuery<R> base() { + if (base == null) { + base = criteria(); + } + return base; + } + + /** + * Set the base asbtractQuery to use it for all operations (from, where, ...). You can set a {@link Subquery} as + * base element to manipulate in into the wrapper. All methods on predicates and path will be available but if you + * need a criteria you have to retrieve it from the main query otherwise it occurs some errors on {@link + * #computeCriteria()} method or {@link #query()}. If you use {@link #addPredicate(Predicate)} method you need to + * manually compute all predicates at the end of the treatment using {@link #computePredicates()}. + * + * @param base Base {@link AbstractQuery} to set, generally a {@link Subquery} + */ + public void setBase(AbstractQuery<R> base) { + this.base = base; + } + + /** + * Root element which is the main From entity based on {@code entityClass}. + * + * @return the Root typed as entityClass + */ + public From<?, E> root() { + if (root == null) { + root = base().from(entityClass); + } + return root; + } + + /** + * Set manually the root element of the query. + * + * @param root From element used as main root + */ + public void setRoot(From<?, E> root) { + this.root = root; + } + + /** + * Register a {@code path} for the {@code referenceClass}. This could be useful to keep getPath context during all + * the query creation. Retrieve getPath using {@link #path(Class)} method. + * + * @param referenceClass Class to associate the specified getPath + * @param path Path corresponding to the referenceClass + */ + public void registerPath(Class<?> referenceClass, Path<?> path) { + if (paths == null) { + paths = new HashMap<Class<?>, Path<?>>(); + } + paths.put(referenceClass, path); + } + + /** + * Retrieve a path for the {@code referenceClass}. This will return null if referenceClass is not previously + * registered using {@link #registerPath(Class, Path)}. Root path could simply be retrieved using {@link #root()}. + * + * @param referenceClass Reference Class to retrieve the corresponding path + * @return the Path corresponding to the reference class + */ + public Path<?> path(Class<?> referenceClass) { + return paths != null ? paths.get(referenceClass) : null; + } + + /** + * Add all registered predicates to the {@link #base()} query in WHERE clause. + * + * @see #addPredicate(Predicate) + */ + public void computePredicates() { + if (predicates != null) { + base().where(predicates.toArray(new Predicate[predicates.size()])); + } + } + + /** + * Create a TypedQuery from the current criteria. Predicate list will be added to the where of the query. You can + * also call {@link #query()} to avoid computing criteria each time and so retrieve the current query. + * + * @return a TypedQuery + * @throws NullPointerException if criteria is null, must use {@link #criteria()} method before compute it. + */ + public TypedQuery<R> computeCriteria() { + computePredicates(); + query = entityManager.createQuery(criteria); + return query; + } + + /** + * Retrieve the current TypedQuery. The query will be computed once based on current criteria if it's not manually + * done using {@link #computeCriteria()}. + * + * @return the current TypedQuery + * @see #computeCriteria() + */ + public TypedQuery<R> query() { + if (query == null) { + computeCriteria(); + } + return query; + } + + /** + * Add a predicate to the current list. This predicate will be add to the where clause of the query on {@link + * #computePredicates()}. The computing will be automatically done on query execution with {@link #query()} or + * {@link #computeCriteria()}. + * + * @param predicate New predicate to add to the query + * @see #query() + */ + public void addPredicate(Predicate predicate) { + if (predicates == null) { + predicates = new ArrayList<Predicate>(); + } + predicates.add(predicate); + } + + /** + * Add an equal predicate to the query : {@code propertyPath} = {@code value}. If value is null, the isNull + * predicate will be added for the {@code propertyPath}. + * + * @param propertyPath Path to access the property + * @param value Value of this property in the query + * @param <T> Type of the property + * @return Predicate constructed this way (already added to the query) + */ + public <T> Predicate addEqual(Path<? extends T> propertyPath, T value) { + + Predicate equalPredicate; + + if (value == null) { + equalPredicate = builder().isNull(propertyPath); + } else { + equalPredicate = builder().equal(propertyPath, value); + } + + addPredicate(equalPredicate); + + return equalPredicate; + } + + /** + * Add an equal predicate to the query : {@code property} = {@code value}. If value is null, the isNull predicate + * will be added for the {@code property}. + * + * @param property Attribute name of the root entity to apply the constraint + * @param value Value of this property in the query + * @param <T> Type of the property + * @return Predicate constructed this way (already added to the query) + */ + public <T> Predicate addEqual(String property, T value) { + return addEqual(root().<T>get(property), value); + } + + /** + * Add or predicate to the query : predicate1 OR predicate2 OR ... + * + * @param predicates List of predicate to add as OR predicate + * @return Predicate constructed this way (already added to the query) + */ + public Predicate addOr(List<Predicate> predicates) { + Predicate orPredicate = builder().or(predicates.toArray(new Predicate[predicates.size()])); + addPredicate(orPredicate); + return orPredicate; + } + +} Added: jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/Search.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/Search.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/query/Search.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,49 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import java.util.List; + +/** + * Created on 2 nov. 2010 + * + * @author fdesbois <fdesbois@codelutin.com> + * @version $Id: Search.java 433 2010-11-12 17:53:20Z fdesbois $ + */ +public class Search { + + public static final long serialVersionUID = 1L; + + private OrderBy[] orderBy; + + private Integer startIndex; + + private Integer endIndex; + + public OrderBy[] getOrderBy() { + return orderBy; + } + + public void setOrderBy(OrderBy... orderBy) { + this.orderBy = orderBy; + } + + public void setOrderBy(List<OrderBy> orderBys) { + setOrderBy(orderBys.toArray(new OrderBy[orderBys.size()])); + } + + public Integer getStartIndex() { + return startIndex; + } + + public void setStartIndex(Integer startIndex) { + this.startIndex = startIndex; + } + + public Integer getEndIndex() { + return endIndex; + } + + public void setEndIndex(Integer endIndex) { + this.endIndex = endIndex; + } + +} Modified: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/EntityManagerTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/EntityManagerTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/EntityManagerTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -2,12 +2,13 @@ import javax.persistence.PersistenceException; import javax.persistence.Query; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.junit.After; import org.junit.Assert; import org.junit.Test; -import org.nuiton.sandbox.jsr317.jpa2.test.BaseTest; +import org.nuiton.sandbox.jsr317.jpa2.test.BaseJpaTest; import org.springframework.test.annotation.Rollback; import org.springframework.transaction.annotation.Transactional; @@ -17,7 +18,7 @@ * @author fdesbois <florian.desbois@wiztivi.com> * @version $Id$ */ -public class EntityManagerTest extends BaseTest { +public class EntityManagerTest extends BaseJpaTest { private static final Log log = LogFactory.getLog(EntityManagerTest.class); @@ -40,42 +41,42 @@ user.setLastName("lastName"); user.setFirstName("firstName"); - em.persist(user); + entityManager.persist(user); long userId = user.getId(); log.debug("Created entity with id " + userId + " at " + user.getCreateDate()); // Entity is still in the EntityManager - Assert.assertTrue(em.contains(user)); + Assert.assertTrue(entityManager.contains(user)); // Flush session to insert the entity before detach it - em.flush(); + entityManager.flush(); // Detach the entity to find it from database - em.detach(user); - Assert.assertFalse(em.contains(user)); + entityManager.detach(user); + Assert.assertFalse(entityManager.contains(user)); // Object not attached to the entityManager, a query will be called - Customer userFound = em.find(CustomerImpl.class, userId); + Customer userFound = entityManager.find(CustomerImpl.class, userId); // Check data Assert.assertNotNull(userFound); Assert.assertNotNull(userFound.getId()); Assert.assertEquals(0, userFound.getVersion()); Assert.assertNotNull(userFound.getCreateDate()); - Assert.assertNull(userFound.getUpdateDate()); + Assert.assertNotNull(userFound.getUpdateDate()); Assert.assertEquals("lastName", userFound.getLastName()); Assert.assertEquals("firstName", userFound.getFirstName()); // Update name, check version changed userFound.setLastName("nameChanged"); - em.merge(userFound); + entityManager.merge(userFound); // Version not changed before commit (or manual flush) - userFound = em.find(CustomerImpl.class, userId); + userFound = entityManager.find(CustomerImpl.class, userId); Assert.assertEquals(0, userFound.getVersion()); Assert.assertEquals("nameChanged", userFound.getLastName()); - em.flush(); + entityManager.flush(); // Version is updated Assert.assertEquals(1, userFound.getVersion()); @@ -91,27 +92,27 @@ user1.setLastName("lastName1"); user1.setFirstName("firstName1"); - em.persist(user1); + entityManager.persist(user1); Customer user2 = new CustomerImpl(); user2.setLastName("lastName2"); user2.setFirstName("firstName2"); - em.persist(user2); + entityManager.persist(user2); // ---- EXECUTE ---- // String readAllCustomersQuery = new StringBuilder("FROM ").append(CustomerImpl.class.getSimpleName()).toString(); // Create named query to check all existing accounts - Query query = em.createQuery(readAllCustomersQuery); + Query query = entityManager.createQuery(readAllCustomersQuery); Assert.assertEquals(2, query.getResultList().size()); // Delete all data from AccountImpl userDAO.deleteAll(); // Create named query to check all existing accounts - query = em.createQuery(readAllCustomersQuery); + query = entityManager.createQuery(readAllCustomersQuery); Assert.assertEquals(0, query.getResultList().size()); } @@ -123,11 +124,11 @@ user.setLastName("lastName"); user.setFirstName("firstName"); - em.persist(user); + entityManager.persist(user); - em.detach(user); + entityManager.detach(user); - em.persist(user); + entityManager.persist(user); } @Test @@ -138,14 +139,14 @@ user.setLastName("lastName"); user.setFirstName("firstName"); - em.persist(user); + entityManager.persist(user); // Flush session to insert the entity before detach it - em.flush(); + entityManager.flush(); - em.detach(user); + entityManager.detach(user); - em.merge(user); + entityManager.merge(user); } @Test @@ -156,14 +157,14 @@ user.setLastName("lastName"); user.setFirstName("firstName"); - Customer userCreated = em.merge(user); + Customer userCreated = entityManager.merge(user); // Flush session to insert the entity before detach it - em.flush(); + entityManager.flush(); - em.detach(userCreated); + entityManager.detach(userCreated); - em.merge(userCreated); + entityManager.merge(userCreated); } @Test @@ -175,14 +176,14 @@ user.setFirstName("firstName"); // Persist the user - em.persist(user); + entityManager.persist(user); // Create a new bean with existing id Customer userToUpdate = new CustomerImpl(); userToUpdate.setId(user.getId()); userToUpdate.setLastName("newLastName"); - Customer userUpdated = em.merge(userToUpdate); + Customer userUpdated = entityManager.merge(userToUpdate); // All data are updated, so firstName becomes NULL Assert.assertNull(userUpdated.getFirstName()); Assert.assertEquals("newLastName", userUpdated.getLastName()); Modified: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/MetaModelTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/MetaModelTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/entity/MetaModelTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -2,7 +2,7 @@ import org.junit.Assert; import org.junit.Test; -import org.nuiton.sandbox.jsr317.jpa2.test.BaseTest; +import org.nuiton.sandbox.jsr317.jpa2.test.BaseJpaTest; /** * Created on 26 nov. 2010 @@ -10,7 +10,7 @@ * @author fdesbois <florian.desbois@wiztivi.com> * @version $Id$ */ -public class MetaModelTest extends BaseTest { +public class MetaModelTest extends BaseJpaTest { @Test public void testEmbeddableSingularAttribute() { @@ -19,8 +19,8 @@ Assert.assertNotNull(AccessCodeImpl_.password); // Broken with Hibernate 3.6 and MetamodelGenerator 1.1 - Assert.assertNotNull(AddressImpl_.town); - Assert.assertNotNull(AddressImpl_.country); +// Assert.assertNotNull(AddressImpl_.town); +// Assert.assertNotNull(AddressImpl_.country); } } Modified: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImplTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImplTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/BaseDAOImplTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,14 +1,15 @@ package org.nuiton.sandbox.jsr317.jpa2.persistence; import java.util.List; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; + +import org.junit.After; import org.junit.Assert; import org.junit.Test; import org.nuiton.sandbox.jsr317.jpa2.entity.Customer; import org.nuiton.sandbox.jsr317.jpa2.entity.CustomerImpl; import org.nuiton.sandbox.jsr317.jpa2.persistence.BaseDAOImpl.SaveStrategy; -import org.nuiton.sandbox.jsr317.jpa2.test.BaseTest; +import org.nuiton.sandbox.jsr317.jpa2.test.BaseJpaTest; +import org.springframework.test.annotation.Rollback; import org.springframework.transaction.annotation.Transactional; /** @@ -19,13 +20,13 @@ * @author fdesbois <florian.desbois@codelutin.com> * @version $Id$ */ -public class BaseDAOImplTest extends BaseTest { +public class BaseDAOImplTest extends BaseJpaTest { - private static final Log log = LogFactory.getLog(BaseDAOImplTest.class); - - @Override - protected boolean autoDataEnabled() { - return true; + @After + @Transactional + @Rollback(false) + public void tearDown() throws Exception { + userDAO.deleteAll(); } @Test @@ -38,17 +39,17 @@ user.setFirstName("createFirstName"); // ---- EXECUTE ---- // - log.info("CREATE user " + user); + logger.info("CREATE user " + user); userDAO.create(user); - log.debug("AFTER CREATE user " + user); + logger.debug("AFTER CREATE user " + user); // ---- CHECK DATA ---- // Assert.assertNotNull(user.getId()); Assert.assertNotNull(user.getCreateDate()); - Assert.assertNull(user.getUpdateDate()); + Assert.assertNotNull(user.getUpdateDate()); Assert.assertEquals(0, user.getVersion()); - Customer userFound = em.find(CustomerImpl.class, user.getId()); + Customer userFound = entityManager.find(CustomerImpl.class, user.getId()); Assert.assertNotNull(userFound); Assert.assertEquals("createLastName", userFound.getLastName()); Assert.assertEquals("createFirstName", userFound.getFirstName()); @@ -63,20 +64,21 @@ user.setLastName("updateLastName"); user.setFirstName("updateFirstName"); - em.persist(user); - em.flush(); - em.detach(user); + entityManager.persist(user); + entityManager.flush(); + entityManager.detach(user); // ---- EXECUTE ---- // user.setLastName("nameUpdated"); - log.info("UPDATE user " + user); + logger.info("UPDATE user " + user); Customer userUpdated = userDAO.update(user); - log.debug("AFTER UPDATE user " + userUpdated); + logger.debug("AFTER UPDATE user " + userUpdated); // ---- CHECK DATA ---- // - Assert.assertFalse(em.contains(user)); - Assert.assertTrue(em.contains(userUpdated)); + Assert.assertFalse(entityManager.contains(user)); + Assert.assertTrue(entityManager.contains(userUpdated)); + entityManager.flush(); Assert.assertNotNull(userUpdated.getUpdateDate()); Assert.assertEquals(1, userUpdated.getVersion()); Assert.assertEquals("nameUpdated", userUpdated.getLastName()); @@ -100,7 +102,7 @@ // ## CREATE ## // Customer userCreated = userDAO.save(user); - if (!strategy.isPersist()) { + if (strategy != SaveStrategy.DEFAULT && !strategy.isPersist()) { // Same as a create instead of returning the instance instead of modifying the input one Assert.assertNotSame(user, userCreated); } else { @@ -109,7 +111,7 @@ Assert.assertNotNull(userCreated.getId()); Assert.assertNotNull(userCreated.getCreateDate()); - Assert.assertNull(userCreated.getUpdateDate()); + Assert.assertNotNull(userCreated.getUpdateDate()); Assert.assertEquals(0, userCreated.getVersion()); // ## UPDATE ## // @@ -123,10 +125,10 @@ Assert.assertEquals(1, userUpdated.getVersion()); } else { - Assert.assertNull(userUpdated.getUpdateDate()); + Assert.assertNotNull(userUpdated.getUpdateDate()); Assert.assertEquals(0, userUpdated.getVersion()); // need explicit Flush - userDAO.flushSession(); + entityManager.flush(); } // Other update no change, no version increment @@ -134,7 +136,6 @@ Assert.assertEquals(1, userUpdatedTwice.getVersion()); } - @Test @Transactional public void testDelete() throws Exception { @@ -144,15 +145,15 @@ user.setLastName("deleteLastName"); user.setFirstName("deleteFirstName"); - em.persist(user); + entityManager.persist(user); // ---- EXECUTE ---- // - log.info("DELETE account " + user); + logger.info("DELETE account " + user); userDAO.delete(user); - log.debug("AFTER DELETE account " + user); + logger.debug("AFTER DELETE account " + user); // ---- CHECK DATA ---- // - Customer accountFound = em.find(CustomerImpl.class, user.getId()); + Customer accountFound = entityManager.find(CustomerImpl.class, user.getId()); Assert.assertNull(accountFound); } @@ -165,10 +166,10 @@ account.setLastName("readLastName"); account.setFirstName("readFirstName"); - em.persist(account); + entityManager.persist(account); // ---- EXECUTE ---- // - log.info("READ account " + account); + logger.info("READ account " + account); Customer accountFound = userDAO.read(account.getId()); // ---- CHECK DATA ---- // @@ -185,16 +186,16 @@ user1.setLastName("readAllLastName1"); user1.setFirstName("readAllFirstName1"); - em.persist(user1); + entityManager.persist(user1); Customer user2 = new CustomerImpl(); user2.setLastName("readAllLastName2"); user2.setFirstName("readAllFirstName2"); - em.persist(user2); + entityManager.persist(user2); // ---- EXECUTE ---- // - log.info("READ_ALL accounts"); + logger.info("READ_ALL accounts"); List<Customer> users = userDAO.readAll(); // ---- CHECK DATA ---- // @@ -212,16 +213,16 @@ user1.setLastName("readAllLastName1"); user1.setFirstName("readAllFirstName1"); - em.persist(user1); + entityManager.persist(user1); Customer user2 = new CustomerImpl(); user2.setLastName("readAllLastName2"); user2.setFirstName("readAllFirstName2"); - em.persist(user2); + entityManager.persist(user2); // ---- EXECUTE ---- // - log.info("COUNT accounts"); + logger.info("COUNT accounts"); int count = userDAO.count(); // ---- CHECK DATA ---- // @@ -233,11 +234,12 @@ public void testNewInstance() throws Exception { // ---- EXECUTE ---- // - log.info("NEW_INSTANCE account"); + logger.info("NEW_INSTANCE account"); Customer user = userDAO.newInstance(); // ---- CHECK DATA ---- // Assert.assertNotNull(user); Assert.assertEquals(CustomerImpl.class, user.getClass()); } + } Modified: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImplTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImplTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/persistence/CustomerDAOImplTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -9,8 +9,9 @@ import org.nuiton.sandbox.jsr317.jpa2.config.JpaHelper; import org.nuiton.sandbox.jsr317.jpa2.entity.Address; import org.nuiton.sandbox.jsr317.jpa2.entity.Customer; +import org.nuiton.sandbox.jsr317.jpa2.sample.UseDataProvider; import org.nuiton.sandbox.jsr317.jpa2.test.AddressFake; -import org.nuiton.sandbox.jsr317.jpa2.test.BaseTest; +import org.nuiton.sandbox.jsr317.jpa2.test.BaseJpaTest; import org.springframework.transaction.annotation.Transactional; /** @@ -19,13 +20,9 @@ * @author fdesbois <florian.desbois@codelutin.com> * @version $Id$ */ -public class CustomerDAOImplTest extends BaseTest { +@UseDataProvider +public class CustomerDAOImplTest extends BaseJpaTest { - @Override - protected boolean autoDataEnabled() { - return true; - } - @Test @Transactional public void testCreateCustomerWithAddress() { Added: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationDataTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationDataTest.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/query/PaginationDataTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,112 @@ +package org.nuiton.sandbox.jsr317.jpa2.query; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.junit.Assert; +import org.junit.Test; + +/** + * Created on 4 nov. 2010 + * + * @author fdesbois <florian.desbois@wiztivi.com> + * @version $Id: PaginationDataTest.java 51940 2010-12-17 17:22:32Z fdesbois $ + */ +public class PaginationDataTest { + + private static final Log logger = LogFactory.getLog(PaginationDataTest.class); + + protected PaginationData pagination; + + @Test + public void testCompute() { + + pagination = new PaginationData(20); + + pagination.compute(150); + + Assert.assertEquals(1, pagination.getCurrentPage()); + Assert.assertEquals(1, pagination.getNbPagesToRetrieve()); + Assert.assertEquals(20, pagination.getNbElementsByPage()); + Assert.assertEquals(150, pagination.getNbResults()); + Assert.assertEquals(8, pagination.getNbPages()); + Assert.assertEquals(8, pagination.getMaxAvailablePages()); + Assert.assertEquals(20, pagination.getNbElements()); + Assert.assertEquals((Integer) 0, pagination.getStartIndex()); + Assert.assertEquals((Integer) 19, pagination.getEndIndex()); + } + + @Test + public void testSetCurrentPageSuccess() { + + pagination = new PaginationData(20, 3, 1); + + pagination.compute(150); + + // Indexes are updated + Assert.assertEquals(20, pagination.getNbElements()); + Assert.assertEquals((Integer) 40, pagination.getStartIndex()); + Assert.assertEquals((Integer) 59, pagination.getEndIndex()); + } + + @Test + public void testSetCurrentPageUpdated() { + + pagination = new PaginationData(20, 9, 1); + + pagination.compute(150); + + Assert.assertEquals(8, pagination.getCurrentPage()); + } + + @Test + public void testSetNbPagesToRetrieve() { + + pagination = new PaginationData(20, 3, 2); + + pagination.compute(150); + + // Indexes are updated + Assert.assertEquals(40, pagination.getNbElements()); + Assert.assertEquals((Integer) 40, pagination.getStartIndex()); + Assert.assertEquals((Integer) 79, pagination.getEndIndex()); + } + + @Test + public void testSetNbPagesToRetrieveOutOfBounds() { + + // 18 is out of bounds, all pages from page 3 will be retrieved, i.e : 3, 4, 5, 6, 7, 8, 9 + pagination = new PaginationData(20, 3, 18); + + pagination.compute(180); + + logger.debug(pagination); + + Assert.assertEquals(9, pagination.getNbPages()); + Assert.assertEquals(7, pagination.getNbPagesToRetrieve()); + // Indexes are updated + Assert.assertEquals(140, pagination.getNbElements()); + Assert.assertEquals((Integer) 40, pagination.getStartIndex()); + Assert.assertEquals((Integer) 179, pagination.getEndIndex()); + } + + @Test + public void testNoResults() { + + pagination = new PaginationData(20, 1, 1); + + pagination.compute(0); + + logger.debug(pagination); + + Assert.assertEquals(1, pagination.getCurrentPage()); + Assert.assertEquals(1, pagination.getNbPagesToRetrieve()); + Assert.assertEquals(20, pagination.getNbElementsByPage()); + Assert.assertEquals(0, pagination.getNbResults()); + Assert.assertEquals(0, pagination.getNbPages()); + Assert.assertEquals(0, pagination.getMaxAvailablePages()); + Assert.assertEquals(0, pagination.getNbElements()); + Assert.assertNull(pagination.getStartIndex()); + Assert.assertNull(pagination.getEndIndex()); + } + +} Modified: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/sample/DataSampleProvider.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/main/java/org/nuiton/sandbox/jsr317/jpa2/sample/DataSampleProvider.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/sample/DataSampleProvider.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,10 +1,11 @@ package org.nuiton.sandbox.jsr317.jpa2.sample; -import java.util.LinkedHashMap; -import java.util.Map; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.List; + import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; -import org.nuiton.sandbox.jsr317.jpa2.entity.BaseEntity; import org.nuiton.sandbox.jsr317.jpa2.entity.Customer; import org.nuiton.sandbox.jsr317.jpa2.persistence.CustomerDAO; import org.springframework.beans.factory.annotation.Autowired; @@ -24,44 +25,15 @@ private static final Log logger = LogFactory.getLog(DataSampleProvider.class); - /** - * Extension of {@link LinkedHashMap} with getter on index. Use {@link #get(int)} method to retrieve element at provided index. - * - * @param <K> Key type of the Map - * @param <O> Object type of the Map - */ - protected class IndexedMap<K, O extends BaseEntity> extends LinkedHashMap<K, O> { - - public O get(int index) { - int i = 0; - for (O o : values()) { - if (i == index) { - return o; - } - i++; - } - return null; - } - - @Override - public O put(K key, O value) { - if (logger.isTraceEnabled()) { - logger.trace("Add " + value.getClass().getSimpleName() + " with id = " + value.getId() + - " _ @" + Integer.toHexString(value.hashCode())); - } - return super.put(key, value); - } - } - @Autowired protected CustomerDAO customerDAO; - protected IndexedMap<Long, Customer> customers = new IndexedMap<Long, Customer>(); + protected List<Customer> customers = new ArrayList<Customer>(); - public void createAllData() { + public void createData(DataProviderLimit limit) { if (logger.isDebugEnabled()) { - logger.debug("#### SAMPLE INSERT START ####"); + logger.debug("#### SAMPLE INSERT START :: " + limit + " ####"); } createCustomers(); @@ -102,7 +74,38 @@ return customers.get(index); } - public Map<Long, Customer> getCustomers() { + public List<Customer> getCustomers() { return customers; } + + protected <T> List<T> subList(List<T> list, int from, int to) { + // subList exclude by default the "to" index, in most of cases, we want also the "to" element + int toInclude = to + 1; + // it's important to check the max case to avoid IndexOutOfBoundsException, the last element will be also part + // of the resulting list. + if (toInclude > list.size()) { + toInclude = to; + } + return list.subList(from, toInclude); + } + + /** + * Simple method to retrieve annotation linked with {@code method}. If defined on the method, the annotation will + * directly be used, otherwise the one on the class is returned (could be null). So if the annotation is defined on + * the method, parameters from class will be ignored (no inheritance is done). + * + * @param method Method where annotation is retrieved + * @return the UseDataProvider annotation linked to this method or null if no annotation is found + */ + public static UseDataProvider getUseDataProviderAnnotation(Method method) { + + UseDataProvider useDataProvider = method.getAnnotation(UseDataProvider.class); + + if (useDataProvider == null) { + useDataProvider = method.getDeclaringClass().getAnnotation(UseDataProvider.class); + } + + return useDataProvider; + } + } Copied: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseJpaTest.java (from rev 444, jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseTest.java) =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseJpaTest.java (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseJpaTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,78 @@ +package org.nuiton.sandbox.jsr317.jpa2.test; + +import javax.persistence.EntityManager; +import javax.persistence.PersistenceContext; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.junit.Rule; +import org.junit.rules.TestWatchman; +import org.junit.runner.RunWith; +import org.junit.runners.model.FrameworkMethod; +import org.nuiton.sandbox.jsr317.jpa2.persistence.CustomerDAO; +import org.nuiton.sandbox.jsr317.jpa2.sample.DataProviderLimit; +import org.nuiton.sandbox.jsr317.jpa2.sample.DataSampleProvider; +import org.nuiton.sandbox.jsr317.jpa2.sample.UseDataProvider; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.ApplicationContext; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Created on 18 oct. 2010 + * + * @author fdesbois <fdesbois@codelutin.com> + * @version $Id$ + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration(locations = {"/test-jpa-spring-context.xml"}) +public abstract class BaseJpaTest { + + protected final Log logger = LogFactory.getLog(getClass()); + + @Autowired + protected ApplicationContext context; + + @PersistenceContext + protected EntityManager entityManager; + + @Autowired + protected DataSampleProvider dataProvider; + + @Autowired + protected CustomerDAO userDAO; + + protected class JpaTestRule extends TestWatchman { + + @Override + public void starting(FrameworkMethod method) { + super.starting(method); + + // Use DataProvider depends on annotation declaration in tests + useDataProvider(DataSampleProvider.getUseDataProviderAnnotation(method.getMethod())); + } + + protected void useDataProvider(UseDataProvider useDataProvider) { + if (useDataProvider != null && useDataProvider.value()) { + createData(useDataProvider.limit()); + } + } + + protected void createData(DataProviderLimit limit) { + try { + dataProvider.createData(limit); + } catch (Exception ex) { + logger.error(ex.getMessage(), ex); + } + } + + } + + @Rule + public TestWatchman rule = new JpaTestRule(); + + protected RandomFunction getRandomExpression() { + return new RandomFunction(entityManager.getCriteriaBuilder()); + } + +} Property changes on: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseJpaTest.java ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Deleted: jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseTest.java =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseTest.java 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/java/org/nuiton/sandbox/jsr317/jpa2/test/BaseTest.java 2010-12-29 16:15:42 UTC (rev 445) @@ -1,76 +0,0 @@ -package org.nuiton.sandbox.jsr317.jpa2.test; - -import javax.persistence.EntityManager; -import javax.persistence.PersistenceContext; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.junit.Rule; -import org.junit.rules.TestName; -import org.junit.runner.RunWith; -import org.junit.runners.model.FrameworkMethod; -import org.nuiton.sandbox.jsr317.jpa2.persistence.CustomerDAO; -import org.nuiton.sandbox.jsr317.jpa2.sample.DataSampleProvider; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.test.annotation.Rollback; -import org.springframework.test.context.ContextConfiguration; -import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; - -/** - * Created on 18 oct. 2010 - * - * @author fdesbois <fdesbois@codelutin.com> - * @version $Id$ - */ -@RunWith(SpringJUnit4ClassRunner.class) -@ContextConfiguration(locations = {"/test-context.xml"}) -public abstract class BaseTest { - - private static final Log logger = LogFactory.getLog(BaseTest.class); - - @PersistenceContext - protected EntityManager em; - - @Autowired - protected DataSampleProvider dataProvider; - - @Autowired - protected CustomerDAO userDAO; - - @Rule - public TestName rule = new TestName() { - - @Override - public void starting(FrameworkMethod method) { - super.starting(method); - if (autoDataEnabled()) { - try { - dataProvider.createAllData(); - } catch (Exception eee) { - logger.error(eee.getClass().getSimpleName(), eee); - } - } - } - - @Override - public void finished(FrameworkMethod method) { - if (autoDataEnabled()) { - - Rollback rollback = method.getAnnotation(Rollback.class); - - if (rollback == null || rollback.value()) { - dataProvider.deleteAllData(); - } - } - super.finished(method); - } - - public BaseTest getTest() { - return BaseTest.this; - } - }; - - protected boolean autoDataEnabled() { - return false; - } - -} Deleted: jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-context.xml =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-context.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-context.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -1,16 +0,0 @@ -<beans xmlns="http://www.springframework.org/schema/beans" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:context="http://www.springframework.org/schema/context" - xsi:schemaLocation=" - http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd - http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> - - <!--<import resource="classpath:META-INF/jsr317-spring-context.xml"/>--> - - <!-- Load Spring Configuration from Java file --> - <bean class="org.nuiton.sandbox.jsr317.jpa2.test.SpringTestConfig" /> - - <!-- Scan sample --> - <context:component-scan base-package="org.nuiton.sandbox.jsr317.jpa2.sample" /> - -</beans> \ No newline at end of file Copied: jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-jpa-spring-context.xml (from rev 444, jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-context.xml) =================================================================== --- jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-jpa-spring-context.xml (rev 0) +++ jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-jpa-spring-context.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -0,0 +1,16 @@ +<beans xmlns="http://www.springframework.org/schema/beans" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:context="http://www.springframework.org/schema/context" + xsi:schemaLocation=" + http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd + http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd"> + + <!--<import resource="classpath:META-INF/jsr317-spring-context.xml"/>--> + + <!-- Load Spring Configuration from Java file --> + <bean class="org.nuiton.sandbox.jsr317.jpa2.test.SpringTestConfig" /> + + <!-- Scan sample --> + <context:component-scan base-package="org.nuiton.sandbox.jsr317.jpa2.sample" /> + +</beans> \ No newline at end of file Property changes on: jpa2-validation/trunk/jsr317-jpa2/src/test/resources/test-jpa-spring-context.xml ___________________________________________________________________ Added: svn:keywords + Author Date Id Revision HeadURL Modified: jpa2-validation/trunk/pom.xml =================================================================== --- jpa2-validation/trunk/pom.xml 2010-12-15 08:21:32 UTC (rev 444) +++ jpa2-validation/trunk/pom.xml 2010-12-29 16:15:42 UTC (rev 445) @@ -34,6 +34,12 @@ <version>1.4.2</version> </dependency> + <dependency> + <groupId>commons-lang</groupId> + <artifactId>commons-lang</artifactId> + <version>2.5</version> + </dependency> + <!-- SPRING --> <dependency> <groupId>org.springframework</groupId>