View Javadoc

1   /*
2    * Copyright 2002-2006 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.gageot.excel.core;
18  
19  import java.io.IOException;
20  
21  import org.apache.poi.hssf.usermodel.HSSFRow;
22  
23  /*** 
24   * An interface used by ExcelTemplate for mapping rows.
25   * Implementations of this interface perform the actual work of mapping
26   * rows, but don't need to worry about exception handling. IOExceptions
27   * will be caught and handled correctly by the ExcelTemplate class.
28   *
29   * @author David Gageot
30   * @see ExcelTemplate
31   * @see SheetExtractor
32   */
33  public interface RowMapper {
34  	/*** 
35  	 * Implementations must implement this method to map each row of data
36  	 * in the HSSFSheet. This method should extract the values of the current row.
37  	 * @param row the HSSFRow to map
38  	 * @param rowNum the number of the current row
39  	 * @throws IOException if a IOException is encountered getting
40  	 * column values (that is, there's no need to catch IOException)
41  	 */
42  	Object mapRow (HSSFRow row, int rowNum) throws IOException; 
43  }