net.trialpc.sticktools.score
クラス AbstractScoringMethod<T extends LangModel>

java.lang.Object
  上位を拡張 net.trialpc.sticktools.score.AbstractScoringMethod<T>
型パラメータ:
T - 評価値を算出する対象となるクラス
すべての実装されたインタフェース:
ScoringMethod<T>
直系の既知のサブクラス:
DefaultScoringMethod

public abstract class AbstractScoringMethod<T extends LangModel>
extends java.lang.Object
implements ScoringMethod<T>

評価値算出の実装を容易にするために提供される抽象クラスです。 このクラスを継承するクラスは、evaluateScore(LangModel, Collection) を実装するだけで評価値を算出できるようになります。

作成者:
tetsu

コンストラクタの概要
AbstractScoringMethod()
           
 
メソッドの概要
 void addQueries(java.util.Collection<Query> queries)
          複数のクエリを設定します。
 void addQueriesAsString(java.util.Collection<java.lang.String> queries)
          複数のクエリを設定します。
 boolean addQuery(Query query)
          クエリを設定します。
 boolean addQuery(java.lang.String query)
          クエリを設定します。
 void evaluate()
          評価値を算出します。
protected abstract  double evaluateScore(T model, java.util.Collection<Query> queries)
          言語モデル model から評価値を算出して返します。
 double getScore()
          評価値を返します。
 boolean setModel(T model)
          評価値を算出するモデルを設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

AbstractScoringMethod

public AbstractScoringMethod()
メソッドの詳細

addQueriesAsString

public void addQueriesAsString(java.util.Collection<java.lang.String> queries)
複数のクエリを設定します。 この実装は、addQuery(String) メソッドに依存しています。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の addQueriesAsString
パラメータ:
queries - クエリを含むコレクション

addQueries

public void addQueries(java.util.Collection<Query> queries)
複数のクエリを設定します。 この実装は、addQuery(Query) メソッドに依存しています。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の addQueries
パラメータ:
queries - クエリを含むコレクション

addQuery

public boolean addQuery(java.lang.String query)
クエリを設定します。 この実装では、空文字はクエリとして扱いません。 空文字が与えられた時は例外はスローせず、false を返します。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の addQuery
パラメータ:
query - クエリ(単語)
例外:
java.lang.NullPointerException - querynull である場合。

addQuery

public boolean addQuery(Query query)
クエリを設定します。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の addQuery
パラメータ:
query - クエリ
例外:
java.lang.NullPointerException - querynull である場合。

setModel

public boolean setModel(T model)
評価値を算出するモデルを設定します。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の setModel
パラメータ:
model - 評価値を算出する対象となる言語モデル
戻り値:
モデルが設定し終わったときは true
例外:
java.lang.NullPointerException - modelnull である場合。

evaluate

public void evaluate()
インタフェース ScoringMethod の記述:
評価値を算出します。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の evaluate

getScore

public double getScore()
インタフェース ScoringMethod の記述:
評価値を返します。

定義:
インタフェース ScoringMethod<T extends LangModel> 内の getScore
戻り値:
算出対象の言語モデルと評価値がマッピングしたマップ

evaluateScore

protected abstract double evaluateScore(T model,
                                        java.util.Collection<Query> queries)
言語モデル model から評価値を算出して返します。 引数 model, queriesnull であることはありません。 また、引数のインスタンスの内容を変更することは、次回以降の評価値算出の際に影響が出るため推奨されません。

パラメータ:
model - 評価値算出対象の言語モデル
queries - クエリの集合
戻り値:
評価値