01: // kelondroOrder.java
02: // -----------------------
03: // part of The Kelondro Database
04: // (C) by Michael Peter Christen; mc@anomic.de
05: // first published on http://www.anomic.de
06: // Frankfurt, Germany, 2005
07: // created 29.12.2005
08: //
09: // $LastChangedDate: 2005-09-22 22:01:26 +0200 (Thu, 22 Sep 2005) $
10: // $LastChangedRevision: 774 $
11: // $LastChangedBy: orbiter $
12: //
13: // This program is free software; you can redistribute it and/or modify
14: // it under the terms of the GNU General Public License as published by
15: // the Free Software Foundation; either version 2 of the License, or
16: // (at your option) any later version.
17: //
18: // This program is distributed in the hope that it will be useful,
19: // but WITHOUT ANY WARRANTY; without even the implied warranty of
20: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21: // GNU General Public License for more details.
22: //
23: // You should have received a copy of the GNU General Public License
24: // along with this program; if not, write to the Free Software
25: // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26: //
27: // Using this software in any meaning (reading, learning, copying, compiling,
28: // running) means that you agree that the Author(s) is (are) not responsible
29: // for cost, loss of data or any harm that may be caused directly or indirectly
30: // by usage of this softare or this documentation. The usage of this software
31: // is on your own risk. The installation and usage (starting/running) of this
32: // software may allow other people or application to access your computer and
33: // any attached devices and is highly dependent on the configuration of the
34: // software which must be done by the user of the software; the author(s) is
35: // (are) also not responsible for proper configuration and usage of the
36: // software, even if provoked by documentation provided together with
37: // the software.
38: //
39: // Any changes to this file according to the GPL as documented in the file
40: // gpl.txt aside this file in the shipment you received can be done to the
41: // lines that follows this copyright notice here, but changes must not be
42: // done inside the copyright notive above. A re-distribution must contain
43: // the intact and unchanged copyright notice.
44: // Contributions and changes to the program code must be marked as such.
45:
46: package de.anomic.kelondro;
47:
48: import java.util.Comparator;
49:
50: public interface kelondroOrder<A> extends Comparator<A> {
51:
52: public boolean wellformed(A a); // returns true if and only if a has only characters that belong to the implemented order
53:
54: public kelondroOrder<A> clone();
55:
56: public void direction(boolean ascending); // the ordering direction can be changed at any time
57:
58: public String signature(); // returns a signature String so that different orderings have different signatures
59:
60: public long partition(A key, int forkes);
61:
62: public long cardinal(A key); // returns a cardinal number in the range of 0 .. Long.MAX_VALUE
63:
64: public int compare(A a, A b);
65:
66: public A zero(); // returns the zero point of the Ordering; null if not defined
67:
68: public void rotate(A zero); // defines that the ordering rotates, and sets the zero point for the rotation
69:
70: public boolean equals(kelondroOrder<A> o); // used to compare different order objects; they may define the same ordering
71: }
|