edit

Class Find

java.lang.Object

edit.Find

public abstract class Find
extends java.lang.Object

The Find class is responsible for managing the Find operation.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Gradebook	gradebook The currently open Gradebook.

Constructor Summary

Constructors

Constructor and Description
Find()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) abstract java.util.Collection<Assignment>	findAssignments(java.lang.String name, java.lang.String courseName) Finds the Assignment associated with the given name and course.
(package private) abstract java.util.Collection<Student>	findStudents(java.lang.String name, java.lang.String courseName) Finds the Student associated with the given name and course.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gradebook

Gradebook gradebook

The currently open Gradebook.

Constructor Detail

Find

public Find()

Method Detail

findStudents

abstract java.util.Collection<Student> findStudents(java.lang.String name,
                                         java.lang.String courseName)

Finds the Student associated with the given name and course. If courseName is null, the search is performed on all courses.

Parameters:

name - student name

courseName - name of course to search in

Returns:

collection of students fitting criteria

    pre:
      //
      // The selected Course must either be null or exist in the gradebook.
      //
      courseName == null ||
      exists (Course course; gradebook.courses.contains(course);
              course.name == courseName);

    post:
      //
      // Any students in the returned collection must fit the criteria.
      // Their name must contain the search patterns, and they must be
      // contained in a section within the selected course.
      //
      forall (Student student; return.contains(student);
              exists (Course course; gradebook.courses.contains(course) &&
                            if (courseName != null) course.name == courseName;
                      exists (Section section; course.sections.contains(section);
                              exists (Student student; section.students.contains(student);
                                      student.name.contains(name)))))

findAssignments

abstract java.util.Collection<Assignment> findAssignments(java.lang.String name,
                                               java.lang.String courseName)

Finds the Assignment associated with the given name and course. If courseName is null, the search is performed on all courses.

Parameters:

name - assignment name

courseName - name of course to search in

Returns:

collection of assignments matching the criteria

    pre:
      //
      // The selected Course must either be null or exist in the gradebook.
      //
      courseName == null ||
      exists (Course course; gradebook.courses.contains(course);
              course.name == courseName);

    post:
      //
      // Any Assignments in the returned collection must fit the criteria.
      // Their name must contain the search patterns, and they must be
      // contained in a section within the selected course.
      //
      forall (Assignment assignment; return.contains(assignment);
              exists (Course course; gradebook.courses.contains(course) &&
                            if (courseName != null) course.name == courseName;
                      exists (Assignment assignment; course.assignments.contains(assignment);
                              assignment.name.contains(name))));