org.pslx.PpsDocuments
クラス DocumentManager

java.lang.Object
  上位を拡張 org.pslx.PpsDocuments.DocumentManager

public final class DocumentManager
extends java.lang.Object

PSLX対応のXMLの作成やXMLの読み込み、書き出しを行うクラスです。

メッセージの処理の単位であるTransactionProcessクラスのインスタンスを生成します。

バージョン:
1.6.004

コンストラクタの概要
DocumentManager()
          DocumentManagerを生成します。
 
メソッドの概要
 void close()
          ドキュメントマネージャの利用を終了し、 カウンタ値を保存します。
 TransactionMessage createMessage()
          トランザクションメッセージを生成します。
 TransactionProcess createProcess()
          トランザクション処理を生成します
 TransactionProcess createProcess(java.lang.String transactionId)
          トランザクション処理を生成します
 TransactionProcess createProcess(TransactionMessage message)
          受信メッセージに対応する返信用のトランザクション処理を生成します
 TransactionMessage createProfileMessage(Document.ActionTypes actionType)
          定義された情報に従って実装プロファイルを生成します
 java.lang.String getApplicationName()
          送信者のアプリケーション名称を取得します
static java.lang.String getDateString(java.util.Calendar value)
          このメソッドは、コンポーネント内部で使用します。
static java.lang.String getDateString(java.lang.Object value)
          このメソッドは、コンポーネント内部で使用します。
static java.util.GregorianCalendar getDateValue(java.lang.Object value)
          このメソッドは、コンポーネント内部で使用します。
static java.util.GregorianCalendar getDateValue(java.lang.String value)
          このメソッドは、コンポーネント内部で使用します。
 int getDocumentIdCounter()
          生成ドキュメントのカウンタを取得します
 java.lang.String getDocumentIdFormat()
          ドキュメントIDの書式文字列を取得します
 ImplementProfile getImplement()
          実装プロファイルを取得します(定義用)
 int getMessageIdCounter()
          生成メッセージのカウンタを取得します
 java.lang.String getMessageIdFormat()
          メッセージIDの書式文字列を取得します
 java.lang.String getNsAll()
          PPSスキーマの名前空間名を取得します
 java.lang.String getPrefixAll()
          PPSスキーマの接頭辞を取得します
 ProfileDefinition getProfile()
          業務プロファイルを取得します
 DomainObjectProfile getProfileObject(java.lang.String documentName)
          指定名の業務ドキュメントがもつ業務オブジェクトのプロファイルを得る
 java.lang.String getSenderName()
          自身のアプリケーションを表す送信者IDを取得します。
 int getTransactionIdCounter()
          生成トランザクションのカウンタを取得します
 java.lang.String getTransactionIdFormat()
          トランザクションIDの書式文字列を取得します
 java.io.PrintStream getWarningOutputStream()
          ドキュメントを解析中に見つかった警告を出力するPrintStreamを取得します
 javax.xml.xpath.XPath getXPath()
          使用しないでください
 void initialize()
          DocumentManagerを初期化します。
 void initialize(java.util.Properties properties)
          DocumentManagerを初期化します。
 void initialize(javax.xml.validation.Schema ppsSchema, java.io.InputStream is)
          DocumentManagerを初期化します。
 void initialize(javax.xml.validation.Schema ppsSchema, java.io.InputStream is, java.util.Properties properties)
          DocumentManagerを初期化します。
 TransactionMessage parse(java.lang.String xml)
          XML文字列からトランザクションメッセージを読み込みます
 ImplementProfile parseImplementProfile(java.lang.String xml)
          XML文字列から実装プロパティを読み込みます
 TransactionMessage read(java.io.InputStream stream)
          指定したストリームからトランザクションメッセージを読み込みます
 TransactionMessage read(java.lang.String path)
          指定したパスまたはURIからトランザクションメッセージを読み込みます
 TransactionMessage read(javax.xml.stream.XMLStreamReader reader)
          指定したストリームからトランザクションメッセージを読み込みます
 ImplementProfile readImplementProfile(java.io.InputStream stream)
          指定したストリームから実装プロパティを読み込みます
 ImplementProfile readImplementProfile(java.lang.String filename)
          指定したファイルから実装プロパティを読み込みます
 ImplementProfile readImplementProfile(javax.xml.stream.XMLStreamReader reader)
          指定したストリームから実装プロパティを読み込みます
 TransactionProcess resumeProcess(java.lang.String transactionId)
          トランザクション処理を再度生成します
 void setApplicationName(java.lang.String value)
          送信者のアプリケーション名称を設定します
 void setDocumentIdCounter(int value)
          生成ドキュメントのカウンタを設定します
 void setDocumentIdFormat(java.lang.String value)
          ドキュメントIDの書式文字列を設定します。
 void setMessageIdCounter(int value)
          生成メッセージのカウンタを設定します
 void setMessageIdFormat(java.lang.String value)
          メッセージIDの書式文字列を設定します
 void setSenderName(java.lang.String value)
          自身のアプリケーションを表す送信者IDを設定します。
 void setTransactionFormat(java.lang.String value)
          トランザクションIDの書式文字列を設定します
 void setTransactionIdCounter(int value)
          生成トランザクションのカウンタを設定します
 void setTransactionListener(TransactionEventListener listener)
          トランザクションの開始、確定および中断が行われることを通知するイベントリスナを設定します
 void setWarningOutputStream(java.io.PrintStream stream)
          ドキュメントを解析中に見つかった警告を出力するPrintStreamを設定します
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

