Section 9.9. Object-Oriented Design: Polymorphic Sorting (Optional)

[Page 439 (continued)]

9.9. Object-Oriented Design: Polymorphic Sorting (Optional)

One limitation of the sort routines developed so far is that they only work on one particular type of data. If you've written an insertion sort to sort ints, you can't use it to sort doubles. What would be far more desirable is a polymorphic sort methodone method that could sort any kind of data. This is easily done by making use of Java wrapper classes, such as Integer and Double, together with the java.lang.Comparable interface, which is specially designed for this purpose.

The java.lang.Comparable interface consists of the compareTo() method:

public abstract interface Comparable {   public int compareTo(Object o);   // Abstract method } 

By implementing compareTo(), a class can impose an order on its objects. The Comparable interface is implemented by all of Java's wrapper classesthat is, by Integer, Double, Float, Long, and so on (Fig. 9.24).

Figure 9.24. Java wrapper classes, such as Integer and Double, implement the Comparable interface. (This item is displayed on page 440 in the print version)

As we saw in Chapter 8, Java interfaces allow us to create a form of multiple inheritance. For example, as Figure 9.24 shows, an Integer is both an Object and a Comparable. One implication of this is that an Integer can be used in any method that takes either an Object parameter or a Comparable parameter.

The compareTo() method takes an Object parameter and returns an int. It is meant to be invoked as o1.compareTo(o2), where o1 and o2 are objects of the same type. Classes that implement compareTo() must abide by the following rules for its return value:

if (o1 < o2)        then o1.compareTo(o2) < 0 if (o1.equals(o2))  then o1.compareTo(o2) == 0 if (o1 > o2)        then o1.compareTo(o2) > 0 

---

[Page 440]

In other words, if o1 < o2, then o1.compareTo(o2) will return a negative integer. If o1 > o2, then o1.compareTo(o2) will return a positive integer. And if o1 and o2 are equal, then o1.compareTo(o2) will return 0.

For a class that implements Comparable, we can use the compareTo() method to help sort its elements. For example, the following revised version of the insertionSort() method can be used to sort any array of Comparable objectsthat is, any array of objects whose class implements Comparable:

public void sort(Comparable[] arr) {   Comparable temp;                            // Temporary variable for insertion   for (int k = 1; k < arr.length; k++)  {     temp = arr[k];                            // Remove it from array     int i;     for (i = k-1; i >= 0 && arr[i].compareTo(temp) > 0; i--)       arr[i+1] = arr[i];                      // Move it right by one     arr[i+1] = temp;                          // Insert the element   } } // sort() 

In this version, the parameter is an array of Comparable. Thus, we can pass it any array whose elements implement Comparable, including an array of Integer or Float, and so on. Then, to compare elements of a Comparable array, we use the compareTo() method:

for (i = k-1; i >= 0 && arr[i].compareTo(temp) > 0; i--) 

---

[Page 441]

Note that our algorithm no longer refers to ints, as in the original insertion sort. Indeed, it doesn't mention the specific typeInteger, Float, or whateverof the objects it is sorting. It refers only to Comparables. Therefore, we can use this method to sort any type of object, as long as the object's class implements the Comparable interface. Thus, by using Comparable, we have a more general insertionSort() method, one that can sort any one-dimensional array of Comparables.

The TestSort class (Figs. 9.25 and 9.26) provides an example of how to use the polymorphic sort() method. It contains three methods: The sort() method that we just described; a polymorphic print() method, which can be used to print the values of any array of Comparable; and a main() method. The main() method creates arrays of Integer and Float and then uses the polymorphic sort() method to sort them. Note how the print() method uses the polymorphic toString() method to print the elements of a Comparable array.

---

[Page 442]

Figure 9.25. The TestSort() class. (This item is displayed on page 441 in the print version)

Figure 9.26. TestSort uses the polymorphic sort() method to sort either Integers or Floats. (This item is displayed on page 441 in the print version)

public class TestSort {   public static int MAXSIZE = 25;   public void sort(Comparable[] arr) {     Comparable temp;                          // Temporary variable for insertion     for (int k = 1; k < arr.length; k++) { // For each element       temp = arr[k];                     // Remove it       int i;       for (i = k-1; i >= 0 && arr[i].compareTo(temp) > 0; i--)         arr[i+1] = arr[i];                    // Move larger to the right       arr[i+1] = temp;                        // Insert the element     }   } // sort()   public void print(Comparable arr[]) {     for (int k = 0; k < arr.length; k++) {       if (k % 5 == 0)  System.out.println();  // New row         System.out.print(arr[k].toString() + "\t");     }     System.out.println();   }   // Sorts two different types of array with the same method.   public static void main(String args[]) {     Integer iArr[] = new Integer[TestSort.MAXSIZE];     Float fArr[] = new Float[TestSort.MAXSIZE];     for (int k = 0; k < TestSort.MAXSIZE; k++) { // Create data       iArr[k] = new Integer((int) (Math.random() * 10000));       fArr[k] = new  Float(Math.random() * 10000);     }     TestSort test = new TestSort();     test.sort(iArr);                          // Sort and print Integers     test.print(iArr);     test.sort(fArr);                          // Sort and print Floats     test.print(fArr);   } // main() } // TestSort class 

This example of polymorphic sorting illustrates once again the great power of inheritance and polymorphism in object-oriented programming. The Integer and Float classes use class inheritance to inherit features from the Object class, and they use interface implementation to inherit the compareTo() method from the Comparable class. By implementing versions of the toString() and compareTo() methods that are appropriate for these wrapper classes, Java makes it easier to use Integer and Float objects in a variety of contexts. Taken together, inheritance and polymorphism enable us to design very general and extensible algorithms. In this example, we have defined a sort() method that can sort an array containing any kind of object as long as the object implements the Comparable interface.

9.9.1. The java.util.Arrays.sort() Method

While sorting algorithms provide a good way to introduce the concepts of array processing, real-world programmers never write their own sort algorithms. Instead they use library methods written and optimized by programming experts. Library sort routines use sort algorithms that are much more efficient than the ones we have discussed.

The java.util.Arrays class contains a polymorphic sort method that is very simple to use. For example, here is how we would use it to sort the two arrays declared in the TestSort program:

java.util.Arrays.sort(iArr); java.util.Arrays.sort(fArr); 

That's all there is to it! Obviously, learning how to use Java's class and method library saves real-world programmers lots of effort.

Self-Study Exercises

Exercise 9.20	Add a definition of a compareTo() method to the LetterFreq class so that it implements the Comparable interface. The method should define one object to be less than another object if its freq instance variable is less.
Exercise 9.21	Add a definition of a sort() method that can be added to the definition of the AnalyzeFreq class. Make it so that the array in the class can be sorted into ascending order using the ordering of LetterFreq defined in the preceding exercise. Use the java.util.Arrays.sort() method.
Exercise 9.22	Rewrite the main() of the AnalyzeFreq class to make use of the sort() method from the preceding exercise.