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

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

public class Sheet
extends Object
implements Comparable<Sheet>

複数のセル、グループを持つことのできる"シート"です。
初期状態のシートにはセルが1つもありません。シートには絶対アドレスが無く、ちょうど真っ白な紙のような状態となっています。 この真っ白なシートに対してセルを1つづつ追加していきます。セルにはセル名を指定し、このセル名がセルアドレスの代わりとなります。 1つのシートの中に同じ名前のセルを複数作ることはできません。
シートにはセルに加え、グループとテーブルを加えることができます。
グループは複数のセルの集合を表すものです。グループもセルと同様ユニークな名前を 付けますが、グループ名には末尾に"@"を加えます。
テーブルはグループと同じくセルの集合ですが、セルが行と列に順序を保った状態で保持されているためデータの保持に便利です。 テーブル名には末尾に"#"を加えます。テーブル内のセルにアクセスするにはテーブル名の後ろに"R1C1形式"でテーブル内のセルアドレスを指定します。
セル、グループともに任意の数をシートに追加することができます。
シートごとに保持する数値の精度を指定することができます。

作成者:
yusuke nishikawa

コンストラクタの概要
Sheet(String sheetName, Book book)
          シート名およびブックを指定してシートを作成します。
Sheet(String sheetName, Book book, MathContext mc)
          シート名およびブック、MathContextオブジェクトを指定してシートを作成します。
 
メソッドの概要
 Cell addCell(String cellName)
          シートにセルを追加します。
 Group addGroup(String groupName)
          シートにグループを追加します
 Table addTable(String tableName, int rowSize, int colSize)
          シートにテーブルを追加します
 boolean cellExists(Cell cell)
          指定したセルオブジェクトがセルに存在する場合、Trueを返します
 boolean cellExists(String cellName)
          指定した名前のセルがシートに存在する場合、Trueを返します
 int compareTo(Sheet o)
           
 boolean containsErrorCell()
          このシートが保持しているセルの中にエラーのセルがあるかを返します
 void deleteCell(Cell cell)
          セルを削除します
指定したセルがシートに存在しない場合、何もしません。
 void deleteCell(String cellName)
          セルを削除します
指定したセルがシートに存在しない場合、何もしません。
 void deleteGroup(Group group)
          グループを削除します
指定したグループが存在しない場合、何もしません。
 void deleteGroup(String groupName)
          グループを削除します
指定したグループがシートに存在しない場合、何もしません。
 void deleteTable(String tableName)
          テーブルを削除します。
 void deleteTable(Table table)
          テーブルを削除します。
 boolean equals(Object obj)
           
 Book getBook()
          このシートが属するBookオブジェクトを返します
 Cell getCell(String cellName)
          引数で指定したセル名を持つセルオブジェクトを返します。
 Set<String> getCellNames()
          このシートが保持しているすべてのセルの名前(完全修飾セル名ではないセル名)を返します
 Set<Cell> getCells()
          このシートが保持しているすべてのセルへの参照を返します
 Map<String,Cell> getErrorCells()
          このシートが保持しているエラーセルのSetを返します
 Group getGroup(String groupName)
          引数で指定したグループ名を持つグループオブジェクトを返します。
 MathContext getMathContext()
          このシートのデフォルトMathContextオブジェクトを返します
 String getName()
          シート名を返します。
 Table getTable(String tableName)
          指定したテーブル名を持つテーブルオブジェクトを返します。
 boolean groupExists(Group group)
          指定したグループオブジェクトがシートに存在する場合、Trueを返します
 boolean groupExists(String groupName)
          指定した名前のグループがシートに存在する場合、Trueを返します
 int hashCode()
           
 void renameCell(String cellName, String newCellName)
          セル名を変更します
 void setMathContext(MathContext mc)
          このシートのデフォルトMathContextオブジェクトを指定します
 void setName(String sheetName)
          シート名をセットします
 boolean tableExists(String tableName)
          指定した名前のテーブルがシートに存在する場合、Trueを返します
 boolean tableExists(Table table)
          指定したテーブルオブジェクトがシートに存在する場合、trueを返します
 String toString()
           
 