DocumentManager

public DocumentManager()
DocumentManagerを生成します。
DocumentManagerを使ってメッセージの読み込みおよび書き込みを行うには、

メソッドの詳細

getXPath

public javax.xml.xpath.XPath getXPath()
使用しないでください


getNsAll

public java.lang.String getNsAll()
PPSスキーマの名前空間名を取得します


getPrefixAll

public java.lang.String getPrefixAll()
PPSスキーマの接頭辞を取得します


getApplicationName

public java.lang.String getApplicationName()
送信者のアプリケーション名称を取得します

戻り値:
送信者のアプリケーション名称

setApplicationName

public void setApplicationName(java.lang.String value)
送信者のアプリケーション名称を設定します

パラメータ:
value - 送信者のアプリケーション名称

getSenderName

public java.lang.String getSenderName()

自身のアプリケーションを表す送信者IDを取得します。

送信者IDは、送信相手に認識させるための固有の文字列です。


setSenderName

public void setSenderName(java.lang.String value)

自身のアプリケーションを表す送信者IDを設定します。

送信者IDは、送信相手に認識させるための固有の文字列です。

パラメータ:
value - 送信者名

getDocumentIdCounter

public int getDocumentIdCounter()
生成ドキュメントのカウンタを取得します


setDocumentIdCounter

public void setDocumentIdCounter(int value)
生成ドキュメントのカウンタを設定します

パラメータ:
value - 生成ドキュメントのカウンタ

getDocumentIdFormat

public java.lang.String getDocumentIdFormat()
ドキュメントIDの書式文字列を取得します


setDocumentIdFormat

public void setDocumentIdFormat(java.lang.String value)

ドキュメントIDの書式文字列を設定します。業務ドキュメントを生成する際に、ここで指定した書式に従ってドキュメントIDが発番されます。

フォーマットに指定する文字列は、Java標準のjava.util.Formatterクラスの書式文字列の構文に従って指定してください。

パラメータ:
value - ドキュメントIDの書式文字列

getTransactionIdCounter

public int getTransactionIdCounter()
生成トランザクションのカウンタを取得します


setTransactionIdCounter

public void setTransactionIdCounter(int value)
生成トランザクションのカウンタを設定します

パラメータ:
value - トランザクションのカウンタ

getTransactionIdFormat

public java.lang.String getTransactionIdFormat()
トランザクションIDの書式文字列を取得します


setTransactionFormat

public void setTransactionFormat(java.lang.String value)
トランザクションIDの書式文字列を設定します

パラメータ:
value - トランザクションIDの書式文字列

getMessageIdCounter

public int getMessageIdCounter()
生成メッセージのカウンタを取得します


setMessageIdCounter

public void setMessageIdCounter(int value)
生成メッセージのカウンタを設定します

パラメータ:
value - 生成メッセージのカウンタ

getMessageIdFormat

public java.lang.String getMessageIdFormat()
メッセージIDの書式文字列を取得します


setMessageIdFormat

