org.stormcat.jvbeans.jvlink
インタフェース JvLinkManager

既知の実装クラスの一覧:
JvLinkManagerImpl

public interface JvLinkManager

JVLinkにアクセスするための基本的なAPIを提供します。

JvLinkWrapper層はJV-Link APIの純粋なラッパーであることに対し、 JvLinkManager層においては、JV-LinkをJavaで利用する開発者にとって使いやすく堅牢にするための実装が施される必要があります。

導入されたバージョン:
0.1
作成者:
a.yamada

メソッドの概要
 void cancel()
          open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption)によって起動された、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の初期化を行います。
<T extends JvBindingDto>
JvReader<T>
open(StoredOpenCondition<T> condition, Date fromTime, DataOption dataOption)
          蓄積系データの取得要求を行います。
<T extends JvBindingDto>
JvReader<T>
open(StoredOpenCondition<T> condition, String fromTime, DataOption dataOption)
          蓄積系データの取得要求を行います。
<T extends JvBindingDto>
JvReader<T>
rtOpen(RealTimeOpenCondition<T> condition, RtOpenKey rtOpenKey)
          速報系のデータ取得要求を行います。
<T extends JvBindingDto>
JvReader<String>
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ヘッダを指定します。
<T extends JvBindingDto>
JvReader<String>
simpleOpen(StoredOpenCondition<T> condition, Date fromTime, DataOption dataOption)
          蓄積系データの取得要求を行います。
<T extends JvBindingDto>
JvReader<String>
simpleOpen(StoredOpenCondition<T> condition, String fromTime, DataOption dataOption)
          蓄積系データの取得要求を行います。
 void skip()
          open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption)で準備した不要レコードを読み飛ばします。
 long status()
          JV-Dataのダウンロード完了ファイル数を返します。
 

メソッドの詳細

setUserAgent

void setUserAgent(String userAgent)
JVLinkからJRA-VANサーバにアクセスする際のUserAgent HTTPヘッダを指定します。

UserAgentとして指定できる文字列は、最大64バイトで以下の文字で構成されます。

上述の条件が満たされていない文字列(null, 空文字を含む)が渡された場合はIllegalArgumentExceptionがthrowされます。

また、このメソッドを使用しなかった場合はUserAgentとしてUNKNOWNが指定されます。

設定されたUserAgentはinit()内で指定されます。

パラメータ:
userAgent - UserAgent文字列

getUserAgent

String getUserAgent()
設定されているUserAgentを返します。

setUserAgent(String)で設定されていなければUNKNOWNを返します。

戻り値:
UserAgent

init

JvResult init()
JVLinkの初期化を行います。

JVLinkの一連の処理を行う際に、最初に呼び出す必要があるメソッドです。

初期化処理の際に、JRA-VANサーバにアクセスする際のUserAgentを設定します。 ここで使用するUserAgentはsetUserAgent(String)でセットされた文字列が使用されますが、 セットしなかった場合はUNKNOWNが使用されます。

戻り値:
結果オブジェクト

setUIProperties

JvResult setUIProperties()
JV-Linkの設定変更を行うためのダイアログを表示します。

設定可能なプロパティは以下の通りです。

ただし、サービスキーが既に設定されている場合は変更できません。

戻り値:
結果オブジェクト

setServiceKey

JvResult setServiceKey(String serviceKey)
JV-Linkのサービスキーを設定し、レジストリに保存します。

サービスキーが設定済みの場合は、サービスキーは変更できません。

パラメータ:
serviceKey - サービスキー
戻り値:
結果オブジェクト
例外:
IllegalArgumentException - 保存パスがnull、もしくは存在しないディレクトリの場合

setSaveFlag

JvResult setSaveFlag(boolean saveFlag)
JV-Linkのデータを設定したパスに保存するかどうかを設定します。

パラメータ:
saveFlag - true:保存する, false:保存しない
戻り値:
結果オブジェクト

setSavePath

JvResult setSavePath(String savePath)
JV-Linkのデータの保存パスを設定し、レジストリに保存します。

保存パスは実際に存在するディレクトリを指定する必要があります。

パラメータ:
savePath - 保存パス
戻り値:
結果オブジェクト
例外:
IllegalArgumentException - 保存パスがnull、もしくは存在しないディレクトリの場合

open

<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がある場合

open

<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がある場合

simpleOpen

<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
導入されたバージョン:
0.2

simpleOpen

<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
導入されたバージョン:
0.2

rtOpen

