|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
public interface JvLinkManager
JVLinkにアクセスするための基本的なAPIを提供します。
JvLinkWrapper層はJV-Link APIの純粋なラッパーであることに対し、
JvLinkManager層においては、JV-LinkをJavaで利用する開発者にとって使いやすく堅牢にするための実装が施される必要があります。
| メソッドの概要 | ||
|---|---|---|
void |
cancel()
open(org.stormcat.jvbeans.config.condition.StoredOpenConditionによって起動された、JVデータファイルのダウンロード・コピーを安全に中止します。 |
|
JvResult |
close()
JV-Dataの読み込み処理を正常に終了させます。 |
|
JvCourseFile |
courseFile(CourseFileKey courseFileKey)
JV-Linkからコースgif画像を要求し、{JRA-VANインストールディレクトリ}/Data Lab/pictures配下に保存します。 |
|
JvCourseFile |
courseFile2(CourseFileKey courseFileKey,
String filePath)
JV-Linkからコースgif画像を要求し、任意の場所に保存します。 |
|
JvResult |
fileDelete(String fileName)
ダウンロードしたJV-Dataを削除します。 |
|
JvResult |
fukuFile(String pattern,
String filePath)
任意の勝負服画像情報を要求し、指定のパスに保存します。 |
|
String |
getUserAgent()
設定されているUserAgentを返します。 |
|
JvResult |
init()
JVLinkの初期化を行います。 |
|
|
open(StoredOpenCondition<T> condition,
Date fromTime,
DataOption dataOption)
蓄積系データの取得要求を行います。 |
|
|
open(StoredOpenCondition<T> condition,
String fromTime,
DataOption dataOption)
蓄積系データの取得要求を行います。 |
|
|
rtOpen(RealTimeOpenCondition<T> condition,
RtOpenKey rtOpenKey)
速報系のデータ取得要求を行います。 |
|
|
rtSimpleOpen(RealTimeOpenCondition<T> condition,
RtOpenKey rtOpenKey)
速報系のデータ取得要求を行います。 |
|
JvResult |
setSaveFlag(boolean saveFlag)
JV-Linkのデータを設定したパスに保存するかどうかを設定します。 |
|
JvResult |
setSavePath(String savePath)
JV-Linkのデータの保存パスを設定し、レジストリに保存します。 |
|
JvResult |
setServiceKey(String serviceKey)
JV-Linkのサービスキーを設定し、レジストリに保存します。 |
|
JvResult |
setUIProperties()
JV-Linkの設定変更を行うためのダイアログを表示します。 |
|
void |
setUserAgent(String userAgent)
JVLinkからJRA-VANサーバにアクセスする際のUserAgent HTTPヘッダを指定します。 |
|
|
simpleOpen(StoredOpenCondition<T> condition,
Date fromTime,
DataOption dataOption)
蓄積系データの取得要求を行います。 |
|
|
simpleOpen(StoredOpenCondition<T> condition,
String fromTime,
DataOption dataOption)
蓄積系データの取得要求を行います。 |
|
void |
skip()
open(org.stormcat.jvbeans.config.condition.StoredOpenConditionで準備した不要レコードを読み飛ばします。 |
|
long |
status()
JV-Dataのダウンロード完了ファイル数を返します。 |
|
| メソッドの詳細 |
|---|
void setUserAgent(String userAgent)
UserAgentとして指定できる文字列は、最大64バイトで以下の文字で構成されます。
null, 空文字を含む)が渡された場合はIllegalArgumentExceptionがthrowされます。
また、このメソッドを使用しなかった場合はUserAgentとしてUNKNOWNが指定されます。
設定されたUserAgentはinit()内で指定されます。
userAgent - UserAgent文字列String getUserAgent()
setUserAgent(String)で設定されていなければUNKNOWNを返します。
JvResult init()
JVLinkの一連の処理を行う際に、最初に呼び出す必要があるメソッドです。
初期化処理の際に、JRA-VANサーバにアクセスする際のUserAgentを設定します。
ここで使用するUserAgentはsetUserAgent(String)でセットされた文字列が使用されますが、
セットしなかった場合はUNKNOWNが使用されます。
JvResult setUIProperties()
設定可能なプロパティは以下の通りです。
ただし、サービスキーが既に設定されている場合は変更できません。
JvResult setServiceKey(String serviceKey)
サービスキーが設定済みの場合は、サービスキーは変更できません。
serviceKey - サービスキー
IllegalArgumentException - 保存パスがnull、もしくは存在しないディレクトリの場合JvResult setSaveFlag(boolean saveFlag)
saveFlag - true:保存する, false:保存しない
JvResult setSavePath(String savePath)
保存パスは実際に存在するディレクトリを指定する必要があります。
savePath - 保存パス
IllegalArgumentException - 保存パスがnull、もしくは存在しないディレクトリの場合
<T extends JvBindingDto> JvReader<T> open(StoredOpenCondition<T> condition,
Date fromTime,
DataOption dataOption)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
T - JvBindingDto型condition - データ取得条件fromTime - データ読み出し開始ポイント(YYYYMMDDhhmmss形式)dataOption - データオプション
nullの場合はDataOption.STANDARDで取得要求が行われます。
JvReaderImpl
IllegalArgumentException - 引数にnullがある場合
<T extends JvBindingDto> JvReader<T> open(StoredOpenCondition<T> condition,
String fromTime,
DataOption dataOption)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
T - JvBindingDto型condition - データ取得条件fromTime - データ読み出し開始ポイント(YYYYMMDDhhmmss形式)dataOption - データオプション
nullの場合はDataOption.STANDARDで取得要求が行われます。
JvReader
IllegalArgumentException - 引数にnullがある場合
<T extends JvBindingDto> JvReader<String> simpleOpen(StoredOpenCondition<T> condition,
Date fromTime,
DataOption dataOption)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
DTOへのバインディングは行いません。
T - JvBindingDto型condition - データ取得条件fromTime - データ読み出し開始ポイント(YYYYMMDDhhmmss形式)dataOption - データオプション
nullの場合はDataOption.STANDARDで取得要求が行われます。
JvReader
<T extends JvBindingDto> JvReader<String> simpleOpen(StoredOpenCondition<T> condition,
String fromTime,
DataOption dataOption)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
DTOへのバインディングは行いません。
T - JvBindingDto型condition - データ取得条件fromTime - データ読み出し開始ポイント(YYYYMMDDhhmmss形式)dataOption - データオプション
nullの場合はDataOption.STANDARDで取得要求が行われます。
JvReader
<T extends JvBindingDto> JvReader<T> rtOpen(RealTimeOpenCondition<T> condition,
RtOpenKey rtOpenKey)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
condition - データ種別rtOpenKey - 速報系要求キー
JvReader
IllegalArgumentException - 引数にnullがある場合
JvIllegalFormatKeyException - データ種別がRtOpenKeyの形式をサポートしていない場合
<T extends JvBindingDto> JvReader<String> rtSimpleOpen(RealTimeOpenCondition<T> condition,
RtOpenKey rtOpenKey)
データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。
DTOへのバインディングは行いません。
condition - データ種別rtOpenKey - 速報系要求キー
JvReader
IllegalArgumentException - 引数にnullがある場合
JvIllegalFormatKeyException - データ種別がRtOpenKeyの形式をサポートしていない場合long status()
ダウンロード失敗時は例外が発生します。
void skip()
open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption) で準備した不要レコードを読み飛ばします。
このメソッドはデータ読み込み中にレコード種別IDを判断して使用するものですが、 JV-Beansではバイト単位ではなく、レコード単位で読みだすため意味はありません。
void cancel()
open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption) によって起動された、JVデータファイルのダウンロード・コピーを安全に中止します。
キャンセル状態において、JvReaderImplによる読み込み処理を行うことはできません。
JvResult close()
開いているファイルを全てクローズさせ、実行中のダウンロードスレッドを安全に終了させます。
データ読み込み後は確実に呼び出す必要があります。
JvResult fileDelete(String fileName)
ファイル名はXXXXX.jvdのように、ファイル名だけを指定します(フルパスを指定する必要はありません)。
何らかの原因により、ファイルが破損してデータがうまく読みだせなくなった際に使用します。
fileName - 削除対象ファイル名
IllegalArgumentException - ファイル名がnullの場合
JvResult fukuFile(String pattern,
String filePath)
pattern - 服色標示文字列
服色標示はJRAレーシングプログラムに記載されているものを指定します。
(例)水色,赤山形一本輪,水色袖
filePath - 取得画像保存フルパス
IllegalArgumentException - 服色標示、保存パスがnullの場合、もしくは保存ディレクトリが存在しない場合JvCourseFile courseFile(CourseFileKey courseFileKey)
keyはCourseFileKeyFactoryで生成したものを指定します。
コース説明文をJvCourseFile.getExplanation()で取得することが可能です。
指定したkeyに該当するコースが存在しない場合は、「No Image」画像が保存されます。
courseFileKey - コースを指定するkey
IllegalArgumentException - mvRaceKeyがnullの場合
JvCourseFile courseFile2(CourseFileKey courseFileKey,
String filePath)
keyはCourseFileKeyFactoryで生成したものを指定します。
courseFile(CourseFileKey)とは違い、
JvCourseFile.getExplanation()にてコース説明文を取得することはできません(nullを返します)。
指定したkeyに該当するコースが存在しない場合は、「No Image」画像が保存されます。
courseFileKey - コースを指定するkeyfilePath - 取得画像保存フルパス
IllegalArgumentException - mvRaceKeyがnullの場合
|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||