クラス java.lang.Object から継承されたメソッド
getClass, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

Sheet

public Sheet(String sheetName,
             Book book)
      throws IllegalArgumentException
シート名およびブックを指定してシートを作成します。

パラメータ:
sheetName - シート名
_book - このブックが属するBookオブジェクト
例外:
IllegalArgumentException - シート名が正しくない場合

Sheet

public Sheet(String sheetName,
             Book book,
             MathContext mc)
      throws IllegalArgumentException
シート名およびブック、MathContextオブジェクトを指定してシートを作成します。

パラメータ:
sheetName - シート名
_book - このブックが属するBookオブジェクト
_mc - このシートの計算時にデフォルトで使用するMathContextオブジェクト
例外:
IllegalArgumentException - シート名が正しくない場合
メソッドの詳細

getName

public String getName()
シート名を返します。

戻り値:
シート名

setName

public void setName(String sheetName)
             throws IllegalArgumentException
シート名をセットします

パラメータ:
cellName - 新しいシート名
例外:
IllegalArgumentException - シート名が正しくない場合

getBook

public Book getBook()
このシートが属するBookオブジェクトを返します

戻り値:
このシートが属するBookオブジェクト

getMathContext

public MathContext getMathContext()
このシートのデフォルトMathContextオブジェクトを返します

戻り値:
このシートのデフォルトMathContextオブジェクト

setMathContext

public void setMathContext(MathContext mc)
このシートのデフォルトMathContextオブジェクトを指定します

パラメータ:
_mc - このシートのデフォルトMathContextオブジェクト

cellExists

public boolean cellExists(String cellName)
                   throws IllegalArgumentException
指定した名前のセルがシートに存在する場合、Trueを返します

パラメータ:
cellName - 存在を確認するセル名
戻り値:
存在する場合true、そうでない場合false
例外:
IllegalArgumentException - セル名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

cellExists

public boolean cellExists(Cell cell)
指定したセルオブジェクトがセルに存在する場合、Trueを返します

パラメータ:
cell - 存在を確認するセルオブジェクト
戻り値:
存在する場合true、そうでない場合false

addCell

public Cell addCell(String cellName)
シートにセルを追加します。
すでに存在するセル名が指定された場合、既存のセルオブジェクトを返します。

パラメータ:
cellName - セル名
戻り値:
セルオブジェクト
例外:
IllegalArgumentException - セル名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

getCell

public Cell getCell(String cellName)
             throws ReferenceNotFoundException
引数で指定したセル名を持つセルオブジェクトを返します。

パラメータ:
cellName - セル名
戻り値:
セルオブジェクト
例外:
ReferenceNotFoundException - 指定した名前のセルが存在しない場合
IllegalArgumentException - セル名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

getCells

public Set<Cell> getCells()
このシートが保持しているすべてのセルへの参照を返します

戻り値:
シートが保持しているすべてのセルへの参照

getCellNames

public Set<String> getCellNames()
このシートが保持しているすべてのセルの名前(完全修飾セル名ではないセル名)を返します

戻り値:
シートが保持しているすべてのセルの名前

containsErrorCell

public boolean containsErrorCell()
このシートが保持しているセルの中にエラーのセルがあるかを返します

戻り値:
エラーセルが存在する場合true、なければfalse

getErrorCells

public Map<String,Cell> getErrorCells()
このシートが保持しているエラーセルのSetを返します

戻り値:
このシートが保持しているエラーセルのSet

renameCell

public void renameCell(String cellName,
                       String newCellName)
                throws ReferenceNotFoundException,
                       IllegalArgumentException
セル名を変更します