<T extends JvBindingDto> JvReader<T> rtOpen(RealTimeOpenCondition<T> condition,
                                            RtOpenKey rtOpenKey)
速報系のデータ取得要求を行います。

データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。

パラメータ:
condition - データ種別
rtOpenKey - 速報系要求キー
戻り値:
JvReader
例外:
IllegalArgumentException - 引数にnullがある場合
JvIllegalFormatKeyException - データ種別がRtOpenKeyの形式をサポートしていない場合

rtSimpleOpen

<T extends JvBindingDto> JvReader<String> rtSimpleOpen(RealTimeOpenCondition<T> condition,
                                                       RtOpenKey rtOpenKey)
速報系のデータ取得要求を行います。

データの読み出しはJvReaderをイテレートすることで1レコードずつ読み出されます。

DTOへのバインディングは行いません。

パラメータ:
condition - データ種別
rtOpenKey - 速報系要求キー
戻り値:
JvReader
例外:
IllegalArgumentException - 引数にnullがある場合
JvIllegalFormatKeyException - データ種別がRtOpenKeyの形式をサポートしていない場合

status

long status()
JV-Dataのダウンロード完了ファイル数を返します。

ダウンロード失敗時は例外が発生します。

戻り値:
ダウンロード完了ファイル数

skip

void skip()
open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption)で準備した不要レコードを読み飛ばします。

このメソッドはデータ読み込み中にレコード種別IDを判断して使用するものですが、 JV-Beansではバイト単位ではなく、レコード単位で読みだすため意味はありません。


cancel

void cancel()
open(org.stormcat.jvbeans.config.condition.StoredOpenCondition, java.util.Date, org.stormcat.jvbeans.config.DataOption)によって起動された、JVデータファイルのダウンロード・コピーを安全に中止します。

キャンセル状態において、JvReaderImplによる読み込み処理を行うことはできません。


close

JvResult close()
JV-Dataの読み込み処理を正常に終了させます。

開いているファイルを全てクローズさせ、実行中のダウンロードスレッドを安全に終了させます。

データ読み込み後は確実に呼び出す必要があります。

戻り値:
結果オブジェクト

fileDelete

JvResult fileDelete(String fileName)
ダウンロードしたJV-Dataを削除します。

ファイル名はXXXXX.jvdのように、ファイル名だけを指定します(フルパスを指定する必要はありません)。

何らかの原因により、ファイルが破損してデータがうまく読みだせなくなった際に使用します。

パラメータ:
fileName - 削除対象ファイル名
戻り値:
結果オブジェクト
例外:
IllegalArgumentException - ファイル名がnullの場合

fukuFile

JvResult fukuFile(String pattern,
                  String filePath)
任意の勝負服画像情報を要求し、指定のパスに保存します。

パラメータ:
pattern - 服色標示文字列

服色標示はJRAレーシングプログラムに記載されているものを指定します。

(例)水色,赤山形一本輪,水色袖

filePath - 取得画像保存フルパス
戻り値:
結果オブジェクト
例外:
IllegalArgumentException - 服色標示、保存パスがnullの場合、もしくは保存ディレクトリが存在しない場合

courseFile

JvCourseFile courseFile(CourseFileKey courseFileKey)
JV-Linkからコースgif画像を要求し、{JRA-VANインストールディレクトリ}/Data Lab/pictures配下に保存します。

keyはCourseFileKeyFactoryで生成したものを指定します。

コース説明文をJvCourseFile.getExplanation()で取得することが可能です。

指定したkeyに該当するコースが存在しない場合は、「No Image」画像が保存されます。

パラメータ:
courseFileKey - コースを指定するkey
戻り値:
コース図用結果オブジェクト
例外:
IllegalArgumentException - mvRaceKeyがnullの場合

courseFile2

JvCourseFile courseFile2(CourseFileKey courseFileKey,
                         String filePath)
JV-Linkからコースgif画像を要求し、任意の場所に保存します。

keyはCourseFileKeyFactoryで生成したものを指定します。

courseFile(CourseFileKey)とは違い、 JvCourseFile.getExplanation()にてコース説明文を取得することはできません(nullを返します)。

指定したkeyに該当するコースが存在しない場合は、「No Image」画像が保存されます。

パラメータ:
courseFileKey - コースを指定するkey
filePath - 取得画像保存フルパス
戻り値:
コース図用結果オブジェクト
例外:
IllegalArgumentException - mvRaceKeyがnullの場合


Copyright © 2009-2010 The Stormcat Project AllRights Reserved.