pexa.share.util.sort

クラス MultiruleComparator

java.lang.Object

pexa.share.util.sort.MultiruleComparator

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

java.util.Comparator

public class MultiruleComparator
extends java.lang.Object
implements java.util.Comparator

複数のルールを適用できるソート機能を実現するための比較クラス。 java.util.Arrays を用いたソートが実現するために、java.util.Comparator インタフェースを実装している。

バージョン:

$Revision: 6958 $, $Date:: 2012-06-11 20:19:30 #$

作成者:

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected boolean	nullIsMinimum 比較対象がnullの場合にそれを最小とするかのフラグ。
protected boolean	reverseNullSortOrder null値のソート順逆転フラグ
protected java.util.Vector	rules ルール情報群。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MultiruleComparator() デフォルト rls ルール情報;
MultiruleComparator(SortRule[] rls) ルール情報配列を引数にとるコンストラクタ。
MultiruleComparator(SortRule[] rls, boolean nullIsMinimum) ルール情報配列を引数にとるコンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addRule(SortRule rl) ソートルールを追加する。
void	addRules(SortRule[] rls) ソートルール群を追加する。
protected int	compare(MultiruleSortable t1, MultiruleSortable t2, SortRule r) 2 オブジェクトの比較を行う。
int	compare(java.lang.Object o1, java.lang.Object o2) 2 オブジェクトの比較を行う。
java.lang.String	toString()

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

フィールドの詳細

reverseNullSortOrder

protected boolean reverseNullSortOrder

null値のソート順逆転フラグ

rules

protected java.util.Vector rules

ルール情報群。

nullIsMinimum

protected boolean nullIsMinimum

比較対象がnullの場合にそれを最小とするかのフラグ。 falseの場合は逆に最大とする。

コンストラクタの詳細

MultiruleComparator

public MultiruleComparator()

デフォルト rls ルール情報;

MultiruleComparator

public MultiruleComparator(SortRule[] rls)

ルール情報配列を引数にとるコンストラクタ。

パラメータ:

rls - ルール情報;

MultiruleComparator

public MultiruleComparator(SortRule[] rls,
                           boolean nullIsMinimum)

ルール情報配列を引数にとるコンストラクタ。

パラメータ:

rls - ルール情報;

nullIsMinimum - 比較対象がnullの場合にそれを最小とするかのフラグ。falseの場合は逆に最大とする。

メソッドの詳細

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

2 オブジェクトの比較を行う。設定されているソートルール群に したがって、比較を行い、結果を正負零の値で返す。

比較対象オブジェクトは MultiruleSortable でなければならない。 比較対象が null オブジェクトであった場合、デフォルトでは最小の値に相当するものとする。 コンストラクタパラメータのnullIsMinimumでfalse指定することで、逆にすることもできる。

定義:

compare インタフェース内 java.util.Comparator

パラメータ:

o1 - 比較対象前者

o2 - 比較対象後者

戻り値:

比較対象の前者の方が、ソートの結果前方に来るべきならば負の値を返す。逆なら正の値を返す。等しければ０を返す。 一方が null で他方が non-null の場合、デフォルトではnull を最小と想定し、1 または -1 を返す。双方 null なら 0 を返す。 nullIsMinimumがfalseの場合はこの逆の扱いとなる。

例外:

java.lang.IllegalArgumentException - 比較対象オブジェクトが MultiruleSortable インスタンスでない場合。

UnsupportedSortKeyException - ルールに指定されているソートキーを比較対象オブジェクトがサポートしていない場合に発生。

compare

protected int compare(MultiruleSortable t1,
                      MultiruleSortable t2,
                      SortRule r)

2 オブジェクトの比較を行う。指定された単一ソートルールを基準に比較する。

比較対象オブジェクトは MultiruleSortable でなければならない。

パラメータ:

t1 - 比較対象前者

t2 - 比較対象後者

r - ソートルール

戻り値:

比較対象の前者の方が、ソートの結果前方に来るべきならば負の値を返す。逆なら正の値を返す。等しければ 0 を返す。 比較対象オブジェクトから MultiruleSortable インタフェースを通じて取り出した値が null である場合、デフォルトでは最小の値に相当するものとする。 この場合、比較結果は 1, -1, 0 のいずれかを返す。nullIsMinimumがfalseの場合はこの逆の扱いとなる。

例外:

UnsupportedSortKeyException - ルールに指定されているソートキーを比較対象オブジェクトがサポートしていない場合に発生。

addRule

public void addRule(SortRule rl)

ソートルールを追加する。

パラメータ:

rl - 追加ルール

addRules

public void addRules(SortRule[] rls)

ソートルール群を追加する。

パラメータ:

rls - 追加ルール群

toString

public java.lang.String toString()

オーバーライド:

toString クラス内 java.lang.Object