Overriding compareTo method in order to sort objects by String values

Adam Staples picture Adam Staples · Jul 7, 2014 · Viewed 18.2k times · Source

I have a class that implements the Comparable interface. In this class I need to override compareTo method in order to sort objects by String values.

If you scroll down to the bottom I'm attempting to make my method & I need to in the main method sort an array of Courses (using the compareTo method I'm making) by first Department type and then by course number, etc. but this requires comparing 2 strings.

   import java.io.Serializable;
   import java.io.*;
   import java.util.*;
public class Course implements Comparable<Course>, Serializable  {
private String prefix;
private int number;
private String Department;
private String grade;
/**
 * Constructs the course with the specified information.
 * 
 * @param prefix the prefix of the course designation
 * @param number the number of the course designation
 * @param Department the Department of the course
 * @param grade the grade received for the course
 */
public Course(String prefix, int number, String Department, String grade)
{
    this.prefix = prefix;
    this.number = number;
    this.Department = Department;
    if (grade == null)
        this.grade = "";
    else
        this.grade = grade;
}

/**
 * Constructs the course with the specified information, with no grade
 * established.
 * 
 * @param prefix the prefix of the course designation
 * @param number the number of the course designation
 * @param Department the Department of the course
 */
public Course(String prefix, int number, String Department)
{
    this(prefix, number, Department, "");
}

public String getPrefix()
{
    return prefix;
}

/**
 * Returns the number of the course designation.
 * 
 * @return the number of the course designation
 */
public int getNumber()
{
    return number;
}

/**
 * Returns the Department of this course.
 * 
 * @return the prefix of the course
 */
public String getDepartment()
{
    return Department;
}
/**
 * Returns the grade for this course.
 * 
 * @return the grade for this course
 */
public String getGrade()
{
    return grade;
}

/**
 * Sets the grade for this course to the one specified.
 * 
 * @param grade the new grade for the course
 */
public void setGrade(String grade)
{
    this.grade = grade;
}

/**
 * Returns true if this course has been taken (if a grade has been received).
 * 
 * @return true if this course has been taken and false otherwise
 */
public boolean taken()
{
    return !grade.equals("");
}

 * Determines if this course is equal to the one specified, based on the
 * course designation (prefix and number).
 * 
 * @return true if this course is equal to the parameter
 */
public boolean equals(Object other)
{
    boolean result = false;
    if (other instanceof Course)
    {
        Course otherCourse = (Course) other;
        if (prefix.equals(otherCourse.getPrefix()) &&
                number == otherCourse.getNumber())
            result = true;
    }
    return result;
}

The compareTo function:

public int compareTo(Course o)
{
    if(getDepartment().equals(o.getDepartment()))
    {
        return 0;
    }
    else if()
    {
        return -1;
    }
    else
    {
        return 1;
    } 
}   

/**
 * Creates and returns a string representation of this course.
 * 
 * @return a string representation of the course
 */
public String toString()
{
    String result = prefix + " " + number + ": " + Department;
    if (!grade.equals(""))
        result += "  [" + grade + "]";
    return result;
    }
}

Main class thus far:

import java.util.*;
import java.lang.*;
import java.math.*;
import java.io.*;
import java.*;


public class StackCourse 
{

 public static void main(String[] args) 
    {
        Course a = new Course("EEE", 230, "Engineering");
        Course b = new Course("MAT", 150, "Liberal Arts");
        Course c = new Course("PHY", 150, "Liberal Arts");
        Course d = new Course("PHI", 304, "Liberal Arts");
        Course e = new Course("ECN", 214, "W.P. Carey");
        Course f = new Course("EEE", 120, "Engineering");


        Course[] courses = {a,b,c,d,e,f};
        for(int i=0; i<courses.length; i++)
        System.out.println(courses[i].getDepartment());       
    }
}

Answer

Maheedhar Pamuru picture Maheedhar Pamuru · Jul 7, 2014
public int compareTo(Course o)
{
    if(getDepartment().compareTo(o.getDepartment()) ==0){
        if(getNumber() < o.getNumber()) return -1;
        else if(getNumber() > o.getNumber()) return 1;
        else return 0;
    }

    return getDepartment().compareTo(o.getDepartment());

}  

Output:

EEE 120: Engineering EEE 230: Engineering MAT 150: Liberal Arts PHY 150: Liberal Arts PHI 304: Liberal Arts ECN 214: W.P. Carey