Apache-poi-core-classes

提供:Dev Guides
移動先:案内検索

Apache POI –コアクラス

この章では、Javaプログラムを使用してExcelファイルを操作するために重要なApache POI APIのクラスとメソッドについて説明します。

ワークブック

これは、Excelブックを作成または管理するすべてのクラスのスーパーインターフェイスです。 org.apache.poi.ss.usermodel パッケージに属します。 このインターフェイスを実装する2つのクラスは次のとおりです-

  • HSSFWorkbook -このクラスには、.xls形式のMicrosoft Excelファイルを読み書きするメソッドがあります。 MS-Officeバージョン97–2003と互換性があります。
  • XSSFWorkbook -このクラスには、.xlsまたは.xlsx形式のMicrosoft ExcelおよびOpenOffice xmlファイルを読み書きするメソッドがあります。 MS-Officeバージョン2007以降と互換性があります。

HSSFWorkbook

これは org.apache.poi.hssf.usermodel パッケージの下にある高レベルのクラスです。 Workbook インターフェースを実装し、.xls形式のExcelファイルに使用されます。 以下に、このクラスのメソッドとコンストラクターの一部を示します。

クラスコンストラクター

Sr.No. Constructor & Description
1

HSSFWorkbook()

新しいHSSFWorkbookオブジェクトをゼロから作成します。

2

HSSFWorkbook(DirectoryNode directory, boolean preserveNodes)

特定のディレクトリ内に新しいHSSFWworkbookオブジェクトを作成します。

3

HSSFWorkbook(DirectoryNode directory, POIFSFileSystem fs, boolean preserveNodes)

POIFSFileSystemオブジェクトとその中の特定のディレクトリを指定すると、SSFWorkbookオブジェクトを作成して、指定されたワークブックを読み取ります。

4

HSSFWorkbook(java.io.InputStream s)

入力ストリームを使用して、新しいHSSFWorkbookオブジェクトを作成します。

5

HSSFWorkbook(java.io.InputStream s, boolean preserveNodes)

入力ストリームの周りにPOIファイルシステムを構築します。

6

HSSFWorkbook(POIFSFileSystem fs)

POIFSFileSystemオブジェクトを使用して、新しいHSSFWorkbookオブジェクトを構築します。

7

HSSFWorkbook(POIFSFileSystem fs, boolean preserveNodes)

POIFSFileSystemオブジェクトを指定すると、新しいHSSFWorkbookオブジェクトを作成して、指定されたワークブックを読み取ります。

これらのコンストラクタ内で頻繁に使用されるパラメータは次のとおりです-

  • ディレクトリ-処理元のPOIファイルシステムディレクトリです。
  • fs -ワークブックストリームを含むのはPOIファイルシステムです。
  • preservenodes -これは、マクロなどの他のノードを保持するかどうかを決定するオプションのパラメーターです。 POIFileSystemをすべてメモリに保存するため(設定されている場合)、大量のメモリを消費します。

-HSSFWorkbookクラスには多くのメソッドが含まれています。ただし、これらはxls形式とのみ互換性があります。 このチュートリアルでは、最新バージョンのExcelファイル形式に焦点を当てています。 したがって、HSSFWorkbookのクラスメソッドはここにリストされていません。 これらのクラスメソッドが必要な場合は、http://poi.apache.org/apidocs/org/apache/poi/hssf/usermodel/HSSFWorkbookl [[[1]]]

XSSFWorkbook

これは、高レベルと低レベルの両方のExcelファイル形式を表すために使用されるクラスです。 org.apache.xssf.usemodel パッケージに属し、 Workbook インターフェースを実装します。 以下に、このクラスのメソッドとコンストラクターをリストします。

クラスコンストラクター

Sr.No. Constructor & Description
1

XSSFWorkbook()

新しいXSSFworkbookオブジェクトをゼロから作成します。

2

XSSFWorkbook(java.io.File file)

指定されたファイルからXSSFWorkbookオブジェクトを構築します。

3

XSSFWorkbook(java.io.InputStream is)

入力ストリーム全体をメモリにバッファリングし、そのオブジェクトのOPCPackageオブジェクトを開くことにより、XSSFWorkbookオブジェクトを構築します。

4

XSSFWorkbook(java.lang.String path)

ファイルのフルパスを指定してXSSFWorkbookオブジェクトを構築します。

クラスメソッド

Sr.No. Method & Description
1

createSheet()

このワークブックのXSSFSheetを作成してシートに追加し、高レベルの表現を返します。

2

