    001/*
    002 * Copyright (c) 2009 The openGion Project.
    003 *
    004 * Licensed under the Apache License, Version 2.0 (the "License");
    005 * you may not use this file except in compliance with the License.
    006 * You may obtain a copy of the License at
    007 *
    008 *     http://www.apache.org/licenses/LICENSE-2.0
    009 *
    010 * Unless required by applicable law or agreed to in writing, software
    011 * distributed under the License is distributed on an "AS IS" BASIS,
    012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
    013 * either express or implied. See the License for the specific language
    014 * governing permissions and limitations under the License.
    015 */
    016package org.opengion.fukurou.util;
    017
    018/**
    019 * POI による、EXCELバイナリファイルに対する、読み込みイベント処理用のインターフェースです。
    020 *
    021 * 基本的なPOIでの読み取りレコードに対して、イベント処理する場合に使用します。
    022 * このメソッドは、それぞれのPOIUtil処理中に、塊単位で呼ばれるため、逐次処理に向いています。
    023 *
    024 * 設定される引数は、WORD,PPT,EXCEL 処理ごとに異なります。
    025 *
    026 * @og.rev 6.0.2.0 (2014/08/29) 新規作成
    027 * @og.group その他
    028 *
    029 * @version  6.0
    030 * @author   Kazuhiko Hasegawa
    031 * @since    JDK7.0,
    032 */
    033public interface POIEvent {
    034
    035        /**
    036         * 読み込みイベント処理のメソッドです。
    037         *
    038         * 読み取りレコードに対して、このメソッドがコールされます。
    039         *
    040         * 例：
    041         *   WORD :テキスト タイトル 0:Section番号 1:page番号     2:Paragraph番号
    042         *   PPT  :テキスト タイトル 0:Slide番号   1:TextRun番号
    043         *   EXCEL:テキスト Sheet名  0:Sheet番号   1:Row番号      2:Cell番号
    044         *
    045         * @og.rev 6.0.2.0 (2014/08/29) 新規作成
    046         *
    047         * @param       text テキスト
    048         * @param       cmnt 説明
    049         * @param       args... 可変長引数(ページ数や行番号など)
    050         */
    051        void readText( String text , String cmnt , int... args );
    052}