[hibernate-commits] Hibernate SVN: r15196 - in search/trunk/src/java/org/hibernate/search: jpa and 1 other directory.

[hibernate-commits at lists.jboss.org]

Author: sannegrinovero
Date: 2008-09-14 14:25:52 -0400 (Sun, 14 Sep 2008)
New Revision: 15196

Modified:
   search/trunk/src/java/org/hibernate/search/FullTextSession.java
   search/trunk/src/java/org/hibernate/search/jpa/FullTextEntityManager.java
Log:
javadoc clarifications for index() - by forum request.

Modified: search/trunk/src/java/org/hibernate/search/FullTextSession.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/FullTextSession.java	2008-09-14 09:00:05 UTC (rev 15195)
+++ search/trunk/src/java/org/hibernate/search/FullTextSession.java	2008-09-14 18:25:52 UTC (rev 15196)
@@ -20,8 +20,8 @@
 
 	/**
 	 * Force the (re)indexing of a given <b>managed</b> object.
-	 * Indexation is batched per transaction
-	 * Non indexable entities are ignored
+	 * Indexation is batched per transaction: if a transaction is active, the operation
+	 * will not affect the index at least until commit.
 	 *
 	 * @param entity The entity to index - must not be <code>null</code>.
 	 * @throws IllegalArgumentException if entity is null or not an @Indexed entity

Modified: search/trunk/src/java/org/hibernate/search/jpa/FullTextEntityManager.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/jpa/FullTextEntityManager.java	2008-09-14 09:00:05 UTC (rev 15195)
+++ search/trunk/src/java/org/hibernate/search/jpa/FullTextEntityManager.java	2008-09-14 18:25:52 UTC (rev 15196)
@@ -21,8 +21,9 @@
 
 	/**
 	 * Force the (re)indexing of a given <b>managed</b> object.
-	 * Indexation is batched per transaction
-	 *
+	 * Indexation is batched per transaction: if a transaction is active, the operation
+	 * will not affect the index at least until commit.
+	 * 
 	 * @throws IllegalArgumentException if entity is null or not an @Indexed entity
 	 */
 	void index(Object entity);