createSheet(java.lang.String sheetname)

このワークブックの新しいシートを作成し、高レベルの表現を返します。

3

createFont()

新しいフォントを作成し、ブックのフォントテーブルに追加します。

4

createCellStyle()

新しいXSSFCellStyleを作成し、ワークブックのスタイルテーブルに追加します。

5

createFont()

新しいフォントを作成し、ブックのフォントテーブルに追加します。

6

setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow,int endRow)

指定されたパラメーターに従って、指定されたシートの印刷領域を設定します。

このクラスの残りのメソッドについては、https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFWorkbookl [[[2]]]をご覧ください。

シート

Sheetは org.apache.poi.ss.usermodel パッケージの下のインターフェースであり、特定の名前で高レベルまたは低レベルのスプレッドシートを作成するすべてのクラスのスーパーインターフェースです。 スプレッドシートの最も一般的なタイプはワークシートであり、セルのグリッドとして表されます。

HSSFSheet

これは org.apache.poi.hssf.usermodel パッケージの下のクラスです。 Excelスプレッドシートを作成でき、シートスタイルとシートデータをフォーマットできます。

クラスコンストラクター

Sr.No. Constructor & Description
1

HSSFSheet(HSSFWorkbook workbook)

HSSFWorkbookによって呼び出される新しいHSSFSheetを作成して、シートを最初から作成します。

2

HSSFSheet(HSSFWorkbook workbook, InternalSheet sheet)

指定されたシートオブジェクトを表すHSSFSheetを作成します。

XSSFSheet

これは、Excelスプレッドシートの高レベルの表現を表すクラスです。 org.apache.poi.hssf.usermodel パッケージの下にあります。

クラスコンストラクター

Sr.No. Constructor & Description
1

XSSFSheet()

新しいXSSFSheetを作成します-XSSFWorkbookによって呼び出され、シートを最初から作成します。

2

XSSFSheet(PackagePart part, PackageRelationship rel)

指定されたパッケージパーツと関係を表すXSSFSheetを作成します。

クラスメソッド

Sr.No. Method & Description
1

addMergedRegion(CellRangeAddress region)

セルの結合領域を追加します(したがって、これらのセルが1つを形成します)。

2

autoSizeColumn(int column)

内容に合わせて列の幅を調整します。

3

iterator()

このメソッドは、foreachループを許可するrowIterator()のエイリアスです

4

addHyperlink(XSSFHyperlink hyperlink)

このシートのハイパーリンクのコレクションにハイパーリンクを登録します

このクラスの残りのメソッドについては、https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFSheetl [[[3]] org/apache/poi/xssf/usermodel/XSSFSheetl。]

Row

これは org.apache.poi.ss.usermodel パッケージの下のインターフェースです。 スプレッドシートの行の高レベル表現に使用されます。 これは、POIライブラリの行を表すすべてのクラスのスーパーインターフェースです。

XSSFRow

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 Rowインターフェイスを実装するため、スプレッドシートに行を作成できます。 以下に、このクラスのメソッドとコンストラクターをリストします。

クラスメソッド

Sr.No. Method & Description
1

createCell(int columnIndex)

行内に新しいセルを作成して返します。

2

setHeight(short height)

高さを短い単位で設定します。

このクラスの残りのメソッドについては、所定のリンクhttps://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFRowlに従ってください。

Cell

これは org.apache.poi.ss.usermodel パッケージの下のインターフェースです。 これは、スプレッドシートの行のセルを表すすべてのクラスのスーパーインターフェースです。

セルは、空白、数値、日付、エラーなどのさまざまな属性を取得できます。 セルは、行に追加される前に、独自の番号(0ベース)を持つ必要があります。

XSSFCell

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 Cellインターフェースを実装します。 これは、スプレッドシートの行のセルの高レベルの表現です。

フィールドサマリー

以下に、XSSFCellクラスのフィールドの一部とその説明を示します。

Sr.No. Cell Type & Description
1

CELL_TYPE_BLANK

空白のセルを表します

2

CELL_TYPE_BOOLEAN

ブールセルを表します(trueまたはfalse)

3

CELL_TYPE_ERROR

セルのエラー値を表します

4

CELL_TYPE_FORMULA

セルの数式の結果を表します

5

CELL_TYPE_NUMERIC

セルの数値データを表します

6

CELL_TYPE_STRING

セルの文字列(テキスト)を表します

クラスメソッド

Sr.No. Method & Description
1

setCellStyle(CellStyle style)

セルのスタイルを設定します。

2

setCellType(int cellType)