public void setMessageIdFormat(java.lang.String value)
メッセージIDの書式文字列を設定します

パラメータ:
value - メッセージIDの書式文字列

setTransactionListener

public void setTransactionListener(TransactionEventListener listener)
トランザクションの開始、確定および中断が行われることを通知するイベントリスナを設定します

パラメータ:
listener - TransactionEventListener

setWarningOutputStream

public void setWarningOutputStream(java.io.PrintStream stream)
ドキュメントを解析中に見つかった警告を出力するPrintStreamを設定します

パラメータ:
stream - 警告を出力するPrintStream

getWarningOutputStream

public java.io.PrintStream getWarningOutputStream()
ドキュメントを解析中に見つかった警告を出力するPrintStreamを取得します


getProfile

public ProfileDefinition getProfile()
業務プロファイルを取得します

戻り値:
Profile

getImplement

public ImplementProfile getImplement()
実装プロファイルを取得します(定義用)


initialize

public void initialize()
                throws java.io.FileNotFoundException,
                       org.xml.sax.SAXException,
                       java.net.MalformedURLException
DocumentManagerを初期化します。
クラスパスにあるpps.schema-1.0.xsdおよびprofile-pslx.xmlを読み込み、初期化します。

例外:
java.io.FileNotFoundException
org.xml.sax.SAXException
java.net.MalformedURLException

initialize

public void initialize(java.util.Properties properties)
                throws java.io.FileNotFoundException,
                       org.xml.sax.SAXException,
                       java.net.MalformedURLException
DocumentManagerを初期化します。
指定したパスまたはURIにあるpps.schema-1.0.xsdおよびprofile-pslx.xmlを読み込み、初期化します。

パラメータ:
properties - 設定値
例外:
java.io.FileNotFoundException
org.xml.sax.SAXException
java.net.MalformedURLException

initialize

public void initialize(javax.xml.validation.Schema ppsSchema,
                       java.io.InputStream is)
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       PpsProfileException,
                       java.text.ParseException,
                       javax.xml.transform.TransformerException,
                       javax.xml.parsers.ParserConfigurationException
DocumentManagerを初期化します。
このメソッドでは、指定したスキーマおよびプロファイルを読み込み、初期化します。

パラメータ:
ppsSchema - スキーマ
is - プロファイル
例外:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.text.ParseException
PpsProfileException
java.io.IOException

initialize

public void initialize(javax.xml.validation.Schema ppsSchema,
                       java.io.InputStream is,
                       java.util.Properties properties)
                throws org.xml.sax.SAXException,
                       java.io.IOException,
                       PpsProfileException,
                       java.text.ParseException,
                       javax.xml.transform.TransformerException,
                       javax.xml.parsers.ParserConfigurationException
DocumentManagerを初期化します。
このメソッドでは、指定したスキーマおよびプロファイルを読み込み、初期化します。

パラメータ:
ppsSchema - スキーマ
is - プロファイル
properties - 設定値
例外:
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
javax.xml.transform.TransformerException
java.text.ParseException
PpsProfileException
java.io.IOException

createProfileMessage

public TransactionMessage createProfileMessage(Document.ActionTypes actionType)
定義された情報に従って実装プロファイルを生成します

パラメータ:
actionType - メッセージの種類
戻り値:
TransactionMessage

resumeProcess

public TransactionProcess resumeProcess(java.lang.String transactionId)
トランザクション処理を再度生成します

戻り値:
トランザクション処理オブジェクト

createProcess

public TransactionProcess createProcess()
トランザクション処理を生成します

戻り値:
トランザクション処理オブジェクト

createProcess

public TransactionProcess createProcess(java.lang.String transactionId)
トランザクション処理を生成します

戻り値:
トランザクション処理オブジェクト

createProcess

public TransactionProcess createProcess(TransactionMessage message)
                                 throws PpsDocumentsException
受信メッセージに対応する返信用のトランザクション処理を生成します

パラメータ:
message - 受信メッセージ
戻り値:
トランザクション処理オブジェクト。失敗の場合はnull
例外:
PpsDocumentsException

createMessage

public TransactionMessage createMessage()
トランザクションメッセージを生成します。 ここで生成されるメッセージは、トランザクション処理に依存しません

戻り値:
トランザクションメッセージ

close

public void close()
ドキュメントマネージャの利用を終了し、 カウンタ値を保存します。


read

public TransactionMessage read(java.lang.String path)
                        throws javax.xml.stream.XMLStreamException,
                               java.text.ParseException,
                               PpsDocumentsException,
                               java.net.MalformedURLException,
                               java.io.IOException
指定したパスまたはURIからトランザクションメッセージを読み込みます

パラメータ:
path - 読み込むXMLファイルを示すパスまたはURI
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
PpsDocumentsException
java.text.ParseException
javax.xml.stream.XMLStreamException
java.io.IOException
java.net.MalformedURLException

parse

public TransactionMessage parse(java.lang.String xml)
                         throws javax.xml.stream.XMLStreamException,
                                java.text.ParseException,
                                PpsDocumentsException
XML文字列からトランザクションメッセージを読み込みます

パラメータ:
xml - 入力となるXML文字列
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.text.ParseException

read

public TransactionMessage read(java.io.InputStream stream)
                        throws javax.xml.stream.XMLStreamException,
                               java.text.ParseException,
                               PpsDocumentsException
指定したストリームからトランザクションメッセージを読み込みます

パラメータ:
stream - 入力となるInputStream
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.text.ParseException

read

public TransactionMessage read(javax.xml.stream.XMLStreamReader reader)
                        throws javax.xml.stream.XMLStreamException,
                               java.text.ParseException,
                               PpsDocumentsException
指定したストリームからトランザクションメッセージを読み込みます

パラメータ:
reader - 入力となるXMLStreamReader
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.text.ParseException

parseImplementProfile

public ImplementProfile parseImplementProfile(java.lang.String xml)
                                       throws javax.xml.stream.XMLStreamException,
                                              java.text.ParseException,
                                              PpsDocumentsException
XML文字列から実装プロパティを読み込みます

パラメータ:
xml - 入力となるXML文字列
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
javax.xml.stream.XMLStreamException
PpsDocumentsException
java.text.ParseException

readImplementProfile

public ImplementProfile readImplementProfile(javax.xml.stream.XMLStreamReader reader)
                                      throws javax.xml.stream.XMLStreamException,
                                             java.text.ParseException,
                                             PpsDocumentsException
指定したストリームから実装プロパティを読み込みます

パラメータ:
reader - 入力となるXMLStreamReader
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
PpsDocumentsException
java.text.ParseException
javax.xml.stream.XMLStreamException

readImplementProfile

public ImplementProfile readImplementProfile(java.io.InputStream stream)
                                      throws javax.xml.stream.XMLStreamException,
                                             java.text.ParseException,
                                             PpsDocumentsException
指定したストリームから実装プロパティを読み込みます

パラメータ:
stream - 入力となるInputStream
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
PpsDocumentsException
java.text.ParseException
javax.xml.stream.XMLStreamException

readImplementProfile

public ImplementProfile readImplementProfile(java.lang.String filename)
                                      throws javax.xml.stream.XMLStreamException,
                                             java.text.ParseException,
                                             PpsDocumentsException,
                                             java.net.MalformedURLException,
                                             java.io.IOException
指定したファイルから実装プロパティを読み込みます

パラメータ:
filename - 入力となるファイル名
戻り値:
読み込まれた内容を含むTransactionMessage
例外:
PpsDocumentsException
java.text.ParseException
javax.xml.stream.XMLStreamException
java.io.IOException
java.net.MalformedURLException

getProfileObject

public DomainObjectProfile getProfileObject(java.lang.String documentName)
指定名の業務ドキュメントがもつ業務オブジェクトのプロファイルを得る

パラメータ:
documentName - ドキュメント名
戻り値:
業務オブジェクトのプロファイル

getDateString

public static java.lang.String getDateString(java.lang.Object value)
このメソッドは、コンポーネント内部で使用します。
使用しないでください。


getDateString

public static java.lang.String getDateString(java.util.Calendar value)
このメソッドは、コンポーネント内部で使用します。
使用しないでください。


getDateValue

public static java.util.GregorianCalendar getDateValue(java.lang.Object value)
このメソッドは、コンポーネント内部で使用します。
使用しないでください。


getDateValue

public static java.util.GregorianCalendar getDateValue(java.lang.String value)
このメソッドは、コンポーネント内部で使用します。
使用しないでください。