info.bix.tokai.bixpp.binding
クラス BIXpp

java.lang.Object
  info.bix.tokai.bixpp.binding.BIXpp

すべての実装されたインタフェース:

java.io.Serializable

public class BIXpp
extends java.lang.Object
implements java.io.Serializable

BIX-ppファイルのタグを表すクラスです。 このクラスは、BIX-ppファイルのversion、作成・修正・完成・生産開始した日付、 生産者の情報を表すProducer、圃場・施設の情報を表すFarm、 生産する植物についての情報を表すCultivation、 記録するデータの定義を表すRecordingDefinition、 時系列データを表すRecordSetの情報を含みます。

例えば、以下の情報を記述したBIX-ppファイルを新たに作成するコードを示します。

項目	値
ファイルが完成した日付	現在の日時
生産者の情報	producer
圃場・施設の情報	farm
生産する植物についての情報	cultivation
生産開始日付	2005/11/11
データの定義	recordingDefinition
時系列データ	recordSet

BIXppオブジェクトを作成すると、BIX-ppファイルのversionは3.0、 ファイルを作成した日時はBIXppオブジェクトを作成した瞬間の日時になります。 また、BIXppIOクラスのwriteメソッドを使用すると、 ファイルを修正した日付はwriteメソッドを使用した瞬間の日時になります。

 BIXpp bixpp = new BIXpp();
 
 //現在の日時でインスタンス化
 Date compleatDate = new Date();
 Date startDate = new Date("2005/11/11");
 Producer producer = new Producer();
 Farm farm = new Farm();
 Cultivation cultivation = new Cultivation();
 RecordingDefinition recordingDefinition = new RecordingDefinition();
 RecordSet recordSet = new RecordSet();
 
 bixpp.setCreate(createDate);
 bixpp.setUpdate(upDate);
 bixpp.setComplete(compleatDate);
 //生産者の情報を作成
 //producer.setName("John");
 //.
 //(中略)
 //.
 bixpp.setProducer(producer);
 //圃場・施設の情報を作成
 //farm.setName("John farm");
 //.
 //(中略)
 //.
 bixpp.setFarm(farm);
 //生産の情報を作成
 //cultivation.setName("rose");
 //.
 //(中略)
 //.
 bixpp.addCultivation(cultivation);
 bixpp.setStart(startDate);
 //データの定義を作成
 //recordingDefinition.addDefinitionItem(item);
 //.
 //(中略)
 //.
 bixpp.setRecordingDefinition(recordingDefinition);
 //時系列データの作成
 //recordSet.addRecord(record);
 //.
 //(中略)
 //.
 bixpp.setRecordSet(recordSet);
 
 try {
     BIXppIO.write(bixpp, new File("test.xml"));
 
 } catch (FileNotFoundException e) {
     e.printStackTrace();
 } catch (IOException e) {
     e.printStackTrace();
 }
 

生産者の情報を表すProducer、圃場・施設の情報を表すFarm、 生産する植物についての情報を表すCultivation、 記録するデータの定義を表すRecordingDefinition、 時系列データを表すRecordSet、 及びBIXppオブジェクトとBIX-ppファイルの相互変換の機能を持つBIXppIOクラス の使用例は、各クラスを参照してください。

作成者:

Shiozawa

関連項目:

BIXppIO, Producer, Farm, Cultivation, RecordingDefinition, RecordSet, 直列化された形式

コンストラクタの概要

BIXpp()
デフォルトコンストラクタです。

メソッドの概要

void	addCultivation(Cultivation vCultivation) 生産する植物についての情報を表すCultivationを追加します。
void	addCultivation(int index, Cultivation vCultivation) 生産する植物についての情報を表すCultivationを指定した位置に追加します。
void	clearCultivation() 生産する植物についての情報を表すCultivationを消去します。
java.util.Date	getComplete() 完成した日付を返します。
java.util.Date	getCreate() ファイルを作成した日付を返します。
Cultivation[]	getCultivation() 生産する植物についての情報を表すCultivationを返します。
Cultivation	getCultivation(int index) 指定した位置の生産する植物についての情報を表すCultivationを返します。
int	getCultivationCount() 生産する植物についての情報を表すCultivationの数を返します。
Farm	getFarm() 圃場・施設の情報を表すFarm返します。
java.net.URL	getFileURL() BIX-ppファイルのURLを返します。
Producer	getProducer() 生産者の情報を表すProducerを返します。
RecordingDefinition	getRecordingDefinition() 記録するデータの定義を表すRecordingDefinitionを返します
RecordSet	getRecordSet() 時系列データを表すRecordSetを返します。
java.util.Date	getStart() 生産開始日付を返します。
java.util.Date	getUpdate() 修正した日付を返します。
float	getVersion() BIX-pp形式ファイルのversionを返します。
boolean	removeCultivation(Cultivation vCultivation) 生産する植物についての情報を表すCultivationを削除します。
void	setComplete(java.util.Date complete) 完成した日付を設定します。
void	setCreate(java.util.Date create) ファイルを作成した日付を設定します。
void	setCultivation(Cultivation[] cultivationArray) 植物についての情報を表すCultivationを追加します。
void	setCultivation(int index, Cultivation vCultivation) 植物についての情報を表すCultivationを、指定した位置に追加します。
void	setFarm(Farm farm) 圃場・施設の情報を設定します。
void	setFileURL(java.net.URL fileURL) BIX-ppファイルのURLを設定します。
void	setProducer(Producer producer) 生産者の情報を設定します。
void	setRecordingDefinition(RecordingDefinition recordingDefinition) 記録するデータの定義を表すRecordingDefinitionを設定します。
void	setRecordSet(RecordSet recordSet) 時系列データを設定します。
void	setStart(java.util.Date start) 生産開始日付を設定します。
void	setUpdate(java.util.Date update) 修正した日付を設定します。
void	setVersion(float version) BIX-pp形式ファイルのversionを設定します。

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

