CellFinder.java

  1. package com.gh.mygreen.xlsmapper.util;

  3. import java.util.Optional;

  5. import org.apache.poi.ss.usermodel.Cell;
  6. import org.apache.poi.ss.usermodel.Row;
  7. import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
  8. import org.apache.poi.ss.usermodel.Sheet;

  10. import com.gh.mygreen.xlsmapper.Configuration;
  11. import com.gh.mygreen.xlsmapper.fieldprocessor.CellNotFoundException;

  13. /**
  14.  * 指定したラベルを持つセルを検索するクラス。
  15.  *
  16.  * @since 2.0
  17.  * @author T.TSUCHIE
  18.  *
  19.  */
  20. public class CellFinder {
  21.     
  22.     
  23.     /**
  24.      * シート情報
  25.      */
  26.     private final Sheet sheet;
  27.     
  28.     /**
  29.      * システム設定
  30.      */
  31.     private final Configuration config;
  32.     
  33.     /**
  34.      * 検索対象のラベル
  35.      */
  36.     private final String label;
  37.     
  38.     /**
  39.      * 起点となる行番号
  40.      * ・指定しない場合は、-1を指定する
  41.      */
  42.     private int startRow = -1;
  43.     
  44.     /**
  45.      * 起点となる列番号
  46.      * ・指定しない場合は、-1を指定する
  47.      */
  48.     private int startColumn = -1;
  49.     
  50.     /**
  51.      * 起点となる位置を除外するかどうか
  52.      */
  53.     private boolean excludeStartPoisition = false;
  54.     
  55.     /**
  56.      * 検索する際の条件を組み立てる
  57.      * @param sheet 検索対象のシート
  58.      * @param label 検索するセルのラベル
  59.      * @param config システム設定。
  60.      *        設定値 {@link Configuration#isNormalizeLabelText()}、{@link Configuration#isRegexLabelText()}の値によって、
  61.      *        検索する際にラベルを正規化、または正規表現により一致するかで判定を行う。
  62.      */
  63.     public static CellFinder query(final Sheet sheet, final String label, final Configuration config) {
  64.         return new CellFinder(sheet, label, config);
  65.     }
  66.     
  67.     private CellFinder(final Sheet sheet, final String label, final Configuration config) {
  68.         
  69.         ArgUtils.notNull(sheet, "sheet");
  70.         ArgUtils.notEmpty(label, "label");
  71.         ArgUtils.notNull(config, "config");
  72.         
  73.         this.sheet = sheet;
  74.         this.label = label;
  75.         this.config = config;
  76.     }
  77.     
  78.     /**
  79.      * 起点なる位置を指定する。
  80.      * @param column 列番号(0から始まる)
  81.      * @param row 行番号(0から始まる)
  82.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  83.      * @throws IllegalArgumentException {@literal column < 0 or row < 0}
  84.      */
  85.     public CellFinder startPosition(final int column, final int row) {
  86.         ArgUtils.notMin(column, 0, "column");
  87.         ArgUtils.notMin(row, 0, "row");
  88.         
  89.         this.startColumn = column;
  90.         this.startRow = row;
  91.         
  92.         return this;
  93.     }
  94.     
  95.     /**
  96.      * 起点なる位置を指定する。
  97.      * @param cell 起点とうなるセル
  98.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  99.      * @throws NullPointerException {@literal cell == null.}
  100.      */
  101.     public CellFinder startPosition(final Cell cell) {
  102.         ArgUtils.notNull(cell, "cell");
  103.         
  104.         return startPosition(cell.getColumnIndex(), cell.getRowIndex());
  105.     }
  106.     
  107.     /**
  108.      * 起点なる位置を指定する。
  109.      * @param address セルのアドレス
  110.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  111.      * @throws NullPointerException {@literal address == null.}
  112.      */
  113.     public CellFinder startPosition(final CellPosition address) {
  114.         ArgUtils.notNull(address, "address");
  115.         
  116.         return startPosition(address.getColumn(), address.getRow());
  117.     }
  118.     
  119.     /**
  120.      * 起点となる列を指定する。
  121.      * ただし、行は先頭から検索する。
  122.      * @param column 列番号(0から始まる）
  123.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  124.      * @throws IllegalArgumentException {@literal column < 0}
  125.      */
  126.     public CellFinder startColumn(final int column) {
  127.         ArgUtils.notMin(column, 0, "column");
  128.         
  129.         this.startColumn = column;
  130.         this.startRow = -1;
  131.         
  132.         return this;
  133.     }
  134.     
  135.     /**
  136.      * 起点となる行を指定する。
  137.      * ただし、列は先頭から検索する。
  138.      * @param row 行番号(0から始まる）
  139.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  140.      * @throws IllegalArgumentException {@literal row < 0}
  141.      */
  142.     public CellFinder startRow(final int row) {
  143.         ArgUtils.notMin(row, 0, "row");
  144.         
  145.         this.startColumn = -1;
  146.         this.startRow = row;
  147.         
  148.         return this;
  149.     }
  150.     
  151.     /**
  152.      * 起点となる位置を除外するかどうか。
  153.      * @param excludeStartPosition trueの場合、起点となる位置を除外する
  154.      * @return 自身のインスタンス。メソッドチェーンとして続ける。
  155.      */
  156.     public CellFinder excludeStartPosition(final boolean excludeStartPosition) {
  157.         this.excludeStartPoisition = excludeStartPosition;
  158.         return this;
  159.     }
  160.     
  161.     /**
  162.      * 一致する条件のセルを探す。
  163.      * @return 見つからない場合は、空を返す。
  164.      */
  165.     public Optional<Cell> findOptional() {
  166.         
  167.         return Optional.ofNullable(findCell());
  168.         
  169.     }
  170.     
  171.     /**
  172.      * 一致する条件のセルを探す。
  173.      * ただし、指定したセルが見つからない場合は、例外{@link CellNotFoundException}をスローする。
  174.      * @return 
  175.      * @throws CellNotFoundException 指定したセルが見つからない場合
  176.      */
  177.     public Cell findWhenNotFoundException() {
  178.         
  179.         final Cell cell = findCell();
  180.         if(cell == null) {
  181.             throw new CellNotFoundException(sheet.getSheetName(), label);
  182.         }
  183.         
  184.         return cell;
  185.         
  186.     }
  187.     
  188.     /**
  189.      * 一致する条件のセルを探す。
  190.      * @param optional セルが見つからない場合に、nullを返すかどうか。
  191.      * @return 一致したセルを返す。
  192.      * @throws CellNotFoundException 引数「optional=false」のときに、一致するセルが見つからない場合にスローする。
  193.      */
  194.     public Cell find(final boolean optional) {
  195.         if(optional) {
  196.             return findOptional().orElse(null);
  197.         } else {
  198.             return findWhenNotFoundException();
  199.         }
  200.     }
  201.     
  202.     /**
  203.      * 条件に一致するセルを探す
  204.      * @return 見つからない場合は、nullを返す。
  205.      */
  206.     private Cell findCell() {
  207.         
  208.         final int rowStart = startRow < 0 ? 0 : startRow;
  209.         final int columnStart = startColumn < 0 ? 0 : startColumn;
  210.         
  211.         final int maxRow = POIUtils.getRows(sheet);
  212.         for(int i=rowStart; i < maxRow; i++) {
  213.             final Row row = sheet.getRow(i);
  214.             if(row == null) {
  215.                 continue;
  216.             }
  217.             
  218.             final int maxCol = row.getLastCellNum();;
  219.             for(int j=columnStart; j < maxCol; j++) {
  220.                 
  221.                 if(excludeStartPoisition && includeInStartPosition(j, i)) {
  222.                     // 開始位置を除外する場合
  223.                     continue;
  224.                 }
  225.                 
  226.                 final Cell cell = row.getCell(j, MissingCellPolicy.CREATE_NULL_AS_BLANK);
  227.                 final String cellValue = POIUtils.getCellContents(cell, config.getCellFormatter());
  228.                 if(Utils.matches(cellValue, label, config)) {
  229.                     return cell;
  230.                 }
  231.             }
  232.         }
  233.         
  234.         return null;
  235.         
  236.     }
  237.     
  238.     /**
  239.      * 現在の位置が検索対象の開始位置を含むかどうか判定します。
  240.      * @param currentColumn 現在の列番号
  241.      * @param currentRow 現在の行番号
  242.      * @return trueの場合含みます。
  243.      */
  244.     private boolean includeInStartPosition(final int currentColumn, final int currentRow) {
  245.         
  246.         if(startColumn >=0 && startRow >= 0
  247.                 && currentColumn == startColumn && currentRow == startRow) {
  248.             // 行と列の両方の指定がある場合
  249.             return true;
  250.             
  251.         } else if(startColumn >= 0 && startRow < 0 && currentColumn == startColumn) {
  252.             // 列の指定のみ
  253.             return true;
  254.             
  255.         } else if(startColumn < 0 && startRow >= 0 && currentRow == startRow) {
  256.             // 行の指定のみ
  257.             return true;
  258.             
  259.         }
  260.         
  261.         return false;
  262.         
  263.     }
  264.     
  265. }
Created with JaCoCo 0.8.5.201910111838