|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
public interface CTISession
ドキュメント変換処理を実行するためのサーバーとの接続です。
フィールドの概要 | |
---|---|
static byte |
ABORT_FORCE
強制的に中断する処理の定数です。 |
static byte |
ABORT_NORMAL
きりのよいところまで処理する中断処理の定数です。 |
メソッドの概要 | |
---|---|
void |
abort(byte mode)
変換を中断します。 |
void |
close()
セッションをクローズします。 |
InputStream |
getServerInfo(URI uri)
サーバー情報を返します。 |
void |
join()
setContinues(true) が設定された状態で、複数回のtranscodeにより生成された結果を結合して出力します。 |
void |
property(String name,
String value)
プロパティを設定します。 |
void |
reset()
送られたリソースと、プロパティ、メッセージハンドラ等の全ての設定をクリアして、セッションが作られた時点と同じ初期状態に戻します。 |
OutputStream |
resource(MetaSource metaSource)
リソースを送信するための出力ストリームを返します。 |
void |
resource(Source source)
リソースを送信します。 |
void |
setContinuous(boolean continuous)
複数の結果を結合するモードに切り替えます。 |
void |
setMessageHandler(MessageHandler messageHandler)
メッセージを受け取るためのオブジェクトを設定します。 |
void |
setProgressListener(ProgressListener progressListener)
進行状況を監視するためのオブジェクトを設定します。 |
void |
setResults(Results results)
出力先を設定します。 |
void |
setSourceResolver(SourceResolver resolver)
リソースを読み込むためのオブジェクトを設定します。 |
OutputStream |
transcode(MetaSource metaSource)
メインドキュメントを送信するための出力ストリームを返します。 |
void |
transcode(Source source)
メインドキュメントをデータソースから取得して変換します。 |
void |
transcode(URI uri)
指定されたアドレスへサーバー側からアクセスしてメインドキュメントを取得して変換します。 |
フィールドの詳細 |
---|
static final byte ABORT_NORMAL
static final byte ABORT_FORCE
メソッドの詳細 |
---|
InputStream getServerInfo(URI uri) throws IOException
uri
- サーバー情報を選択するためのURI。
IOException
void setResults(Results results) throws IOException
出力先を設定します。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
results
- 出力先。
IOException
void setMessageHandler(MessageHandler messageHandler) throws IOException
メッセージを受け取るためのオブジェクトを設定します。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
messageHandler
- メッセージハンドラ
IOException
MessageHandler
void setProgressListener(ProgressListener progressListener) throws IOException
進行状況を監視するためのオブジェクトを設定します。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
progressListener
- 進行状況リスナ
IOException
ProgressListener
void property(String name, String value) throws IOException
プロパティを設定します。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
name
- プロパティ名value
- 値
IOException
OutputStream resource(MetaSource metaSource) throws IOException
リソースを送信するための出力ストリームを返します。
リソースを送信した後、出力ストリームは必ずクローズしてください。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
metaSource
- リソースデータのメタ情報。
IOException
void resource(Source source) throws IOException
リソースを送信します。
このメソッドは各transcodeメソッドの前に呼ぶ必要があります。
source
- リソースのデータソース。
IOException
void setSourceResolver(SourceResolver resolver) throws IOException
リソースを読み込むためのオブジェクトを設定します。
resolver
- サーバー側から要求したリソースを取得するためのSourceResolver。
IOException
OutputStream transcode(MetaSource metaSource) throws IOException
メインドキュメントを送信するための出力ストリームを返します。
本体を送信した後、出力ストリームは必ずクローズしてください。
metaSource
- メインドキュメントのメタ情報。
IOException
void transcode(URI uri) throws IOException, TranscoderException
指定されたアドレスへサーバー側からアクセスしてメインドキュメントを取得して変換します。 resourceメソッドで事前に送信したリソースに対しても有効です。
uri
- メインドキュメントのURI。
IOException
TranscoderException
void transcode(Source source) throws IOException, TranscoderException
メインドキュメントをデータソースから取得して変換します。
source
- メインドキュメントのデータソース。
IOException
TranscoderException
void setContinuous(boolean continuous) throws IOException
複数の結果を結合するモードに切り替えます。
continuous
- trueであればjoinにより結果を結合するモードにします。
IOException
void join() throws IOException
setContinues(true) が設定された状態で、複数回のtranscodeにより生成された結果を結合して出力します。
IOException
void abort(byte mode) throws IOException
変換を中断します。 このメソッドは非同期的に(別スレッドから)呼び出す必要があります。 実際に処理が中断された場合は、変換処理を行なっている(transcodeを呼び出した )スレッドで、TranscoderExceptionがスローされます。
mode
- きりのよいところまで出力する場合はABORT_NORMAL、強制的に処理を停止するにはABORT_FORCEを指定します。
IOException
void reset() throws IOException
送られたリソースと、プロパティ、メッセージハンドラ等の全ての設定をクリアして、セッションが作られた時点と同じ初期状態に戻します。
IOException
void close() throws IOException
セッションをクローズします。
このメソッドを呼び出した後は、セッションに対して何も出来ません。
IOException
|
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |