jp.go.aist.dmrc.platform.beans.util.converter
クラス PFBarCodeConverter

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.util.converter.PFBarCodeConverter
すべての実装インタフェース:
PFComponent, PFDataCreateEventSource, PFEventSource, PFXMLSerializable, java.io.Serializable

public class PFBarCodeConverter
extends java.lang.Object
implements PFComponent, PFDataCreateEventSource, PFXMLSerializable

バーコード変換コンポーネント。 このコンポーネントから以下のイベントが発生します。

関連項目:
直列化された形式

コンストラクタの概要
PFBarCodeConverter()
          バーコード帳票要素を生成する。
 
メソッドの概要
 void addPFDataCreateListener(PFDataCreateListener lis)
          引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。
 java.awt.Image convertBarCodeImage(java.lang.String string)
          文字列をバーコードイメージに変換する。
 java.awt.Image convertBarCodeImage(java.lang.String string, boolean displayString, boolean checkDigit)
          文字列をバーコードイメージに変換する。
 PFBarCodeType getCodeType()
          コードタイプを取得する。
 PFBarCodeType getCodeType(java.lang.String codeTypeName)
          コード体系を取得する。
 PFObjectList getCodeTypeList()
          コード体系の一覧を取得する。
 java.lang.String getCodeTypeName()
          コードタイプ名を取得する。
 PFObjectList getCodeTypeNameList()
          コード体系名の一覧を取得する。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 java.util.Iterator getPFDataCreateListenerList()
          データ生成イベントリスナ配列を取得する。
 boolean isAddCheckDigit()
          チェックディジット付加フラグを取得する。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isDisplayString()
          文字列の出力有無フラグを取得する。
 void localeUpdated()
          ロケール変更に対応する。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 void removePFDataCreateListener(PFDataCreateListener lis)
          引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。
 void setAddCheckDigit(boolean flag)
          チェックディジット付加フラグを設定する。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 void setCodeType(PFBarCodeType codeType)
          コードタイプを設定する。
 void setCodeTypeName(java.lang.String codeTypeName)
          コードタイプ名を設定する。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setDisplayString(boolean flag)
          文字列の出力有無フラグを設定する。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFBarCodeConverter

public PFBarCodeConverter()
バーコード帳票要素を生成する。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()
ロケール変更に対応する。

定義:
インタフェース PFComponent 内の localeUpdated

getPFDataCreateListenerList

public java.util.Iterator getPFDataCreateListenerList()
データ生成イベントリスナ配列を取得する。

定義:
インタフェース PFDataCreateEventSource 内の getPFDataCreateListenerList
戻り値:
イベントリスナイテレータ

addPFDataCreateListener

public void addPFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを登録し、 データ生成イベント発生時に処理を行う対象とする。

定義:
インタフェース PFDataCreateEventSource 内の addPFDataCreateListener
パラメータ:
lis - 追加対象イベントリスナ

removePFDataCreateListener

public void removePFDataCreateListener(PFDataCreateListener lis)
引数で与えられたイベントリスナを削除し、 データ生成イベント発生時に処理を行う対象から外す。

定義:
インタフェース PFDataCreateEventSource 内の removePFDataCreateListener
パラメータ:
lis - 削除対象イベントリスナ

setCodeType

public void setCodeType(PFBarCodeType codeType)
コードタイプを設定する。

パラメータ:
codeType - コード体系

getCodeType

public PFBarCodeType getCodeType()
コードタイプを取得する。

戻り値:
コード体系

setCodeTypeName

public void setCodeTypeName(java.lang.String codeTypeName)
コードタイプ名を設定する。

パラメータ:
codeTypeName - コード体系名

getCodeTypeName

public java.lang.String getCodeTypeName()
コードタイプ名を取得する。

戻り値:
コード体系名

isDisplayString

public boolean isDisplayString()
文字列の出力有無フラグを取得する。

戻り値:
文字列の出力有無

setDisplayString

public void setDisplayString(boolean flag)
文字列の出力有無フラグを設定する。

パラメータ:
flag - 文字列の出力有無

isAddCheckDigit

public boolean isAddCheckDigit()
チェックディジット付加フラグを取得する。

戻り値:
チェックディジット付加

setAddCheckDigit

public void setAddCheckDigit(boolean flag)
チェックディジット付加フラグを設定する。

パラメータ:
flag - チェックディジット付加

convertBarCodeImage

public java.awt.Image convertBarCodeImage(java.lang.String string,
                                          boolean displayString,
                                          boolean checkDigit)
                                   throws PFException
文字列をバーコードイメージに変換する。

パラメータ:
string - 対象文字列
displayString - 文字列の出力有無
checkDigit - チェックディジット付加
戻り値:
イメージ
例外:
PFException

convertBarCodeImage

public java.awt.Image convertBarCodeImage(java.lang.String string)
                                   throws PFException
文字列をバーコードイメージに変換する。

パラメータ:
string - 対象文字列
戻り値:
イメージ
例外:
PFException

getCodeTypeList

public PFObjectList getCodeTypeList()
コード体系の一覧を取得する。

戻り値:
コード体系リスト(PFBarCodeTypeオブジェクトのリスト)

getCodeTypeNameList

public PFObjectList getCodeTypeNameList()
コード体系名の一覧を取得する。

戻り値:
コード体系名リスト(Stringのリスト)

getCodeType

public PFBarCodeType getCodeType(java.lang.String codeTypeName)
コード体系を取得する。

パラメータ:
codeTypeName - コード体系名
戻り値:
コード体系(PFBarCodeTypeオブジェクト)

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException