Author: ppoddar
Date: Wed Jun 8 23:37:58 2011
New Revision: 1133602
URL: http://svn.apache.org/viewvc?rev=1133602&view=rev
Log:
Add code comments
Modified:
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedBroker.java
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedConfiguration.java
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedStoreManager.java
Modified:
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedBroker.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedBroker.java?rev=1133602&r1=1133601&r2=1133602&view=diff
==============================================================================
---
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedBroker.java
(original)
+++
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedBroker.java
Wed Jun 8 23:37:58 2011
@@ -22,7 +22,9 @@ import org.apache.openjpa.kernel.Broker;
import org.apache.openjpa.slice.jdbc.TargetFetchConfiguration;
/**
- * Extension to Broker to allow access to virtual data store.
+ * Extension to Broker to allow access to {@link DistributedStoreManager
virtual data store}.
+ * The broker manages a single persistence context like a normal {@link
Broker}, but the
+ * context holds data from multiple databases.
*
* @author Pinaki Poddar
*
Modified:
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedConfiguration.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedConfiguration.java?rev=1133602&r1=1133601&r2=1133602&view=diff
==============================================================================
---
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedConfiguration.java
(original)
+++
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedConfiguration.java
Wed Jun 8 23:37:58 2011
@@ -26,10 +26,18 @@ import org.apache.openjpa.conf.OpenJPACo
* A configuration for multiple data stores, each referred as <em>slice</em>.
* This configuration allows each underlying slice be configured with its
* own specific configuration properties such as JDBC Driver or connection
- * user/password etc. <br>
- * This configuration also extends by adding a {@link DistributionPolicy
- * DistributionPolicy} that governs how new instances be distributed
+ * user/password etc.
+ * <br>
+ * This configuration also extends by several policy plugins. A policy plugin
+ * is an user implementation of a specific policy interface. A policy
implementation
+ * is invoked by Slice runtime.
+ * <br>
+ * Slice recognizes following policies
+ * <LI> {@link DistributionPolicy Distribution Policy} governs how new
instances be distributed
* among the slices.
+ * <LI> {@link ReplicationPolicy Replication Policy} maintains the same
instance in multiple slices.
+ * <LI> {@link QueryTargetPolicy Query Target Policy} narrows the slices for a
query execution.
+ * <LI> {@link FinderTargetPolicy Finder Target Policy} narrows the slices for
primary key based lookup
*
* @author Pinaki Poddar
*
Modified:
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedStoreManager.java
URL:
http://svn.apache.org/viewvc/openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedStoreManager.java?rev=1133602&r1=1133601&r2=1133602&view=diff
==============================================================================
---
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedStoreManager.java
(original)
+++
openjpa/trunk/openjpa-slice/src/main/java/org/apache/openjpa/slice/DistributedStoreManager.java
Wed Jun 8 23:37:58 2011
@@ -23,6 +23,13 @@ import java.util.Map;
import org.apache.openjpa.kernel.StoreManager;
import org.apache.openjpa.slice.jdbc.SliceStoreManager;
+/**
+ * A specialized {@link StoreManager Store Manager} that encapsulates multiple
concrete Store Managers
+ * using Distributed Template (or Composite) Design Pattern.
+ *
+ * @author Pinaki Poddar
+ *
+ */
public interface DistributedStoreManager extends StoreManager {
/**
* Adds the given slice with the given properties. This newly added slice
