Author: drobiazko
Date: Fri Apr 29 15:16:02 2011
New Revision: 1097834
URL: http://svn.apache.org/viewvc?rev=1097834&view=rev
Log:
Added some javadocs
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerManager.java
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerSource.java
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaConstants.java
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaGridDataSource.java
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaModule.java
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaPersistenceConstants.java
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerManager.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerManager.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerManager.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerManager.java
Fri Apr 29 15:16:02 2011
@@ -18,9 +18,30 @@ import java.util.Map;
import javax.persistence.EntityManager;
+/**
+ * Manages <code>EntityManager</code>s for the current thread.
+ * An <code>EntityManager</code> is created as needed and closed at the end of
each request.
+ *
+ * <p/>
+ *
+ * The implementation of this service is per-thread.
+ *
+ * @since 5.3.0
+ */
public interface EntityManagerManager
{
+ /**
+ * Gets the active <code>EntityManager</code> for this request, creating
it as necessary.
+ *
+ * @param persistenceUnitName the name of a persistence unit as defined in
<code>persistence.xml<code>
+ * @return EntityManager for the persistence unit,
+ */
EntityManager getEntityManager(String persistenceUnitName);
+ /**
+ * Gets all active <code>EntityManager</code>s for this request, creating
them as necessary.
+ *
+ * @return Map in which persistence unit names are associated with
EntityManagers
+ */
Map<String, EntityManager> getEntityManagers();
}
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerSource.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerSource.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerSource.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/EntityManagerSource.java
Fri Apr 29 15:16:02 2011
@@ -20,11 +20,34 @@ import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.spi.PersistenceUnitInfo;
+/**
+ * Responsible for creating an EntityManager as needed.
+ *
+ * @since 5.3.0
+ */
public interface EntityManagerSource
{
+ /**
+ * Creates an <code>EntityManager</code> for the given persistence unit
name.
+ *
+ * @param persistenceUnitName the name of a persistence unit as defined in
<code>persistence.xml<code>
+ * @return EntityManager for the given persistence unit name
+ */
EntityManager create(String persistenceUnitName);
+ /**
+ * Gets the <code>EntityManagerFactory</code> for the given persistence
unit name, creating it as necessary.
+ *
+ * @param persistenceUnitName the name of a persistence unit as defined in
<code>persistence.xml<code>
+ *
+ * @return EntityManagerFactory for the given persistence unit name
+ */
EntityManagerFactory getEntityManagerFactory(String persistenceUnitName);
+ /**
+ * Get the list of {@linkplain PersistenceUnitInfo} parsed from
<code>persistence.xml<code>.
+ *
+ * @return list of PersistenceUnitInfos
+ */
List<PersistenceUnitInfo> getPersistenceUnitInfos();
}
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaConstants.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaConstants.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaConstants.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaConstants.java
Fri Apr 29 15:16:02 2011
@@ -14,7 +14,15 @@
package org.apache.tapestry5.jpa;
+/**
+ * Defines constants used inside the Tapestry JPA integration.
+ *
+ * @since 5.3.0
+ */
public class JpaConstants
{
+ /**
+ * Name of the <code>EntityManager</code> property whose value is the name
of a persistence unit.
+ */
public static final String PERSISTENCE_UNIT_NAME =
"tapestry.persistence-unit-name";
}
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaGridDataSource.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaGridDataSource.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaGridDataSource.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaGridDataSource.java
Fri Apr 29 15:16:02 2011
@@ -37,6 +37,8 @@ import org.apache.tapestry5.grid.SortCon
* <p/>
* Typically, an instance of this object is created fresh as needed (that is,
it is not stored
* between requests).
+ *
+ * @since 5.3.0
*/
public class JpaGridDataSource<E> implements GridDataSource
{
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaModule.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaModule.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaModule.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaModule.java
Fri Apr 29 15:16:02 2011
@@ -65,6 +65,11 @@ import org.apache.tapestry5.services.Val
import org.apache.tapestry5.services.ValueEncoderSource;
import org.slf4j.Logger;
+/**
+ * Defines core services for JPA support.
+ *
+ * @since 5.3.0
+ */
public class JpaModule
{
public static void bind(final ServiceBinder binder)
Modified:
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaPersistenceConstants.java
URL:
http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaPersistenceConstants.java?rev=1097834&r1=1097833&r2=1097834&view=diff
==============================================================================
---
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaPersistenceConstants.java
(original)
+++
tapestry/tapestry5/trunk/tapestry-jpa/src/main/java/org/apache/tapestry5/jpa/JpaPersistenceConstants.java
Fri Apr 29 15:16:02 2011
@@ -16,6 +16,11 @@ package org.apache.tapestry5.jpa;
import org.apache.tapestry5.PersistenceConstants;
+/**
+ * Constants for persistent field strategies.
+ *
+ * @since 5.3.0
+ */
public class JpaPersistenceConstants
{
/**
