All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.predicates.EqualCollationKey 

java.lang.Object
   |
   +----COM.objectspace.jgl.predicates.EqualCollationKey
public final class EqualCollationKey
extends Object
implements BinaryPredicate
EqualCollationKey is a binary predicate that returns true if the first operand as a string is equal to the second operand as a string when compared using the given Collator object. Instead of using the compare() call, getCollationKey() is used and the results of that are compared. If either operand is itself a CollationKey object, then that operand is used without getting a new key from the collator.

If an explicit Collator object is not given, the default is used.

See Also:
Collator, CollationKey, CollateExamples

Constructor Index

o EqualCollationKey()
Construct a EqualCollationKey function object that uses the collator object for the current default locale to compare operands that are not instances of CollationKey.
o EqualCollationKey(Collator)
Construct a EqualCollationKey function object that uses the given collator object to compare operands that are not instances of CollationKey.

Method Index

o execute(Object, Object)
Return true if the first operand is equal to the second operand.

Constructors

o EqualCollationKey 
 public EqualCollationKey()
Construct a EqualCollationKey function object that uses the collator object for the current default locale to compare operands that are not instances of CollationKey.

o EqualCollationKey 
 public EqualCollationKey(Collator collator)
Construct a EqualCollationKey function object that uses the given collator object to compare operands that are not instances of CollationKey.

Parameters:
collator - The Collator object that is to be used for comparisons.

Methods

o execute 
 public boolean execute(Object first,
                        Object second)
Return true if the first operand is equal to the second operand. Note: CollationKeys created by different Collators can not be compared.

Parameters:
first - The first operand.
second - The second operand.
Returns:
true if the sort key of the first operand is equal to that of the second.
See Also:
compareTo 
All Packages  Class Hierarchy  This Package  Previous  Next  Index