BIXpp

public BIXpp()

デフォルトコンストラクタです。

メソッドの詳細

addCultivation

public void addCultivation(Cultivation vCultivation)
                    throws java.lang.IndexOutOfBoundsException

生産する植物についての情報を表すCultivationを追加します。

パラメータ:

vCultivation - Cultivationオブジェクト

例外:

java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

addCultivation

public void addCultivation(int index,
                           Cultivation vCultivation)
                    throws java.lang.IndexOutOfBoundsException

生産する植物についての情報を表すCultivationを指定した位置に追加します。

パラメータ:

index - 指定した位置

vCultivation - Cultivationオブジェクト

例外:

java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

clearCultivation

public void clearCultivation()

生産する植物についての情報を表すCultivationを消去します。

getComplete

public java.util.Date getComplete()

完成した日付を返します。

戻り値:

完成した日付

getCreate

public java.util.Date getCreate()

ファイルを作成した日付を返します。

戻り値:

ファイルを作成した日付

getCultivation

public Cultivation getCultivation(int index)
                           throws java.lang.IndexOutOfBoundsException

指定した位置の生産する植物についての情報を表すCultivationを返します。

パラメータ:

index - _cultivationListのインデックス

戻り値:

生産する植物についての情報を表すCultivation

例外:

java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合

getCultivation

public Cultivation[] getCultivation()

生産する植物についての情報を表すCultivationを返します。

戻り値:

生産する植物についての情報を表すCultivation

getCultivationCount

public int getCultivationCount()

生産する植物についての情報を表すCultivationの数を返します。

戻り値:

生産する植物についての情報を表すCultivationの数

getFarm

public Farm getFarm()

圃場・施設の情報を表すFarm返します。

戻り値:

圃場・施設の情報を表すFarm

getProducer

public Producer getProducer()

生産者の情報を表すProducerを返します。

戻り値:

生産者の情報を表すProducer

getRecordSet

public RecordSet getRecordSet()

時系列データを表すRecordSetを返します。

戻り値:

時系列データを表すRecordSet

getRecordingDefinition

public RecordingDefinition getRecordingDefinition()

記録するデータの定義を表すRecordingDefinitionを返します

戻り値:

記録するデータの定義を表すRecordingDefinition

getUpdate

public java.util.Date getUpdate()

修正した日付を返します。

戻り値:

修正した日付

getVersion

public float getVersion()

BIX-pp形式ファイルのversionを返します。

戻り値:

BIX-pp形式ファイルのversion

removeCultivation

public boolean removeCultivation(Cultivation vCultivation)

生産する植物についての情報を表すCultivationを削除します。

パラメータ:

vCultivation - Cultivationオブジェクト

戻り値:

削除が行われた場合はtrue、行われなかった場合はfalse

setComplete

public void setComplete(java.util.Date complete)

完成した日付を設定します。

パラメータ:

complete - 完成した日付

setCreate

public void setCreate(java.util.Date create)

ファイルを作成した日付を設定します。

パラメータ:

create - ファイルを作成した日付

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setCultivation

public void setCultivation(int index,
                           Cultivation vCultivation)
                    throws java.lang.IndexOutOfBoundsException

植物についての情報を表すCultivationを、指定した位置に追加します。

パラメータ:

index - 指定した位置

vCultivation - Cultivationオブジェクト

例外:

java.lang.IndexOutOfBoundsException - インデックスが範囲外の場合

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setCultivation

public void setCultivation(Cultivation[] cultivationArray)

植物についての情報を表すCultivationを追加します。

パラメータ:

cultivationArray - Cultivationオブジェクト

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setFarm

public void setFarm(Farm farm)

圃場・施設の情報を設定します。

パラメータ:

farm - 圃場・施設の情報

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setProducer

public void setProducer(Producer producer)

生産者の情報を設定します。

パラメータ:

producer - 生産者の情報

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setRecordSet

public void setRecordSet(RecordSet recordSet)

時系列データを設定します。

パラメータ:

recordSet - 時系列データ

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setRecordingDefinition

public void setRecordingDefinition(RecordingDefinition recordingDefinition)

記録するデータの定義を表すRecordingDefinitionを設定します。

パラメータ:

recordingDefinition - RecordingDefinitionオブジェクト

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setUpdate

public void setUpdate(java.util.Date update)

修正した日付を設定します。

パラメータ:

update - 修正した日付

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

setVersion

public void setVersion(float version)

BIX-pp形式ファイルのversionを設定します。

パラメータ:

version - BIX-pp形式ファイルのversion

getStart

public java.util.Date getStart()

生産開始日付を返します。

戻り値:

生産開始日付

setStart

public void setStart(java.util.Date start)

生産開始日付を設定します。

パラメータ:

start - 生産開始日付

例外:

java.lang.IllegalArgumentException - 引数にnullを指定した場合

getFileURL

public java.net.URL getFileURL()

BIX-ppファイルのURLを返します。 BIX-ppが保存されていなかったり、新規作成の場合nullが返されます。

戻り値:

BIX-ppファイルのURL

setFileURL

public void setFileURL(java.net.URL fileURL)

BIX-ppファイルのURLを設定します。

パラメータ:

fileURL - BIX-ppファイルのURL