com.j_phone.phonedata
インタフェース DataElement

既知のサブインタフェースの一覧:
AddressData, MailData

public interface DataElement

ネイティブシステムに保持される電話関連情報リストの1要素であるデータオブジェクトを扱うためのインタフェースです。

データオブジェクトの各項目は id 値を使用して値の取得、設定を行います。 id 値はサブインタフェースに定義されています。

導入されたバージョン:
JSCL 1.2

フィールドの概要
static int BOOLEAN
          Boolean 型のデータ種別を表します。
static int DATE
          Date 型のデータ種別を表します。
static int INT
          int 型のデータ種別を表します。
static int STRING
          String 型のデータ種別を表します。
 
メソッドの概要
 DataElement createClone()
          インスタンスのコピーを生成します。
 java.lang.Boolean getBoolean(int id, int index)
          指定された id、index に対応する項目から Boolean 型データを取得します。
 int getDataType(int id)
          指定された id に対応する項目のデータ種別を取得します。
 java.util.Date getDate(int id, int index)
          指定された id、index に対応する項目から Date 型データを取得します。
 int getElementCount(int id)
          指定された id に対応する項目として設定されているデータの数を取得します。
 java.lang.Integer getInt(int id, int index)
          指定された id、index に対応する項目から Int 型データを取得します。
 java.lang.String getString(int id, int index)
          指定された id、index に対応する項目から String 型データを取得します。
 java.lang.String getType()
          このインスタンスが操作するデータの種別を取得します。
 boolean isListElement()
          このインスタンスが機器のネイティブ機能により生成されたデータかどうかを取得します。
 void setBoolean(int id, int index, java.lang.Boolean value)
          指定された id、index に対応する項目に Boolean 型データを設定します。
 void setInt(int id, int index, java.lang.Integer value)
          指定された id、index に対応する項目に Int 型データを設定します。
 void setString(int id, int index, java.lang.String value)
          指定された id、index に対応する項目に String 型データを設定します。
 

フィールドの詳細

STRING

public static final int STRING
String 型のデータ種別を表します。

INT

public static final int INT
int 型のデータ種別を表します。

DATE

public static final int DATE
Date 型のデータ種別を表します。

BOOLEAN

public static final int BOOLEAN
Boolean 型のデータ種別を表します。
メソッドの詳細

getType

public java.lang.String getType()
このインスタンスが操作するデータの種別を取得します。
戻り値:
データの種別

getElementCount

public int getElementCount(int id)
                    throws java.io.IOException
指定された id に対応する項目として設定されているデータの数を取得します。 存在しない id が指定された場合 0 を返します。
パラメータ:
id - 取得する項目の id 値
戻り値:
設定されているデータ数
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getDataType

public int getDataType(int id)
指定された id に対応する項目のデータ種別を取得します。 存在しない id が指定された場合 0 を返します。
パラメータ:
id - 取得する項目の id 値
戻り値:
データ種別

getString

public java.lang.String getString(int id,
                                  int index)
                           throws java.io.IOException
指定された id、index に対応する項目から String 型データを取得します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 存在しない id、index の組み合わせが指定された場合 null を返します。
パラメータ:
id - 取得する項目の id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号
戻り値:
取得した String データ
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getInt

public java.lang.Integer getInt(int id,
                                int index)
                         throws java.io.IOException
指定された id、index に対応する項目から Int 型データを取得します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 存在しない id、index の組み合わせが指定された場合 null を返します。
パラメータ:
id - 取得する項目の id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号
戻り値:
取得した Int データ
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getDate

public java.util.Date getDate(int id,
                              int index)
                       throws java.io.IOException
指定された id、index に対応する項目から Date 型データを取得します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 存在しない id、index の組み合わせが指定された場合 null が返ります。
パラメータ:
id - 取得する項目の id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号
戻り値:
取得したデータ
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getBoolean

public java.lang.Boolean getBoolean(int id,
                                    int index)
                             throws java.io.IOException
指定された id、index に対応する項目から Boolean 型データを取得します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 存在しない id、index の組み合わせが指定された場合 null が返ります。
パラメータ:
id - 取得するデータの id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号
戻り値:
取得したデータ
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

setString

public void setString(int id,
                      int index,
                      java.lang.String value)
               throws java.io.IOException
指定された id、index に対応する項目に String 型データを設定します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 データとして null が指定された場合、そのデータは削除されます。
パラメータ:
id - 設定する項目の id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号。 データが存在する番号が指定された場合はデータを上書きし、 -1 が指定された場合は新規に追加(空きフィールドに設定)する。
value - 設定するデータ
例外:
java.lang.IllegalArgumentException - 引数が不正な場合に発生する
java.io.IOException - 設定ができない場合に発生する

setInt

public void setInt(int id,
                   int index,
                   java.lang.Integer value)
            throws java.io.IOException
指定された id、index に対応する項目に Int 型データを設定します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。 データとして null が指定された場合、そのデータは削除されます。
パラメータ:
id - 設定する項目の id 値
index - 指定された id の項目がデータを複数持つ場合の識別番号。 データが存在する番号が指定された場合はデータを上書きし、 -1 が指定された場合は新規に追加(空きフィールドに設定)する。
value - 設定するデータ
例外:
java.lang.IllegalArgumentException - 引数が不正な場合に発生する
java.io.IOException - 設定ができない場合に発生する

setBoolean

public void setBoolean(int id,
                       int index,
                       java.lang.Boolean value)
                throws java.io.IOException
指定された id、index に対応する項目に Boolean 型データを設定します。 データを複数持つ場合の識別番号は 0 から始まります。データを複数持たない場合は 0 固定です。
パラメータ:
id - 設定するデータの id 値
index - 設定された id の項目がデータを複数持つ場合の識別番号。 データが存在する番号が指定された場合はデータを上書きする。
value - 設定するデータ
例外:
java.lang.IllegalArgumentException - 引数が不正な場合に発生する
java.io.IOException - 設定ができない場合に発生する

isListElement

public boolean isListElement()
このインスタンスが機器のネイティブ機能により生成されたデータかどうかを取得します。 機器のネイティブ機能により生成されたデータか、 Java アプリケーションによって新規生成されたデータかの判断に利用します。
戻り値:
true:ネイティブ機能により生成されたデータ

createClone

public DataElement createClone()
                        throws java.io.IOException
インスタンスのコピーを生成します。

データ内容が同じインスタンスを生成する場合、 新しく生成したインスタンスに「=」演算子によって代入しても同一インスタンスへの参照として扱われます。 このメソッドを使用してコピーを生成してください。

戻り値:
同じ内容の新しい DataElement
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する