svn commit: r916065 - in /hadoop/pig/trunk/src/org/apache/pig: LoadFunc.java StoreFunc.java

[pr...@apache.org]

Author: pradeepkth
Date: Thu Feb 25 00:52:32 2010
New Revision: 916065

URL: http://svn.apache.org/viewvc?rev=916065&view=rev
Log:
Updated comments in LoadFunc and StoreFunc

Modified:
    hadoop/pig/trunk/src/org/apache/pig/LoadFunc.java
    hadoop/pig/trunk/src/org/apache/pig/StoreFunc.java

Modified: hadoop/pig/trunk/src/org/apache/pig/LoadFunc.java
URL: http://svn.apache.org/viewvc/hadoop/pig/trunk/src/org/apache/pig/LoadFunc.java?rev=916065&r1=916064&r2=916065&view=diff
==============================================================================
--- hadoop/pig/trunk/src/org/apache/pig/LoadFunc.java (original)
+++ hadoop/pig/trunk/src/org/apache/pig/LoadFunc.java Thu Feb 25 00:52:32 2010
@@ -269,7 +269,8 @@
      * {@link LoadFunc} needs to store between various method invocations in the
      * front end and back end. A use case is to store {@link RequiredFieldList} 
      * passed to it in {@link LoadPushDown#pushProjection(RequiredFieldList)} for
-     * use in the back end before returning tuples in {@link LoadFunc#getNext()}
+     * use in the back end before returning tuples in {@link LoadFunc#getNext()}.
+     * This method will be call before other methods in {@link LoadFunc}
      * @param signature a unique signature to identify this LoadFunc
      */
     public void setUDFContextSignature(String signature) {

Modified: hadoop/pig/trunk/src/org/apache/pig/StoreFunc.java
URL: http://svn.apache.org/viewvc/hadoop/pig/trunk/src/org/apache/pig/StoreFunc.java?rev=916065&r1=916064&r2=916065&view=diff
==============================================================================
--- hadoop/pig/trunk/src/org/apache/pig/StoreFunc.java (original)
+++ hadoop/pig/trunk/src/org/apache/pig/StoreFunc.java Thu Feb 25 00:52:32 2010
@@ -80,6 +80,8 @@
      * This method will be called in the frontend and backend multiple times. Implementations
      * should bear in mind that this method is called multiple times and should
      * ensure there are no inconsistent side effects due to the multiple calls.
+     * {@link #checkSchema(ResourceSchema)} will be called before any call to
+     * {@link #setStoreLocation(String, Job)}.
      * 
 
      * @param location Location indicated in store statement.
@@ -125,7 +127,8 @@
      * This method will be called by Pig both in the front end and back end to
      * pass a unique signature to the {@link StoreFunc} which it can use to store
      * information in the {@link UDFContext} which it needs to store between
-     * various method invocations in the front end and back end. 
+     * various method invocations in the front end and back end. This method 
+     * will be called before other methods in {@link StoreFunc}.
      * @param signature a unique signature to identify this StoreFunc
      */
     public void setStoreFuncUDFContextSignature(String signature) {