パッケージ com.osboffice.osbxl.dto

クラス PivotFieldObjectWrapper

java.lang.Object
com.osboffice.osbxl.dto.PivotFieldObjectWrapper
public class PivotFieldObjectWrapper extends Object
ピボットテーブルのフィールドオブジェクトです。

  • コンストラクタの詳細

    • PivotFieldObjectWrapper

      public PivotFieldObjectWrapper()
      コンストラクタ

      インスタンスを作成します。

  • メソッドの詳細

    • getFieldType

      public XlPivotFieldType getFieldType()
      フィールドの種類を取得します。
      戻り値:
      フィールドの種類

    • getCaption

      public String getCaption()
      フィールド名称を取得します。
      戻り値:
      フィールド名称

    • getDataFieldDisplayName

      public String getDataFieldDisplayName()
      フィールド表示名称を取得します。フィールドがデータフィールドの場合のみ、有効です。
      戻り値:
      フィールド表示名称

    • getDataFieldSubTotalsMethod

      public XlPivotFieldSubtotalsMethodType getDataFieldSubTotalsMethod()
      集計メソッドを取得します。フィールドがデータフィールドの場合のみ、有効です。
      戻り値:
      集計メソッド

    • getDataFieldCalculationMethod

      public XlPivotFieldCalculationType getDataFieldCalculationMethod()
      集計の計算方法を取得します。フィールドがデータフィールドである場合のみ有効です。
      戻り値:
      集計の計算方法

    • getBaseField

      public String getBaseField()
      集計の計算に用いるフィールド名称を取得します。フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドを用いる計算種類の場合、値が入ります。
      戻り値:
      集計の計算に用いるフィールド名称

    • getBaseItem

      public String getBaseItem()
      集計の計算に用いるアイテム名称を取得します。フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドの個別アイテムを用いる計算種類の場合、値が入ります。
      戻り値:
      集計の計算に用いるアイテム名称

    • getBaseItemSpecialCalculation

      public int getBaseItemSpecialCalculation()
      集計の計算に用いるアイテム名が、「次のアイテム」、「前のアイテム」かどうかを取得します。フィールドがデータフィールドである場合のみ有効です。集計の計算にフィールドの個別アイテムを用いる計算種類の場合で、次のアイテム、前のアイテムを設定した場合、値が入ります。
      戻り値:
      1:次のアイテム 2:前のアイテム

    • getNumberFormat

      public String getNumberFormat()
      集計フィールドに適用する書式を取得します。フィールドがデータフィールドである場合のみ有効です。
      戻り値:
      集計フィールドに適用する書式

    • getShowEmtpyItems

      public boolean getShowEmtpyItems()
      空アイテムを表示するかどうかを取得します。行/列フィールドの場合有効です。
      戻り値:
      true:表示する false:表示しない

    • getRepeatLabels

      public boolean getRepeatLabels()
      ラベルの繰り返しをするかどうかを取得します。行/列フィールドの場合有効です。
      戻り値:
      true:ラベルを繰り返す false:ラベルを繰り返さない

    • getInsertBlankRow

      public boolean getInsertBlankRow()
      空行をデータの後ろ(集計データの前)に挿入するかどうかを取得します。
      戻り値:
      true:空行を挿入する false:空行を挿入しない

    • getIncludeNewItemsInFilter

      public boolean getIncludeNewItemsInFilter()
      フィルターに、追加されたアイテムを表示するか取得します。ページアイテムの場合のみ、有効です。
      戻り値:
      true:追加されたアイテムを表示する false:追加されたアイテムを表示しない

    • setCaption

      public void setCaption(String caption)
      フィールド名称を設定します。
      パラメータ:
      caption - フィールド名称

    • setDataFieldDisplayName

      public void setDataFieldDisplayName(String displayName)
      フィールド表示名称を設定します。フィールドがデータフィールドの場合のみ、有効です。
      パラメータ:
      displayName - フィールド表示名称

    • setFieldType

      public void setFieldType(XlPivotFieldType type)
      フィールドの種類を設定します。
      パラメータ:
      type - フィールドの種類

    • setDataFieldSubTotalsMethod

      public void setDataFieldSubTotalsMethod(XlPivotFieldSubtotalsMethodType subtotalType)
      集計メソッドを設定します。フィールドがデータフィールドである場合のみ有効です。
      パラメータ:
      subtotalType - 集計メソッド

    • setDataFieldCalculation

      public void setDataFieldCalculation(XlPivotFieldCalculationType calculation)
      集計の計算方法を設定します。フィールドがデータフィールドである場合のみ有効です。
      パラメータ:
      calculation - 集計の計算方法

    • setDataFieldCalculation

      public void setDataFieldCalculation(XlPivotFieldCalculationType calculation, String baseField)
      集計の計算方法を設定します(フィールドを設定する計算種類)
      パラメータ:
      calculation - 集計の計算方法
      baseField - 集計対象のフィールドID

    • setDataFieldCalculation

      public void setDataFieldCalculation(XlPivotFieldCalculationType calculation, String baseField, String baseItem)
      集計の計算方法を設定します(フィールドおよびアイテムを設定する計算種類)
      パラメータ:
      calculation - 集計の計算方法
      baseField - 集計対象のフィールド名称
      baseItem - 集計対象のアイテム名称

    • setDataFieldCalculationSpecialItem

      public void setDataFieldCalculationSpecialItem(XlPivotFieldCalculationType calculation, String baseField, boolean nextItem)
      集計の計算方法を設定します(フィールドおよびアイテムを設定する計算種類で次のアイテムまたは前のアイテムを設定する場合)
      パラメータ:
      calculation - 集計の計算方法
      baseField - 集計対象のフィールド名称
      nextItem - true: 次のアイテム false:前のアイテム

    • setNumberFormat

      public void setNumberFormat(String numberFormat)
      集計フィールドに適用する書式を設定します。フィールドがデータフィールドである場合のみ有効です。
      パラメータ:
      numberFormat - 適用する書式

    • setShowEmtpyItems

      public void setShowEmtpyItems(boolean apply)
      空アイテムを表示するかどうかを設定します。行/列フィールドの場合有効です。
      パラメータ:
      apply - true:表示する false:表示しない

    • setRepeatLabels

      public void setRepeatLabels(boolean apply)
      ラベルの繰り返しをするかどうかを設定します。行/列フィールドの場合有効です。
      パラメータ:
      apply - true:ラベルを繰り返す false:ラベルを繰り返さない

    • setInsertBlankRow

      public void setInsertBlankRow(boolean apply)
      空行をデータの後ろ(集計データの前)に挿入するかどうかを設定します。
      パラメータ:
      apply - true:空行を挿入する false:空行を挿入しない

    • setIncludeNewItemsInFilter

      public void setIncludeNewItemsInFilter(boolean apply)
      フィルターに、追加されたアイテムを表示するかどうかを設定します。ページアイテムの場合のみ、有効です。
      パラメータ:
      apply - true:追加されたアイテムを表示する false:追加されたアイテムを表示しない