[hibernate-commits] Hibernate SVN: r14829 - in search/branches/jboss_cache_integration/src/java/org/hibernate/search: impl and 1 other directory.

[hibernate-commits at lists.jboss.org]

Author: navssurtani
Date: 2008-06-30 13:05:11 -0400 (Mon, 30 Jun 2008)
New Revision: 14829

Modified:
   search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/Cfg.java
   search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/CfgImpl.java
   search/branches/jboss_cache_integration/src/java/org/hibernate/search/impl/FullTextSessionImpl.java
Log:
Javadocced stuff

Modified: search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/Cfg.java
===================================================================
--- search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/Cfg.java	2008-06-30 15:45:38 UTC (rev 14828)
+++ search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/Cfg.java	2008-06-30 17:05:11 UTC (rev 14829)
@@ -6,15 +6,46 @@
 import java.util.Properties;
 
 /**
+ * Interface that is used for the JBossCache integration. In Hibernate Search, it delegates back to Hibernate Core.
+ *
  * @author Navin Surtani  - navin at surtani.org
  */
 public interface Cfg
 {
+   /**
+    * Returns an iterator of class mappings.
+    *
+    * @return iterator of class mappings.
+    */
+
    Iterator getClassMappings();
 
+   /**
+    * Returns a {@link org.hibernate.mapping.PersistentClass} from a String parameter.
+    *
+    * @param name
+    * @return org.hibernate.mapping.PersistentClass
+    */
+
    PersistentClass getClassMapping(String name);
 
+   /**
+    * Gets a property from a String.
+    *
+    * @param propertyName - as a String.
+    * @return the property as a String.
+    */
+
    String getProperty(String propertyName);
 
+   /**
+    * Gets the properties as a java.util.Properties object.
+    *
+    * @return a java.util.Properties object.
+    * @see java.util.Properties object 
+    */
+
    Properties getProperties();
+
+
 }

Modified: search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/CfgImpl.java
===================================================================
--- search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/CfgImpl.java	2008-06-30 15:45:38 UTC (rev 14828)
+++ search/branches/jboss_cache_integration/src/java/org/hibernate/search/cfg/CfgImpl.java	2008-06-30 17:05:11 UTC (rev 14829)
@@ -12,6 +12,7 @@
 public class CfgImpl implements Cfg
 {
    private Configuration cfg;
+   private Properties properties;
 
    public CfgImpl(Configuration cfg)
    {
@@ -38,4 +39,5 @@
    {
       return cfg.getProperties();
    }
+
 }

Modified: search/branches/jboss_cache_integration/src/java/org/hibernate/search/impl/FullTextSessionImpl.java
===================================================================
--- search/branches/jboss_cache_integration/src/java/org/hibernate/search/impl/FullTextSessionImpl.java	2008-06-30 15:45:38 UTC (rev 14828)
+++ search/branches/jboss_cache_integration/src/java/org/hibernate/search/impl/FullTextSessionImpl.java	2008-06-30 17:05:11 UTC (rev 14829)
@@ -77,7 +77,14 @@
 		purge( entityType, null );
 	}
 
-	/**
+   public void flushToIndexes()
+   {
+
+      //TODO Why wasn't this implemented?
+      //To change body of implemented methods use File | Settings | File Templates.
+   }
+
+   /**
 	 * Remove a particular entity from a particular class of an index.
 	 *
 	 * @param entityType