net.yacy.cora.order

Interface Order<A>

All Superinterfaces:

java.util.Comparator<A>

All Known Subinterfaces:

ByteOrder

All Known Implementing Classes:

AbstractOrder, Base64Order, NaturalOrder, RatingOrder, ReferenceContainerOrder, Row.EntryComparator

public interface Order<A>
extends java.util.Comparator<A>

Method Summary

Methods

Modifier and Type	Method and Description
long	cardinal(A key) returns a cardinal number in the range of 0 ..
Order<A>	clone()
int	compare(A a, A b)
void	direction(boolean ascending) the ordering direction can be changed at any time
boolean	equal(A a, A b)
boolean	equals(java.lang.Object o) used to compare different order objects; they may define the same ordering
int	hashCode()
long	partition(A key, int forkes)
void	rotate(A zero) defines that the ordering rotates, and sets the zero point for the rotation
java.lang.String	signature() returns a signature String so that different orderings have different signatures
boolean	wellformed(A a) returns true if and only if a has only characters that belong to the implemented order
A	zero() returns the zero point of the Ordering; null if not defined

Method Detail

wellformed

boolean wellformed(A a)

returns true if and only if a has only characters that belong to the implemented order

Parameters:

a -

Returns:

clone

Order<A> clone()

direction

void direction(boolean ascending)

the ordering direction can be changed at any time

Parameters:

ascending -

signature

java.lang.String signature()

returns a signature String so that different orderings have different signatures

Returns:

partition

long partition(A key,
             int forkes)

cardinal

long cardinal(A key)

returns a cardinal number in the range of 0 .. Long.MAX_VALUE

Parameters:

key -

Returns:

compare

int compare(A a,
          A b)

Specified by:

compare in interface java.util.Comparator<A>

equal

boolean equal(A a,
            A b)

zero

A zero()

returns the zero point of the Ordering; null if not defined

Returns:

rotate

void rotate(A zero)

defines that the ordering rotates, and sets the zero point for the rotation

Parameters:

zero -

equals

boolean equals(java.lang.Object o)

used to compare different order objects; they may define the same ordering

Specified by:

equals in interface java.util.Comparator<A>

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object