/*************************************************************************
 *
 * Copyright 2009 by bBreak Systems.
 *
 * ExCella Core - ExcelファイルをJavaから利用するための共通基盤
 *
 * $Id: SheetParser.java 56 2009-05-21 04:13:39Z yuta-takahashi $
 * $Revision: 56 $
 *
 * This file is part of ExCella Core.
 *
 * ExCella Core is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * ExCella Core is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the COPYING.LESSER file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with ExCella Core.  If not, see
 * <http://www.gnu.org/licenses/lgpl-3.0-standalone.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
package org.bbreak.excella.core;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;


import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.bbreak.excella.core.exception.ParseException;
import org.bbreak.excella.core.tag.TagParser;
import org.bbreak.excella.core.util.PoiUtil;
import org.bbreak.excella.core.util.TagUtil;

/**
 * シートの解析を行うクラス
 * 
 * タグを検査して、一致するタグが存在した場合は対応するタグパーサを呼び出し、
 * 結果をSheetDataに設定する
 * 
 * タグの検査は行列方向([1,A] [1,B]・・・、[2,A] [2,B]・・・)で行う
 * 
 * タグにLastTag=Trueのパラメータが設定されていた場合はそのタグを処理して終了する。
 * 
 * @since 1.0
 */
public class SheetParser {
	
	/** 結果キーパラメータ */
    protected static final String PARAM_RESULT_KEY = "ResultKey";

    /** 最終タグパラメータ */
    protected static final String PARAM_LAST_TAG = "LastTag";

    /** ログ */
    private static Log log = LogFactory.getLog( SheetParser.class);

    /** タグパーサのリスト */
    private List<TagParser<?>> tagParsers = new ArrayList<TagParser<?>>();

    /**
     * シートの解析
     * 
     * @param sheet 解析対象シート
     * @param object BookControllerのparseBook(), parseSheet()メソッド、 
     *                SheetParserのparseSheetメソッドで引数を渡した場合に
     *                TagParserまで引き継がれる処理データ
     * @return 解析結果
     * @throws ParseException 解析に失敗した場合にThrowされる
     */
    public SheetData parseSheet( Sheet sheet, Object data) throws ParseException {
        // 解析結果
        String sheetName = PoiUtil.getSheetName( sheet);
        SheetData sheetData = new SheetData( sheetName);

        int firstRowNum = sheet.getFirstRowNum();

        // タグセルの検査
        for ( int rowCnt = firstRowNum; rowCnt <= sheet.getLastRowNum(); rowCnt++) {
            // 行の取得
            Row row = sheet.getRow( rowCnt);
            if ( row == null) {
                continue;
            }
            if ( row != null) {
                for ( int columnIdx = 0; columnIdx < row.getLastCellNum(); columnIdx++) {
                    // セルの取得
                    Cell cell = row.getCell( columnIdx);
                    if ( cell == null) {
                        continue;
                    }
                    for ( TagParser<?> parser : tagParsers) {
                        // 処理判定チェック
                        if ( parser.isParse( sheet, cell)) {
                            Map<String, String> paramDef = TagUtil.getParams( cell.getStringCellValue());
                            // 処理実行
                            Object result = parser.parse( sheet, cell, data);

                            // 結果の追加
                            if ( result != null) {
                                // パラメータにResultKeyが指定されていればResultKeyを使用する。
                                // 未指定の場合はTag名を利用する。
                                String resultKey = parser.getTag();
                                if ( paramDef.containsKey( PARAM_RESULT_KEY)) {
                                    resultKey = paramDef.get( PARAM_RESULT_KEY);
                                }
                                sheetData.put( resultKey, result);
                            }
                            // パース結果のロギング
                            if ( log.isInfoEnabled()) {
                                StringBuilder resultBuf = new StringBuilder( cell + "の処理結果:");
                                if ( result instanceof Map) {
                                    Map<?, ?> mapResult = ( Map<?, ?>) result;
                                    Set<?> keyset = mapResult.keySet();
                                    for ( Object key : keyset) {
                                        resultBuf.append( "[" + key + ":" + mapResult.get( key) + "]");
                                    }
                                } else if ( result instanceof Collection) {
                                    Collection<?> listResult = ( Collection<?>) result;
                                    resultBuf.append( listResult.getClass() + " Size=" + listResult.size());
                                } else {
                                    resultBuf.append( result);
                                }
                                log.info( resultBuf.toString());
                            }

                            // 大量データを考慮して最終タグ判定。最終タグの場合はそのタグでシートの処理は抜ける

                            if ( paramDef.containsKey( PARAM_LAST_TAG)) {
                                String strLastTag = paramDef.get( PARAM_LAST_TAG);
                                try {
                                    if ( Boolean.parseBoolean( strLastTag)) {
                                        return sheetData;
                                    }
                                } catch ( Exception e) {
                                    throw new ParseException( cell);
                                }
                            }
                        }
                    }
                }
            }
        }

        return sheetData;
    }

    /**
     * パーサの追加
     * 
     * @param tagParser 対象のTagParser
     */
    public void addTagParser( TagParser<?> tagParser) {
        tagParsers.add( tagParser);
    }

    /**
     * パーサの一覧取得
     * 
     * @return 現在設定されているパーサのリスト
     */
    public List<TagParser<?>> getTagParsers() {
        return tagParsers;
    }
}
