AbstractFormat (VisualFrame JavaDoc)

java.lang.Object
- jp.ne.mki.wedge.data.format.AbstractFormat

すべての実装されたインタフェース:

jp.ne.mki.wedge.run.interfaces.DataFormatInterface

直系の既知のサブクラス:

WedgeDateFormat, WedgeDateFormat6, WedgeDecimalFormat
```
public abstract class AbstractFormat
extends java.lang.Object
implements jp.ne.mki.wedge.run.interfaces.DataFormatInterface
```
フォーマット抽象クラス

フォーマットクラスを作成する場合にはこのクラスを継承してください。
クラスを生成するには以下のメソッドを実装する必要があります。
1. フォーマットのパターンを設定します
  　public void applyPattern(String pattern);
2. フォーマットのパターンをかえします
  　public String toPattern();
3. 内部データより表示文字列を生成します(format)
  　public String valueToString(Object value) throws ParseException;
4. 表示文字列より内部データを生成します
  public Object stringToValue(String value) throws ParseException;
DMCにて設定されたデータ情報は以下のメソッドにて取得が可能です。
public String getId()
public String getLogicalName()
public String getPhysicalName()
public int getItemType()
public int getDataType()
public String getDefault()
public String[] getEnum()
public int getLength()
public int getScale()

public String getMaximum()
public String getMinimum()
public boolean isOmit()
public boolean isFix()
バージョン:

1.0

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

AbstractFormat()

コンストラクタ
コンストラクタと説明
`AbstractFormat()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`java.lang.String`	`format(java.lang.Object value)` 非推奨です。 replaced by `valueToString(Object)`
`jp.ne.mki.wedge.run.interfaces.DataInterface`	`getData()` DataInterfaceの参照を返します
`int`	`getDataType()` データのデータタイプを返します
`java.lang.String`	`getDefault()` データの初期値を返します
`java.lang.String[]`	`getEnum()` データのENUM(選択肢)を返します
`java.lang.String`	`getId()` データのIDを返します
`int`	`getItemType()` データのアイテムタイプを返します
`int`	`getLength()` データの長さを返します
`java.lang.String`	`getLogicalName()` データの論理名称を返します
`java.lang.String`	`getMaximum()` データの最大値を返します
`java.lang.String`	`getMinimum()` データの最小値を返します
`java.lang.String`	`getPhysicalName()` データの物理名称を返します
`int`	`getScale()` データの小数点以下桁数を返します
`java.lang.String`	`getStringValue(java.lang.Object object)` String文字列を取得する Objectの種類により文字列を任意に変えたい場合にはこのメソッドのみ上書きして使用してください。
`boolean`	`isFix()` データの固定長情報を返します
`boolean`	`isOmit()` データの省略不可情報を返します
`void`	`setData(jp.ne.mki.wedge.run.interfaces.DataInterface data)` DataInterfaceの参照を設定
`void`	`setDataType(int value)` データタイプを設定
`void`	`setDefault(java.lang.String value)` デフォルト値を設定
`void`	`setEnum(java.lang.String[] value)` Enumの値を設定
`void`	`setFix(boolean value)` 固定長かどうか
`void`	`setId(java.lang.String value)` IDを設定
`void`	`setItemType(int value)` アイテムタイプを設定
`void`	`setLength(int value)` 長さを設定
`void`	`setLogicalName(java.lang.String value)` 論理名称を設定
`void`	`setMaximum(java.lang.String value)` 最大値を設定
`void`	`setMinimum(java.lang.String value)` 最小値を設定
`void`	`setOmit(boolean value)` 省略可能かどうか
`void`	`setPhysicalName(java.lang.String value)` 物理名称を設定
`void`	`setScale(int value)` 小数点桁数以下の長さを設定
`java.lang.Object`	`stringToValue(java.lang.String value)` 表示データから内部データに変換 GUI上ににて入力された文字列を内部データに変換します。
`java.lang.String`	`unFormat(java.lang.Object value)` 非推奨です。 replaced by `stringToValue(String)`
`java.lang.String`	`valueToString(java.lang.Object value)` 内部データから表示データに変換 GUI上に表示する文字列を生成します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド jp.ne.mki.wedge.run.interfaces.DataFormatInterface
applyPattern, toPattern

- コンストラクタの詳細
  - AbstractFormat
```
public AbstractFormat()
```
- メソッドの詳細
  - getStringValue
```
public java.lang.String getStringValue(java.lang.Object object)
```
    String文字列を取得する Objectの種類により文字列を任意に変えたい場合にはこのメソッドのみ上書きして使用してください。
    
    パラメータ:
    
    object -
    
    戻り値:
  - format
```
public java.lang.String format(java.lang.Object value)
                        throws java.lang.Throwable
