jp.co.nissy.jpicosheet.core
クラス Cell

java.lang.Object
  上位を拡張 jp.co.nissy.jpicosheet.core.Cell
すべての実装されたインタフェース:
java.lang.Comparable<Cell>

public class Cell
extends java.lang.Object
implements java.lang.Comparable<Cell>

値の保持、他のセルの参照や計算を行う"セル"です。
セルにはいくつかの種類および状態があります。 セルの種類には空、数値、文字列、式があります。種類の情報はgetCellType()で得ることができます。
セルの状態には計算必要、計算中、計算済み、エラーがあります。状態の情報はgetCellStatus()で得ることができます。
セルの値は保持しているデータの種類や式の計算結果によって変化しますが、getValue()で得ることができるのはElement型オブジェクトです。 Element型オブジェクトはセルの値を表す汎用のデータ型です。
セルは必ずいずれかのシートに属します。アプリケーションがセルオブジェクトを単体で作成することはできず、Sheetクラスの addCell()メソッドによって作成します。

作成者:
yusuke nishikawa

入れ子のクラスの概要
static class Cell.CellStatus
           
static class Cell.CellType
           
 
メソッドの概要
 int compareTo(Cell o)
           
 Cell createUndefinedReferenceCells()
          このセルが式を持っており、式の中に存在しないセルへの参照がある場合、対応するセルを作成します。
 boolean equals(java.lang.Object obj)
           
 Cell.CellType getCellType()
          このセルのタイプを返します
 java.lang.String getFormula()
          式を返します。
 java.lang.String getFullyQualifiedName()
          このセルの完全修飾名を返します
 java.lang.String getLabel()
          このセルのラベルを返します
 java.lang.String getName()
          このセルの名前を返します
 Sheet getSheet()
          このセルを持っているシートへの参照を返します
 Cell.CellStatus getStatus()
          このセルのステータスを返します
 java.lang.String getString()
          このセルの値を文字列として返します
 Element getValue()
          セルの値を返します
 java.lang.String getValueString()
           
 Element.ElementType getValueType()
          このセルの値のタイプを返します
 int hashCode()
           
 Cell setBooleanValue(boolean bool)
           
 Cell setEmptyValue()
          このセルの値を空にします
 Cell setFormula(java.lang.String formula)
          セルに式をセットします。
 Cell setLabel(java.lang.String newLabel)
          ラベルをセットします
 Cell setNumberValue(java.lang.String numString)
          セルに数値をセットします
 Cell setStringValue(java.lang.String string)
          セルに文字列をセットします
 Cell setValue(java.lang.String value)
          セルの値をセットします。
 java.lang.String toString()
           
 
クラス java.lang.Object から継承されたメソッド
getClass, notify, notifyAll, wait, wait, wait
 

メソッドの詳細

getFormula

public java.lang.String getFormula()
式を返します。返される文字列にはこの文字列が式であることを明示する"="が先頭に付けられます。
このセルが CellType.FORMULA でない場合、nullを返します。

戻り値:
式の文字列。セルが CellType.FORMULA でない場合、null

getName

public java.lang.String getName()
このセルの名前を返します

戻り値:
セルの名前

getLabel

public java.lang.String getLabel()
このセルのラベルを返します

戻り値:
セルのラベル

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()
このセルの完全修飾名を返します

戻り値:
セルの完全修飾名

getSheet

public Sheet getSheet()
このセルを持っているシートへの参照を返します

戻り値:
このセルを持っているシートへの参照

getStatus

public Cell.CellStatus getStatus()
このセルのステータスを返します

戻り値:
このセルのステータス

getString

public java.lang.String getString()
このセルの値を文字列として返します

戻り値:
セルの値の文字列表現

getValueType

public Element.ElementType getValueType()
このセルの値のタイプを返します

戻り値:
このセルの、現在の値のタイプ

getCellType

public Cell.CellType getCellType()
このセルのタイプを返します

戻り値:
このセルの、現在のタイプ

getValue

public Element getValue()
セルの値を返します

戻り値:
セルの値

getValueString

public java.lang.String getValueString()

setLabel

public Cell setLabel(java.lang.String newLabel)
ラベルをセットします

パラメータ:
newLabel - 新しいラベル
戻り値:
このセルオブジェクトへの参照

setValue

public Cell setValue(java.lang.String value)
セルの値をセットします。
値として渡された文字列をチェックし、適切な型の値として保存します。

パラメータ:
value - 値の文字列表現
戻り値:
このセル

createUndefinedReferenceCells

public Cell createUndefinedReferenceCells()
このセルが式を持っており、式の中に存在しないセルへの参照がある場合、対応するセルを作成します。 セル参照に対応するセルがすでに存在する場合は何も行いません。
セル参照が他のシートへの参照だった場合、そのシートに対しセルを作成します。ただしシートが存在しない場合は ReferenceNotFoundExceptionが発生します。
このセルに式以外の値がセットされていた場合、何も行いません。

戻り値:
cell このセル

setNumberValue

public Cell setNumberValue(java.lang.String numString)
セルに数値をセットします

パラメータ:
numString - 数値の文字列表現
戻り値:
このセルオブジェクトへの参照

setStringValue

public Cell setStringValue(java.lang.String string)
セルに文字列をセットします

パラメータ:
string - セルの値
戻り値:
このセルオブジェクトへの参照

setBooleanValue

public Cell setBooleanValue(boolean bool)

setFormula

public Cell setFormula(java.lang.String formula)
セルに式をセットします。 式が入力されると、このセルは再計算が必要な状態となります。

パラメータ:
formula - 式
戻り値:
このセルオブジェクトへの参照

setEmptyValue

public Cell setEmptyValue()
このセルの値を空にします

戻り値:
このセルオブジェクトへの参照

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString

compareTo

public int compareTo(Cell o)
定義:
インタフェース java.lang.Comparable<Cell> 内の compareTo

equals

public boolean equals(java.lang.Object obj)
オーバーライド:
クラス java.lang.Object 内の equals

hashCode

public int hashCode()
オーバーライド:
クラス java.lang.Object 内の hashCode