[hibernate-commits] Hibernate SVN: r15197 - shards/trunk/src/java/org/hibernate/shards/strategy.

[hibernate-commits at lists.jboss.org]

Author: max.ross
Date: 2008-09-14 23:59:11 -0400 (Sun, 14 Sep 2008)
New Revision: 15197

Modified:
   shards/trunk/src/java/org/hibernate/shards/strategy/ShardStrategy.java
Log:
Add javadoc.

First CL from Danny!

Modified: shards/trunk/src/java/org/hibernate/shards/strategy/ShardStrategy.java
===================================================================
--- shards/trunk/src/java/org/hibernate/shards/strategy/ShardStrategy.java	2008-09-14 18:25:52 UTC (rev 15196)
+++ shards/trunk/src/java/org/hibernate/shards/strategy/ShardStrategy.java	2008-09-15 03:59:11 UTC (rev 15197)
@@ -23,6 +23,21 @@
 import org.hibernate.shards.strategy.selection.ShardSelectionStrategy;
 
 /**
+ * Interface to specify Sharding behavior.
+ * 
+ * This class determines through {@link ShardAccessStrategy}, {@link ShardResolutionStrategy}, and
+ * {@link ShardSelectionStrategy} how to read, persist and update entities in the sharded collection of databases.
+ * 
+ *  <p>When given a query the {@link ShardAccessStrategy} will determine how the query will be distributed across 
+ * the known shards - in sequence, in parallel, or some combination of the two.
+ *  </p> 
+ *  <p> When looking for an entity with a known Id and type {@link ShardResolutionStrategy} will return all possible shards
+ * that this entity might reside on. 
+ *  </p> 
+ *  <p> When given an entity the {@link ShardSelectionStrategy} will determine which shard that object should be persisted
+ * or updated on.
+ *  </p> 
+ * 
  * @author maxr at google.com (Max Ross)
  */
 public interface ShardStrategy {