```
    非推奨です。 replaced by valueToString(Object)
    
    フォーマットされた値を取得する Ver1.1.3よりこのメソッドは valueToString(Object) に置き換えられました。 valueToString(Object) のメソッドを上書きして実装をするようにして下さい。
    
    パラメータ:
    
    value -
    
    戻り値:
    
    例外:
    
    java.lang.Throwable
  - valueToString
```
public java.lang.String valueToString(java.lang.Object value)
                               throws java.text.ParseException
```
    内部データから表示データに変換 GUI上に表示する文字列を生成します。このメソッドを上書きして処理のコードを記述してください。このメソッドの修正により、内部保持データを変えることなく表示形式を変更することが可能です。例えば、アイテム内部には Date型オブジェクトを格納しておき、表示時には yyyy/MM/dd の形式にて表示などが可能です。入力可能GUI部品にて使用する場合には stringToValue(String) メソッドとの連携が必要です。
    
    定義:
    
    valueToString インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - アイテム内部のデータオブジェクト
    
    String - GUI上に表示する文字列
    
    戻り値:
    
    String テキスト上の文字列
    
    例外:
    
    java.text.ParseException - 文字列解析失敗時に発生します
    
    導入されたバージョン:
    
    Ver1.1.3
  - unFormat
```
public java.lang.String unFormat(java.lang.Object value)
                          throws java.lang.Throwable
```
    非推奨です。 replaced by stringToValue(String)
    
    アンフォーマットされた値を取得する Ver1.1.3よりこのメソッドは stringToValue(String) に置き換えられました。 stringToValue(String) のメソッドを上書きして実装をするようにして下さい。
    
    パラメータ:
    
    value -
    
    戻り値:
    
    例外:
    
    java.lang.Throwable
  - stringToValue
```
public java.lang.Object stringToValue(java.lang.String value)
                               throws java.text.ParseException
