/*

Copyright 2010, Google Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
    * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,           
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY           
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

package com.google.refine.browsing;

import com.google.refine.model.Project;
import com.google.refine.model.Row;

/**
 * Interface for visiting rows one by one. The rows visited are only those that match some
 * particular criteria, such as facets' constraints.
 */
public interface RowVisitor {
    public void start(Project project); // called before any visit() call

    public boolean visit(
            Project project, 
            int     rowIndex,   // zero-based row index 
            Row     row
    );

    public void end(Project project); // called after all visit() calls
}

@@ -1803,78 +1803,330 @@
     
-public void start(Project project); // called before any
+%0A    /**%0A     * Called before any visit() call.%0A     * %0A     * @param project%0A     */%0A    public void start(Project project);%0A%0A    /**%0A     * @param project project%0A     * @param rowIndex zero-based row index%0A     * @param row row%0A     * @return true to abort visitation early - no further
  visit
-()
  call
-%0A
+s will be made%0A     */
 %0A   
@@ -2212,66 +2212,125 @@
 ex, 
-  // zero-based row index 
+%0A            Row     row%0A    );%0A
 %0A    
+/**%0A
      
-   Row     row
+* Called after all visit() calls.%0A     * %0A     * @param project
 %0A    
-);%0A
+ */
 %0A   
@@ -2367,41 +2367,7 @@
 ct);
- // called after all visit() calls
 %0A%7D%0A

Move documentation to Javadoc where it's visible