spreadsheet.mapper.w2o.process.SheetProcessHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spreadsheet-mapper Show documentation

java mapping library between spreadsheet and object

The newest version!

package spreadsheet.mapper.w2o.process;

import spreadsheet.mapper.model.core.Sheet;
import spreadsheet.mapper.model.meta.SheetMeta;
import spreadsheet.mapper.w2o.process.listener.CellProcessListener;
import spreadsheet.mapper.w2o.process.listener.RowProcessListener;
import spreadsheet.mapper.w2o.process.listener.SheetProcessListener;
import spreadsheet.mapper.w2o.process.setter.FieldSetter;

import java.util.List;

/**
 * sheet process helper
 * 
 * Created by hanwen on 2016/12/28.
 */
public interface SheetProcessHelper {

  /**
   * {@link FieldSetter} unique with {@link FieldSetter#getMatchField()} in one sheet (one to one)
   *
   * @param fieldSetter {@link FieldSetter}
   * @return {@link SheetProcessHelper}
   * @see FieldSetter
   */
  SheetProcessHelper addFieldSetter(FieldSetter fieldSetter);

  /**
   * @param objectFactory {@link ObjectFactory}
   * @return {@link SheetProcessHelper}
   */
  SheetProcessHelper setObjectFactory(ObjectFactory objectFactory);

  /**
   * @param sheetProcessListener {@link SheetProcessListener}
   * @return {@link SheetProcessHelper}
   */
  SheetProcessHelper setSheetProcessorListener(SheetProcessListener sheetProcessListener);

  /**
   * @param rowProcessListener {@link RowProcessListener}
   * @return {@link SheetProcessHelper}
   */
  SheetProcessHelper setRowProcessorListener(RowProcessListener rowProcessListener);

  /**
   * @param cellProcessListener {@link CellProcessListener}
   * @return {@link SheetProcessHelper}
   */
  SheetProcessHelper setCellProcessorListener(CellProcessListener cellProcessListener);

  /**
   * @param sheet     {@link Sheet}
   * @param sheetMeta {@link SheetMeta}
   * @return list of data
   */
  List process(Sheet sheet, SheetMeta sheetMeta);
}