net.w_horse.excelpojo.excel.cellseeker
インタフェース CellSeeker

すべてのスーパーインタフェース:
java.lang.Cloneable
既知の実装クラスの一覧:
AbstractCellSeeker, AbstractRepeatsSeeker, ConstantValueCellSeeker, HorizontalRepeatsSeeker, LabeledCellSeeker, MappedCellSeeker, PointedCellSeeker, VerticalRepeatsSeeker

public interface CellSeeker
extends java.lang.Cloneable


メソッドの概要
 CellFieldConverter getConverter()
           
 ExcelPOJOBridge getExcelPOJOBridge()
           
 java.lang.String getRange()
           
 java.lang.String getUse()
           
 java.lang.Object seekCellValue(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Class<?> requiredType)
          セルの検索を行い、値を取得する。
 void set(java.lang.annotation.Annotation annotation, ExcelPOJOAnnotationParser parser)
          アノテーションパーサーに定義情報をセットしてもらう
 void setConverter(CellFieldConverter converter)
           
 void setExcelPOJOBridge(ExcelPOJOBridge excelPOJOBridge)
           
 void setRange(java.lang.String range)
           
 void setUse(java.lang.String use)
           
 void setValue(org.apache.poi.ss.usermodel.Sheet sheet, net.w_horse.excelpojo.excel.cellseeker.AbstractCellSeeker.Offset basePosition, net.w_horse.excelpojo.excel.cellseeker.AbstractCellSeeker.Offset offset, java.lang.Object value)
          セルの検索を行い、値をセットする。
 void setValue(org.apache.poi.ss.usermodel.Sheet sheet, java.lang.Object value)
          セルの検索を行い、値をセットする。
 boolean verify()
          実行時に定義内容の妥当性チェックを行う
定義に誤りや矛盾がある場合は IllegalArgumentExceptionをあげる
 

メソッドの詳細

set

void set(java.lang.annotation.Annotation annotation,
         ExcelPOJOAnnotationParser parser)
         throws java.lang.ClassNotFoundException,
                java.lang.LinkageError,
                ExcelPOJOException
アノテーションパーサーに定義情報をセットしてもらう

パラメータ:
annotation - アノテーション
parser - アノテーションパーサー
例外:
java.lang.ClassNotFoundException - listClassで無効なクラスが指定されていた場合
java.lang.LinkageError - listClassで無効なクラスが指定されていた場合
ExcelPOJOException - その他例外

seekCellValue

java.lang.Object seekCellValue(org.apache.poi.ss.usermodel.Sheet sheet,
                               java.lang.Class<?> requiredType)
                               throws java.lang.ClassNotFoundException,
                                      java.lang.LinkageError,
                                      CellNotFoundException,
                                      java.lang.IllegalArgumentException,
                                      ExcelPOJOException
セルの検索を行い、値を取得する。

パラメータ:
sheet - 検索対象(読み込み)のシート
requiredType - 取得する値の型
戻り値:
セルを検索した結果の値
例外:
java.lang.ClassNotFoundException - listClassで無効なクラスが指定されていた場合
java.lang.LinkageError - listClassで無効なクラスが指定されていた場合
CellNotFoundException - use="required"が指定されていた際にセルが見つからない場合
java.lang.IllegalArgumentException - 定義に誤り・矛盾がある場合
ExcelPOJOException - その他例外

setValue

void setValue(org.apache.poi.ss.usermodel.Sheet sheet,
              java.lang.Object value)
              throws CellNotFoundException,
                     java.lang.IllegalArgumentException,
                     ExcelPOJOException
セルの検索を行い、値をセットする。

パラメータ:
sheet - 検索対象(書き込み)のシート
value - 書き込む値
例外:
CellNotFoundException - use="required"が指定されていた際にセルが見つからない場合
java.lang.IllegalArgumentException - 定義に誤り・矛盾がある場合
ExcelPOJOException - その他例外

setValue

void setValue(org.apache.poi.ss.usermodel.Sheet sheet,
              net.w_horse.excelpojo.excel.cellseeker.AbstractCellSeeker.Offset basePosition,
              net.w_horse.excelpojo.excel.cellseeker.AbstractCellSeeker.Offset offset,
              java.lang.Object value)
              throws CellNotFoundException,
                     ExcelPOJOException
セルの検索を行い、値をセットする。
基点からセルを検索し、そこからの相対位置を指定して値をセットする。

パラメータ:
sheet - 書き込み対象のシート
basePosition - 基点
offset - 相対位置
value - 値
例外:
CellNotFoundException - use="required"が指定されていた際にセルが見つからない場合
ExcelPOJOException - その他例外

verify

boolean verify()
               throws java.lang.IllegalArgumentException,
                      ExcelPOJOException
実行時に定義内容の妥当性チェックを行う
定義に誤りや矛盾がある場合は IllegalArgumentExceptionをあげる

戻り値:
true:妥当 / false:誤りがある(例外があがる)
例外:
java.lang.IllegalArgumentException - 定義に誤りや矛盾がある場合
ExcelPOJOException - listClassで無効なクラスが指定されていた場合

setExcelPOJOBridge

void setExcelPOJOBridge(ExcelPOJOBridge excelPOJOBridge)

getExcelPOJOBridge

ExcelPOJOBridge getExcelPOJOBridge()

setUse

void setUse(java.lang.String use)

getUse

java.lang.String getUse()

setRange

void setRange(java.lang.String range)

getRange

java.lang.String getRange()

setConverter

void setConverter(CellFieldConverter converter)

getConverter

CellFieldConverter getConverter()