```
    表示データから内部データに変換 GUI上ににて入力された文字列を内部データに変換します。このメソッドを上書きして処理のコードを記述してください。このメソッドの修正により、入力された文字列とは違う形式(型)を内部データオブジェクトとして保持することが可能です。例えば、入力にて yyyy/MM/dd の形式にて入力された場合、その文字を解析して Date型オブジェクトを作成して保持するなどが可能です。入力可能GUI部品にて使用する場合には stringToValue(String) メソッドとの連携が必要です。
    
    定義:
    
    stringToValue インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - GUI上にて入力された文字列
    
    Object - 保持する内部データ
    
    戻り値:
    
    Object 内部データに格納するObject
    
    例外:
    
    java.text.ParseException - 文字列解析失敗時に発生します
    
    導入されたバージョン:
    
    Ver1.1.3
  - setId
```
public void setId(java.lang.String value)
```
    IDを設定
    
    定義:
    
    setId インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - ID
  - setPhysicalName
```
public void setPhysicalName(java.lang.String value)
```
    物理名称を設定
    
    定義:
    
    setPhysicalName インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 物理名称
  - setLogicalName
```
public void setLogicalName(java.lang.String value)
```
    論理名称を設定
    
    定義:
    
    setLogicalName インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 論理名称
  - setItemType
```
public void setItemType(int value)
```
    アイテムタイプを設定
    
    定義:
    
    setItemType インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - アイテムタイプ
    
    関連項目:
    
    DataInterface
  - setDataType
```
public void setDataType(int value)
```
    データタイプを設定
    
    定義:
    
    setDataType インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - データタイプ
    
    関連項目:
    
    DataInterface
  - setDefault
```
public void setDefault(java.lang.String value)
```
    デフォルト値を設定
    
    定義:
    
    setDefault インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - デフォルト値
  - setEnum
```
public void setEnum(java.lang.String[] value)
```
    Enumの値を設定
    
    定義:
    
    setEnum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - Enum
  - setLength
```
public void setLength(int value)
```
    長さを設定
    
    定義:
    
    setLength インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 長さ
  - setScale
```
public void setScale(int value)
```
    小数点桁数以下の長さを設定
    
    定義:
    
    setScale インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 長さ
  - setMaximum
```
public void setMaximum(java.lang.String value)
```
    最大値を設定
    
    定義:
    
    setMaximum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 最大値
  - setMinimum
```
public void setMinimum(java.lang.String value)
```
    最小値を設定
    
    定義:
    
    setMinimum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 最小値
  - setOmit
```
public void setOmit(boolean value)
```
    省略可能かどうか
    
    定義:
    
    setOmit インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 省略可能か
  - setFix
```
public void setFix(boolean value)
```
    固定長かどうか
    
    定義:
    
    setFix インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    value - 固定長
  - setData
```
public void setData(jp.ne.mki.wedge.run.interfaces.DataInterface data)
```
    DataInterfaceの参照を設定
    
    定義:
    
    setData インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    パラメータ:
    
    data - DataInterfaceの参照
    
    導入されたバージョン:
    
    ver1.2.0
  - getId
```
public java.lang.String getId()
```
    データのIDを返します
    
    定義:
    
    getId インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String データID
  - getLogicalName
```
public java.lang.String getLogicalName()
```
    データの論理名称を返します
    
    定義:
    
    getLogicalName インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String データ論理名称
  - getPhysicalName
```
public java.lang.String getPhysicalName()
```
    データの物理名称を返します
    
    定義:
    
    getPhysicalName インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String データ物理名称
  - getItemType
```
public int getItemType()
```
    データのアイテムタイプを返します
    
    定義:
    
    getItemType インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    int データアイテムタイプ
  - getDataType
```
public int getDataType()
```
    データのデータタイプを返します
    
    定義:
    
    getDataType インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    int データタイプ
  - getDefault
```
public java.lang.String getDefault()
```
    データの初期値を返します
    
    定義:
    
    getDefault インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String 初期値
  - getEnum
```
public java.lang.String[] getEnum()
```
    データのENUM(選択肢)を返します
    
    定義:
    
    getEnum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String[] 初期値
  - getLength
```
public int getLength()
```
    データの長さを返します
    
    定義:
    
    getLength インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    int データの長さ
  - getScale
```
public int getScale()
```
    データの小数点以下桁数を返します
    
    定義:
    
    getScale インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    int データの小数点以下桁数
  - getMaximum
```
public java.lang.String getMaximum()
```
    データの最大値を返します
    
    定義:
    
    getMaximum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String データの最大値
  - getMinimum
```
public java.lang.String getMinimum()
```
    データの最小値を返します
    
    定義:
    
    getMinimum インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    String データの最小値
  - isOmit
```
public boolean isOmit()
```
    データの省略不可情報を返します
    
    定義:
    
    isOmit インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    boolean データの省略不可情報
  - isFix
```
public boolean isFix()
```
    データの固定長情報を返します
    
    定義:
    
    isFix インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    boolean データの固定長情報
  - getData
```
public jp.ne.mki.wedge.run.interfaces.DataInterface getData()
```
    DataInterfaceの参照を返します
    
    定義:
    
    getData インタフェース内 jp.ne.mki.wedge.run.interfaces.DataFormatInterface
    
    戻り値:
    
    DataInterface データオブジェクト
    
    導入されたバージョン:
    
    ver1.2.0

クラス AbstractFormat

フォーマット抽象クラス

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド jp.ne.mki.wedge.run.interfaces.DataFormatInterface

コンストラクタの詳細

AbstractFormat

メソッドの詳細

getStringValue

format

valueToString

unFormat

stringToValue

setId

setPhysicalName

setLogicalName

setItemType

setDataType

setDefault

setEnum

setLength

setScale

setMaximum

setMinimum

setOmit

setFix

setData

getId

getLogicalName

getPhysicalName

getItemType

getDataType

getDefault

getEnum

getLength

getScale

getMaximum

getMinimum

isOmit

isFix

getData