セルのタイプ(数値、数式、または文字列)を設定します。

3

setCellValue(boolean value)

セルのブール値を設定します。

4

setCellValue(java.util.Calendar value)

セルの日付値を設定します。

5

setCellValue(double value)

セルに数値を設定します。

6

setCellValue(java.lang.String str)

セルの文字列値を設定します。

7

setHyperlink(Hyperlink hyperlink)

このセルにハイパーリンクを割り当てます。

このクラスの残りのメソッドとフィールドについては、次のリンクにアクセスしてください:https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFCelll

XSSFCellStyle

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 スプレッドシートのセル内のコンテンツの形式に関する可能な情報を提供します。 また、その形式を変更するためのオプションも提供します。 CellStyleインターフェースを実装します。

フィールドサマリー

次の表に、CellStyleインターフェースから継承されるいくつかのフィールドを示します。

Sr.No. Field & Description
1

ALIGN_CENTER

セルのコンテンツを中央に揃える

2

ALIGN_CENTER_SELECTION

中央選択の水平方向の配置

3

ALIGN_FILL

コンテンツサイズに合わせたセル

4

ALIGN_JUSTIFY

セルの内容を幅に合わせる

5

ALIGN_LEFT

セルの内容を左揃えにします

6

ALIGN_RIGHT

セルのコンテンツを右揃え

7

BORDER_DASH_DOT

ダッシュとドットを使用したセルスタイル

8

BORDER_DOTTED

点線の境界線を持つセルスタイル

9

BORDER_DASHED

破線の境界線を持つセルスタイル

10

BORDER_THICK

太い境界線を持つセルスタイル

11

BORDER_THIN

細い境界線を持つセルスタイル

12

VERTICAL_BOTTOM

セルの内容を垂直下に揃えます

13

VERTICAL_CENTER

セルの内容を垂直中央に揃える

15

VERTICAL_JUSTIFY

セルの内容を垂直方向に揃えて揃える

16

VERTICAL_TOP

上揃えの縦揃え

クラスコンストラクター

Sr.No. Constructor & Description
1

XSSFCellStyle(int cellXfId, int cellStyleXfId, StylesTable stylesSource, ThemesTable theme)

指定されたパーツからセルスタイルを作成します

2

XSSFCellStyle(StylesTable stylesSource)

空のセルスタイルを作成します

クラスメソッド

S.No Method & Description
1

setAlignment(short align)

セルの水平方向の配置のタイプを設定します

2

setBorderBottom(short border)

セルの下罫線の罫線の種類を設定します

3

setBorderColor(XSSFCellBorder.BorderSide side, XSSFColor color)

選択した境界線の色を設定します

4

setBorderLeft(Short border)

セルの左境界線の境界線のタイプを設定します

5

setBorderRight(short border)

セルの右境界線の境界線のタイプを設定します

6

setBorderTop(short border)

セルの上境界線の境界線のタイプを設定します

7

setFillBackgroundColor(XSSFColor color)

XSSFColor値として表される背景の塗りつぶし色を設定します。

8

setFillForegroundColor(XSSFColor color)

XSSFColor値として表される前景色の色を設定します。

9

setFillPattern(short fp)

パターンおよび単色のセル塗りつぶしのセル塗りつぶし情報を指定します。

10

setFont(Font font)

このスタイルのフォントを設定します。

11

setRotation(short rotation)

セル内のテキストの回転角度を設定します。

12

setVerticalAlignment(short align)

セルの垂直方向の配置のタイプを設定します。

このクラスの残りのメソッドとフィールドについては、次のリンクにアクセスしてください。https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFCellStylel

HSSFColor

これは org.apache.poi.hssf.util パッケージの下のクラスです。 ネストされたクラスとして異なる色を提供します。 通常、これらのネストされたクラスは、独自のインデックスを使用して表されます。 Colorインターフェイスを実装します。

入れ子クラス

このクラスのネストされたクラスはすべて静的であり、各クラスにはインデックスがあります。 これらのネストされたカラークラスは、セルコンテンツ、境界線、前景、背景などのセルの書式設定に使用されます。 以下は、ネストされたクラスの一部です。

Sr.No. Class names (colors)
1 HSSFColor.AQUA
2 HSSFColor.AUTOMATIC
3 HSSFColor.BLACK
4 HSSFColor.BLUE
5 HSSFColor.BRIGHT_GREEN
6 HSSFColor.BRIGHT_GRAY
7 HSSFColor.CORAL
8 HSSFColor.DARK_BLUE
9 HSSFColor.DARK_GREEN
10 HSSFColor.SKY_BLUE
11 HSSFColor.WHITE
12 HSSFColor.YELLOW

