org.mklab.tool.control.system.parameter
クラス ParameterContainer

java.lang.Object
  org.mklab.tool.control.system.parameter.ParameterContainer

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

Comparable<ParameterContainer>

public class ParameterContainer
extends Object
implements Comparable<ParameterContainer>

パラメータの値とアノテーションをまとめて管理するクラスです。

バージョン:

$Revision: 1.12 $, 2007/01/23

作成者:

Koga Laboratory

コンストラクタの概要

ParameterContainer(SystemOperator system, Field value, Parameter anotation, String name)
新しく生成されたParameterContainerオブジェクトを初期化します。

メソッドの概要

int	compareTo(ParameterContainer opponent) opponentと比較した結果を返します。
boolean	equals(Object o)
Parameter	getAnotation() パラメータのアノテーションを返します。
static int	getArrayLength(String elementName) 配列パラメータの成分の個数を返します。
boolean	getBoolean() パラメータの値を返します。
byte	getByte() パラメータの値を返します。
char	getChar() パラメータの値を返します。
String	getDescription() 説明を返します。
double	getDouble() パラメータの値を返します。
String	getExpression() パラメータの定義式を返します。
float	getFloat() パラメータの値を返します。
static int	getIndexOfArray(String elementName) 配列パラメータの指数を返します。
int	getInt() パラメータの値を返します。
String	getInternationalizedString(String key) 国際化されたパラメータの説明を返します。
long	getLong() パラメータの値を返します。
String	getName() パラメータの名前を返します。
Class<?>	getParameterClass() パラメータを宣言するクラスまたはインタフェースを表す Class オブジェクトを返します。
short	getShort() パラメータの値を返します。
Class<?>	getType() パラメータの型を識別するための Class オブジェクトを返します。
SIunit[]	getUnit() 単位を返します。
Object	getValue() パラメータの値を返します。
int	hashCode()
boolean	isInternationalized() パラメータの説明が国際化されているか判定します。
void	setBoolean(boolean value) パラメータの値を設定します。
void	setByte(byte value) パラメータの値を設定します。
void	setChar(char value) パラメータの値を設定します。
void	setDouble(double value) パラメータの値を設定します。
void	setExpression(String expression) パラメータの定義式を設定します。
void	setFloat(float value) パラメータの値を設定します。
void	setInt(int value) パラメータの値を設定します。
void	setLong(long value) パラメータの値を設定します。
void	setShort(short value) パラメータの値を設定します。
void	setValue(Object value) パラメータに値を設定します。
String	toString()

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

ParameterContainer

public ParameterContainer(SystemOperator system,
                          Field value,
                          Parameter anotation,
                          String name)

新しく生成されたParameterContainerオブジェクトを初期化します。

パラメータ:

system - パラメータをもつシステム

value - パラメータの値を保持するフィールド

anotation - パラメータのアノテーション

name - 名前

メソッドの詳細

getAnotation

public Parameter getAnotation()

パラメータのアノテーションを返します。

戻り値:

パラメータのアノテーション

getValue

public Object getValue()
                throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setValue

public void setValue(Object value)
              throws ParameterAccessException

パラメータに値を設定します。

パラメータ:

value - 設定する値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setExpression

public void setExpression(String expression)

パラメータの定義式を設定します。

パラメータ:

expression - パラメータの定義式

getBoolean

public boolean getBoolean()
                   throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setBoolean

public void setBoolean(boolean value)
                throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getByte

public byte getByte()
             throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setByte

public void setByte(byte value)
             throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getChar

public char getChar()
             throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setChar

public void setChar(char value)
             throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getDouble

public double getDouble()
                 throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setDouble

public void setDouble(double value)
               throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getFloat

public float getFloat()
               throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setFloat

public void setFloat(float value)
              throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getInt

public int getInt()
           throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setInt

public void setInt(int value)
            throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getLong

public long getLong()
             throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setLong

public void setLong(long value)
             throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

getShort

public short getShort()
               throws ParameterAccessException

パラメータの値を返します。

戻り値:

パラメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

setShort

public void setShort(short value)
              throws ParameterAccessException

パラメータの値を設定します。

パラメータ:

value - パレメータの値

例外:

ParameterAccessException - パラメータにアクセスする権利が無い場合

compareTo

public int compareTo(ParameterContainer opponent)

opponentと比較した結果を返します。

opponentより順序が前のとき正、 opponentより順序が後のとき負、 等しいとき0を返します。

定義:

インタフェース Comparable<ParameterContainer> 内の compareTo

パラメータ:

opponent - 比較対象

戻り値:

opponentと比較した結果

getName

public String getName()

パラメータの名前を返します。

戻り値:

パラメータの名前

getExpression

public String getExpression()

パラメータの定義式を返します。

戻り値:

パラメータの定義式

getType

public Class<?> getType()

パラメータの型を識別するための Class オブジェクトを返します。

戻り値:

パラメータの型を識別するための Class オブジェクトを返します。

getParameterClass

public Class<?> getParameterClass()

パラメータを宣言するクラスまたはインタフェースを表す Class オブジェクトを返します。

戻り値:

パラメータを宣言するクラスまたはインタフェースを表す Class オブジェクト

equals

public boolean equals(Object o)

オーバーライド:

クラス Object 内の equals

関連項目:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

オーバーライド:

クラス Object 内の hashCode

関連項目:

Object.hashCode()

toString

public String toString()

オーバーライド:

クラス Object 内の toString

関連項目:

Object.toString()

getDescription

public String getDescription()

説明を返します。

戻り値:

説明

getUnit

public SIunit[] getUnit()

単位を返します。

戻り値:

単位

getIndexOfArray

public static int getIndexOfArray(String elementName)

配列パラメータの指数を返します。

パラメータ:

elementName - 配列パラメータの名前

戻り値:

配列パラメータの指数

getArrayLength

public static int getArrayLength(String elementName)

配列パラメータの成分の個数を返します。

パラメータ:

elementName - 配列パラメータの名前

戻り値:

配列パラメータの成分の個数

isInternationalized

public boolean isInternationalized()

パラメータの説明が国際化されているか判定します。

戻り値:

パラメータの説明が国際化されていればtrue、そうでなければfalse

getInternationalizedString

public String getInternationalizedString(String key)
                                  throws ParameterException

国際化されたパラメータの説明を返します。

パラメータ:

key - キー

戻り値:

国際化されたパラメータの説明

例外:

ParameterException - パラメータの説明が国際化されていない場合