org.hellojavaer.poi.excel.utils.read.ExcelReadSheetProcessor Maven / Gradle / Ivy

/*
 * Copyright 2015-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.hellojavaer.poi.excel.utils.read;

import java.util.List;

/**
 * @author zoukaiming
 */
public abstract class ExcelReadSheetProcessor {

    private Integer                  sheetIndex;
    private String                   sheetName;
    private Class                 targetClass;
    private int                      startRowIndex = 0;
    private Integer                  endRowIndex;
    private Integer                  pageSize;
    private ExcelReadFieldMapping    fieldMapping;
    private ExcelReadRowProcessor rowProcessor;
    private boolean                  trimSpace     = false;
    private Integer                  headRowIndex;

    public abstract void beforeProcess(ExcelReadContext context);

    public abstract void process(ExcelReadContext context, List list);

    public abstract void onException(ExcelReadContext context, RuntimeException e);

    public abstract void afterProcess(ExcelReadContext context);

    public Integer getSheetIndex() {
        return sheetIndex;
    }

    /**
     * required.it can be replaced with {@code setSheetName};
     * 
     * @param sheetIndex
     * @see #setSheetName
     */
    public void setSheetIndex(Integer sheetIndex) {
        this.sheetIndex = sheetIndex;
    }

    /**
     * required.it can be replaced with {@code setSheetIndex};
     * 
     * @param sheetIndex
     * @see #setSheetIndex
     */
    public String getSheetName() {
        return sheetName;
    }

    public void setSheetName(String sheetName) {
        this.sheetName = sheetName;
    }

    /**
     * required
     * 
     * @param sheetIndex
     */
    public int getStartRowIndex() {
        return startRowIndex;
    }

    /**
     * 
     * @param startRowIndex
     */
    public void setStartRowIndex(int startRowIndex) {
        this.startRowIndex = startRowIndex;
    }

    public Integer getPageSize() {
        return pageSize;
    }

    /**
     * 
     * @param pageSize
     */
    public void setPageSize(Integer pageSize) {
        this.pageSize = pageSize;
    }

    public ExcelReadFieldMapping getFieldMapping() {
        return fieldMapping;
    }

    public void setFieldMapping(ExcelReadFieldMapping fieldMapping) {
        this.fieldMapping = fieldMapping;
    }

    public ExcelReadRowProcessor getRowProcessor() {
        return rowProcessor;
    }

    /**
     * 
     * @param rowProcessor
     */
    public void setRowProcessor(ExcelReadRowProcessor rowProcessor) {
        this.rowProcessor = rowProcessor;
    }

    public Class getTargetClass() {
        return targetClass;
    }

    /**
     * required
     * 
     * @param targetClass
     */
    public void setTargetClass(Class targetClass) {
        this.targetClass = targetClass;
    }

    public Integer getEndRowIndex() {
        return endRowIndex;
    }

    /**
     * 
     * @param rowEndIndex
     */
    public void setEndRowIndex(Integer endRowIndex) {
        this.endRowIndex = endRowIndex;
    }

    public boolean isTrimSpace() {
        return trimSpace;
    }

    public void setTrimSpace(boolean trimSpace) {
        this.trimSpace = trimSpace;
    }

    public Integer getHeadRowIndex() {
        return headRowIndex;
    }

    public void setHeadRowIndex(Integer headRowIndex) {
        this.headRowIndex = headRowIndex;
    }

}