クラスメソッド

このクラスの1つのメソッドのみが重要であり、それはインデックス値を取得するために使用されます。

Sr.No. Method & Description
1

getIndex()

このメソッドは、ネストされたクラスのインデックス値を取得するために使用されます。

残りのメソッドとネストされたクラスについては、次のリンクを参照してください。https://poi.apache.org/apidocs/org/apache/poi/hssf/util/HSSFColorl

XSSFColor

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 スプレッドシートで色を表すために使用されます。 Colorインターフェイスを実装します。 以下に、そのメソッドとコンストラクターの一部を示します。

クラスコンストラクター

Sr.No. Constructor & Description
1

XSSFColor()

XSSFColorの新しいインスタンスを作成します。

2

XSSFColor(byte[] rgb)

RGBを使用してXSSFColorの新しいインスタンスを作成します。

3

XSSFColor(java.awt.Color clr)

awtパッケージのColorクラスを使用して、XSSFColorの新しいインスタンスを作成します。

クラスメソッド

Sr.No. Method & Description
1

setAuto(boolean auto)

ブール値を設定して、ctColorが自動であり、システムctColorが依存していることを示します。

2

setIndexed(int indexed)

インデックス付きctColor値をシステムctColorとして設定します。

残りのメソッドについては、次のリンクにアクセスしてください:https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFColorl

XSSFFont

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 Fontインターフェイスを実装しているため、ワークブック内のさまざまなフォントを処理できます。

クラスコンストラクター

Sr.No. Constructor & Description
1

XSSFFont()

新しいXSSFontインスタンスを作成します。

クラスメソッド

Sr.No. Method & Description
1

setBold(boolean bold)

「太字」属性のブール値を設定します。

2

setColor(short color)

フォントのインデックス付きカラーを設定します。

3

setColor(XSSFColor color)

標準のアルファRGBカラー値でフォントの色を設定します。

4

setFontHeight(short height)

フォントの高さをポイント単位で設定します。

5

setFontName(java.lang.String name)

フォントの名前を設定します。

6

setItalic(boolean italic)

'italic’プロパティのブール値を設定します。

残りのメソッドについては、次のリンクにアクセスしてください:https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFFontl

XSSFHyperlink

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 Hyperlinkインターフェースを実装します。 スプレッドシートのセルコンテンツへのハイパーリンクを設定するために使用されます。

フィールド

このクラスのフィールドは次のとおりです。 ここで、フィールドは使用されるハイパーリンクのタイプを意味します。

Sr.No. Field & Description
1

LINK_DOCUMENT

他のドキュメントをリンクするために使用

2

LINK_EMAIL

メールのリンクに使用

3

LINK_FILE

任意の形式の他のファイルをリンクするために使用されます

4

LINK_URL

Web URLのリンクに使用

クラスメソッド

Sr.No. Method & Description
1

setAddress(java.lang.String address)

ハイパーリンクアドレス。

残りのメソッドについては、次のリンクにアクセスしてください:https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFHyperlinkl

XSSFCreationHelper

これは org.apache.poi.xssf.usermodel パッケージの下のクラスです。 CreationHelperインターフェイスを実装します。 数式の評価とハイパーリンクの設定のサポートクラスとして使用されます。

クラスメソッド

Sr.No. Method & Description
1

createFormulaEvaluator()

数式セルを評価するオブジェクトであるXSSFFormulaEvaluatorインスタンスを作成します。

2

createHyperlink(int type)

新しいXSSFHyperlinkを作成します。

残りのメソッドについては、次のリンクを参照してください。https://poi.apache.org/apidocs/org/apache/poi/xssf/usermodel/XSSFCreationHelperl

XSSFPrintSetup

これは org.apache.poi.xsssf.usermodel パッケージの下のクラスです。 PrintSetup インターフェースを実装します。 印刷ページのサイズ、領域、オプション、および設定を設定するために使用されます。

クラスメソッド

Sr.No. Method & Description
1

setLandscape(boolean ls)

横向き印刷を許可またはブロックするブール値を設定します。

2

setLeftToRight(boolean ltor)

印刷中に左から右に移動するか、上から下に移動するかを設定します。

3

setPaperSize(short size)

用紙サイズを設定します。

残りのメソッドについては、次のリンクにアクセスしてください。https://poi.apache.org/apidocs/org/apache/poi/hssf/usermodel/HSSFPrintSetupl