パラメータ:
cellName - 変更するセルのセル名
newCellName - 新しいセル名
例外:
ReferenceNotFoundException - 変更するセルが見つからなかった場合
IllegalArgumentException - セル名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

deleteCell

public void deleteCell(Cell cell)
セルを削除します
指定したセルがシートに存在しない場合、何もしません。

パラメータ:
cell - 削除するセルオブジェクト

deleteCell

public void deleteCell(String cellName)
                throws IllegalArgumentException
セルを削除します
指定したセルがシートに存在しない場合、何もしません。

パラメータ:
cellName - 削除するセルのセル名
例外:
IllegalArgumentException - 完全修飾セル名を指定した際に、シート名がこのシートの名前と異なる場合

groupExists

public boolean groupExists(String groupName)
指定した名前のグループがシートに存在する場合、Trueを返します

パラメータ:
groupName - 存在を確認するグループ名
戻り値:
存在する場合true、そうでない場合false
例外:
IllegalArgumentException - グループ名が完全修飾グループ名であり、そのシート名部分がこのシートの名前と異なる場合

groupExists

public boolean groupExists(Group group)
指定したグループオブジェクトがシートに存在する場合、Trueを返します

パラメータ:
group - 存在を確認するグループオブジェクト
戻り値:
存在する場合true、そうでない場合false

addGroup

public Group addGroup(String groupName)
シートにグループを追加します

パラメータ:
groupName - グループ名
戻り値:
グループオブジェクト
例外:
IllegalArgumentException - グループ名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

getGroup

public Group getGroup(String groupName)
               throws ReferenceNotFoundException
引数で指定したグループ名を持つグループオブジェクトを返します。

パラメータ:
groupName - グループ名
戻り値:
グループオブジェクト
例外:
ReferenceNotFoundException - 指定した名前のグループが存在しない場合
IllegalArgumentException - グループ名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

deleteGroup

public void deleteGroup(Group group)
グループを削除します
指定したグループが存在しない場合、何もしません。

パラメータ:
group - 削除するグループ

deleteGroup

public void deleteGroup(String groupName)
グループを削除します
指定したグループがシートに存在しない場合、何もしません。

パラメータ:
groupName - 削除するグループのグループ名
例外:
IllegalArgumentException - グループ名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

tableExists

public boolean tableExists(String tableName)
指定した名前のテーブルがシートに存在する場合、Trueを返します

パラメータ:
tableName - テーブル名
戻り値:
存在する場合true、そうでない場合false
例外:
IllegalArgumentException - テーブル名が完全修飾テーブル名であり、そのシート名部分がこのシートの名前と異なる場合

tableExists

public boolean tableExists(Table table)
指定したテーブルオブジェクトがシートに存在する場合、trueを返します

パラメータ:
table - 存在を確認するテーブルオブジェクト
戻り値:
存在する場合true、そうでない場合false

addTable

public Table addTable(String tableName,
                      int rowSize,
                      int colSize)
シートにテーブルを追加します

パラメータ:
tableName - テーブル名
rowSize - このテーブルの行数
colSize - このテーブルの列数
戻り値:
テーブルオブジェクト

getTable

public Table getTable(String tableName)
               throws ReferenceNotFoundException
指定したテーブル名を持つテーブルオブジェクトを返します。

パラメータ:
tableName - テーブル名
戻り値:
テーブルオブジェクト
例外:
ReferenceNotFoundException - 指定した名前のテーブルが存在しない場合
IllegalArgumentException - テーブル名が完全修飾セル名であり、そのシート名部分がこのシートの名前と異なる場合

deleteTable

public void deleteTable(Table table)
テーブルを削除します。
指定したテーブルが存在しない場合、何もしません。

パラメータ:
table - テーブルオブジェクト

deleteTable

public void deleteTable(String tableName)
テーブルを削除します。
指定したテーブルが存在しない場合、何もしません。

パラメータ:
tableName - テーブル名

compareTo

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

equals

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

hashCode

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

toString

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