SheetFinder.java

  1. package com.gh.mygreen.xlsmapper;

  3. import java.lang.reflect.Field;
  4. import java.lang.reflect.Method;
  5. import java.util.ArrayList;
  6. import java.util.List;
  7. import java.util.Optional;
  8. import java.util.regex.Pattern;

  10. import org.apache.poi.ss.usermodel.Sheet;
  11. import org.apache.poi.ss.usermodel.Workbook;

  13. import com.gh.mygreen.xlsmapper.annotation.XlsSheetName;
  14. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessor;
  15. import com.gh.mygreen.xlsmapper.fieldaccessor.FieldAccessorFactory;
  16. import com.gh.mygreen.xlsmapper.localization.MessageBuilder;
  17. import com.gh.mygreen.xlsmapper.annotation.XlsSheet;
  18. import com.gh.mygreen.xlsmapper.util.ClassUtils;
  19. import com.gh.mygreen.xlsmapper.util.Utils;
  20. import com.gh.mygreen.xlsmapper.xml.AnnotationReadException;
  21. import com.gh.mygreen.xlsmapper.xml.AnnotationReader;

  23. /**
  24.  * 読み込み時/書き込み処理時のシートを取得するクラス。
  25.  * <p>アノテーション{@link XlsSheet}の設定値に従いシートを取得する。
  26.  * 
  27.  * @since 1.1
  28.  * @author T.TSUCHIE
  29.  *
  30.  */
  31. public class SheetFinder {
  32.     
  33.     /**
  34.      * 読み込み時のシートを取得する。
  35.      * 
  36.      * @param workbook Excelのワークブック。
  37.      * @param sheetAnno JavaBeanのクラスに付与されているアノテーション{@link XlsSheet}。
  38.      * @param annoReader
  39.      * @param beanClass JavaBeanのクラス。
  40.      * @return Excelのシート情報。複数ヒットする場合は、該当するものを全て返す。
  41.      * @throws SheetNotFoundException 該当のシートが見つからない場合にスローする。
  42.      * @throws AnnotationInvalidException アノテーションの使用方法が不正な場合
  43.      * @throws AnnotationReadException アノテーションをXMLで指定する方法が不正な場合。
  44.      */
  45.     public Sheet[] findForLoading(final Workbook workbook, final XlsSheet sheetAnno,
  46.             final AnnotationReader annoReader, final Class<?> beanClass)
  47.                     throws SheetNotFoundException, AnnotationInvalidException, AnnotationReadException {
  48.         
  49.         if(sheetAnno.name().length() > 0) {
  50.             // シート名から取得する。
  51.             final Sheet xlsSheet = workbook.getSheet(sheetAnno.name());
  52.             if(xlsSheet == null) {
  53.                 throw new SheetNotFoundException(sheetAnno.name());
  54.             }
  55.             return new Sheet[]{ xlsSheet };
  56.             
  57.         } else if(sheetAnno.number() >= 0) {
  58.             // シート番号から取得する
  59.             if(sheetAnno.number() >= workbook.getNumberOfSheets()) {
  60.                 throw new SheetNotFoundException(sheetAnno.number(), workbook.getNumberOfSheets());
  61.             }
  62.             
  63.             return new Sheet[]{ workbook.getSheetAt(sheetAnno.number()) }; 
  64.             
  65.         } else if(sheetAnno.regex().length() > 0) {
  66.             // シート名（正規表現）をもとにして、取得する。
  67.             final Pattern pattern = Pattern.compile(sheetAnno.regex());
  68.             final List<Sheet> matches = new ArrayList<>();
  69.             for(int i=0; i < workbook.getNumberOfSheets(); i++) {
  70.                 final Sheet xlsSheet = workbook.getSheetAt(i);
  71.                 if(pattern.matcher(xlsSheet.getSheetName()).matches()) {
  72.                     matches.add(xlsSheet);
  73.                 }
  74.             }
  75.             
  76.             if(matches.isEmpty()) {
  77.                 throw new SheetNotFoundException(sheetAnno.regex());
  78.             }
  79.             
  80.             return matches.toArray(new Sheet[matches.size()]);
  81.         }
  82.         
  83.         throw new AnnotationInvalidException(sheetAnno, MessageBuilder.create("anno.attr.required.any")
  84.                 .varWithClass("property", beanClass)
  85.                 .varWithAnno("anno", XlsSheet.class)
  86.                 .varWithArrays("attrNames", "name", "number", "regex")
  87.                 .format());
  88.     }
  89.     
  90.     /**
  91.      * 書き込み時のシートを取得する。
  92.      * @param workbook Excelのワークブック。
  93.      * @param sheetAnno JavaBeanのクラスに付与されているアノテーション{@link XlsSheet}。
  94.      * @param annoReader
  95.      * @param beanObj JavaBeanのオブジェクト。
  96.      * @return Excelのシート情報。複数ヒットする場合は、該当するものを全て返す。
  97.      * @throws SheetNotFoundException 該当のシートが見つからない場合にスローする。
  98.      * @throws AnnotationInvalidException アノテーションの使用方法が不正な場合
  99.      * @throws AnnotationReadException アノテーションをXMLで指定する方法が不正な場合。
  100.      */
  101.     public Sheet[] findForSaving(final Workbook workbook, final XlsSheet sheetAnno,
  102.             final AnnotationReader annoReader, final Object beanObj)
  103.                     throws SheetNotFoundException, AnnotationInvalidException, AnnotationReadException {
  104.         
  105.         if(sheetAnno.name().length() > 0) {
  106.             // シート名から取得する。
  107.             final Sheet xlsSheet = workbook.getSheet(sheetAnno.name());
  108.             if(xlsSheet == null) {
  109.                 throw new SheetNotFoundException(sheetAnno.name());
  110.             }
  111.             return new Sheet[]{ xlsSheet };
  112.             
  113.         } else if(sheetAnno.number() >= 0) {
  114.             // シート番号から取得する
  115.             if(sheetAnno.number() >= workbook.getNumberOfSheets()) {
  116.                 throw new SheetNotFoundException(sheetAnno.number(), workbook.getNumberOfSheets());
  117.             }
  118.             
  119.             return new Sheet[]{ workbook.getSheetAt(sheetAnno.number()) };
  120.             
  121.         } else if(sheetAnno.regex().length() > 0) {
  122.             // シート名（正規表現）をもとにして、取得する。
  123.             String sheetNameValue = null;
  124.             Optional<FieldAccessor> sheetNameField = getSheetNameField(beanObj, annoReader);
  125.             if(sheetNameField.isPresent()) {
  126.                 sheetNameValue = (String)sheetNameField.get().getValue(beanObj);
  127.             }
  128.             
  129.             final Pattern pattern = Pattern.compile(sheetAnno.regex());
  130.             final List<Sheet> matches = new ArrayList<>();
  131.             for(int i=0; i < workbook.getNumberOfSheets(); i++) {
  132.                 final Sheet xlsSheet = workbook.getSheetAt(i);
  133.                 if(pattern.matcher(xlsSheet.getSheetName()).matches()) {
  134.                     
  135.                     // オブジェクト中の@XslSheetNameで値が設定されている場合、Excelファイル中の一致するシートを元にする比較する
  136.                     if(Utils.isNotEmpty(sheetNameValue) && xlsSheet.getSheetName().equals(sheetNameValue)) {
  137.                         return new Sheet[]{ xlsSheet };
  138.                         
  139.                     }
  140.                     
  141.                     matches.add(xlsSheet);
  142.                 }
  143.             }
  144.             
  145.             if(sheetNameValue != null && !matches.isEmpty()) {
  146.                 // シート名が直接指定の場合
  147.                 throw new SheetNotFoundException(sheetNameValue);
  148.                 
  149.             } else if(matches.isEmpty()) {
  150.                 throw new SheetNotFoundException(sheetAnno.regex());
  151.                 
  152.             } else if(matches.size() == 1) {
  153.                 // １つのシートに絞り込めた場合
  154.                 return new Sheet[]{ matches.get(0) };
  155.                 
  156.             } else {
  157.                 // 複数のシートがヒットした場合
  158.                 List<String> names = new ArrayList<>();
  159.                 for(Sheet sheet : matches) {
  160.                     names.add(sheet.getSheetName());
  161.                 }
  162.                 throw new SheetNotFoundException(sheetAnno.regex(),
  163.                         MessageBuilder.create("sheet.regexMultipleHit")
  164.                             .var("regex", sheetAnno.regex())
  165.                             .var("names", names)
  166.                             .format());
  167.             }
  168.         }
  169.         
  170.         throw new AnnotationInvalidException(sheetAnno, MessageBuilder.create("anno.attr.required.any")
  171.                 .varWithClass("property", beanObj.getClass())
  172.                 .varWithAnno("anno", XlsSheet.class)
  173.                 .varWithArrays("attrNames", "name", "number", "regex")
  174.                 .format());
  175.         
  176.     }
  177.     
  178.     /**
  179.      * アノテーション「@XlsSheetName」が付与されているフィールド／メソッドを取得する。
  180.      * @param beanObj
  181.      * @param config
  182.      * @param annoReader
  183.      * @return 見つからない場合、空を返す。
  184.      * @throws AnnotationReadException 
  185.      */
  186.     private Optional<FieldAccessor> getSheetNameField(final Object beanObj, final AnnotationReader annoReader) throws AnnotationReadException {
  187.         
  188.         FieldAccessorFactory adpterFactory = new FieldAccessorFactory(annoReader);
  189.         
  190.         Class<?> clazz = beanObj.getClass();
  191.         for(Method method : clazz.getMethods()) {
  192.             method.setAccessible(true);
  193.             if(!ClassUtils.isGetterMethod(method)) {
  194.                 continue;
  195.             }
  196.             
  197.             if(!annoReader.hasAnnotation(method, XlsSheetName.class)) {
  198.                 continue;
  199.             }
  200.             
  201.             return Optional.of(adpterFactory.create(method));
  202.         }
  203.         
  204.         for(Field field : clazz.getDeclaredFields()) {
  205.             field.setAccessible(true);
  206.             
  207.             if(!annoReader.hasAnnotation(field, XlsSheetName.class)) {
  208.                 continue;
  209.             }
  210.             
  211.             return Optional.of(adpterFactory.create(field));
  212.             
  213.         }
  214.         
  215.         // not found
  216.         return Optional.empty();
  217.     }
  218.     
  219. }
Created with JaCoCo 0.8.5.201910111838