Коллекции-множества (Set)

  public HashSet()

    Строит пустое множество

  public HashSet(Collection c)

    Строит множество из элементов коллекции
     

  public Iterator iterator()

  public int size()

  public boolean isEmpty()

  public boolean contains(Object o)

  public boolean add(Object o)

  public boolean addAll(Collection c)

  public Object[] toArray()

  public boolean remove(Object o)

  public boolean removeAll(Collection c)

  public boolean retainAll(Collection c)

    (retain — сохранить). Выполняет операцию "пересечение множеств".

 
  public void clear()

  public Object clone()
     

  public TreeSet()

  public TreeSet(Collection c)
     

  public TreeSet(Comparator c)
     

  public SortedSet subSet(Object fromElement, Object toElement)
  
    Здесь SortedSet — интерфейс "упорядоченное множество". Метод возвращает 
    подмножество в заданном интервале объектов (toElement не входит в это 
    подмножество). Результирующее множество обладает тем свойством, что в 
    него нельзя включить элемент вне заданного интервала (выдает 
    IllegalArgumentException).


  public SortedSet headSet(Object toElement)

    Аналогично предыдущему, но с начала исходного множества — до
    элемента toElement, исключая его.


  public SortedSet tailSet(Object fromElement)
  
    Аналогично subset, но начиная с элемента fromElement до конца множества.
  

  public Object first()
  
    Первый элемент множества


  public Object last()
  
    Последний элемент множества
     

Разберемся с вопросом задания порядка на некотором множестве объектов.

Определение порядка на множестве не такой простой вопрос, если это понятие нужно поддерживать в программе. Обычно он решается путем задания функции сравнения. Т.е. для элементов какого-то множества задается функция, которая позволяет сравнить два элемента этого множества. В качестве результата такая функция возвращает целое число, которое меньше нуля, если первый элемент меньше второго, ноль, если они равны, и больше нуля, если первый элемент больше второго. Иными словами, для задания порядка нам нужно запрограммировать некоторую функцию, возвращающую логическую разность двух объектов множества.

Однако даже при таком подходе остается масса вариантов реализации данного принципа. В Java эта проблема решена стандартными средствами библиотеки языка, а именно — путем задания интерфейсов, используемых при задании порядка. При этом, Java позволяет сравнивать объекты как одного, так и разных классов.

Для задания порядка используются следующие интерфейсы: Comparable и Comparator. Они дают два различных способа задания порядка. Мы рассмотрим оба этих интерфейса, определим их назначение, разберем, как ими пользоваться и чем они отличаются друг от друга.

Интерфейс Comparable предназначен для определения так называемого естественного порядка ( natural ordering ). Этот интерфейс определен в пакете java.lang. Обратившись к документации мы увидим, что данный интерфейс содержит всего один метод.

public int compareTo(Object o)

Сравнивает объект с другим объектом.

Разберем пример. Пусть мы хотим задать порядок на множестве объектов класса A

public class A implements Comparable {

      String name;

      . . .

}
      

Причем, мы хотим сравнивать объекты по полю name в алфавитном порядке. Тогда мы задаем implements Comparable и определяем в классе метод

public int compareTo(Object obj) {
      return name.compareTo(((A)obj).name);
}
      

В результате класс A должен выглядеть так

public class A implements Comparable {

      String name;

  public int compareTo(Object obj) {
      return name.compareTo(((A)obj).name);
  }
  . . .
}
       

Как видно из данного примера задать нужный порядок не очень сложно. Разберем только, что же собственно здесь делается.

Метод compareTo(...) будет вызываться тогда, когда требуется сравнить два объекта. Он будет вызываться для некоторого объекта и в качестве параметра ему будет передан другой объект, который требуется сравнить с данным.

В нашем примере реализация метода compareTo(...) опирается на метод compareTo(...) класса String (поле name — класса String). Если мы обратимся к документации по методу compareTo(...) класса String, то увидим, что он сравнивает посимвольно две строки, пока не обнаружит два первых неодинаковых символа. В качестве результата он возвращает 0, если строки совпадают и разность кодов двух первых отличных друг от друга символов, если нет.

Возвращаясь к TreeSet, нужно указать, что все объекты, заносимые в TreeSet, должны удовлетворять интерфейсу Comparable. Исключение составляет случай использования конструктора

public TreeSet(Comparator c)

который мы рассмотрим позже. Если добавляемый объект не удовлетворяет интерфейсу, то возникнет exception.

Класс TreeSet организует сравнение элементов, используя compareTo(...) и расположит их в соответствии с заданным этим методом порядком.

Как было указано, Java позволяет сравнивать объекты различных классов. Рассмотрим для примера, как нужно переопределить метод compareTo(), чтобы он учитывал возможность сравнения как объектов класса A как друг с другом, так и с объектами некоторого класса B. Для этого метод compareTo(...) должен выглядеть примерно так

public int compareTo(Object obj) {
      if ( obj instanceof A )
          return name.compareTo(((A)obj).name);
      return ... здесь сравнение с объектом B
}
      

В свою очередь, в классе B, нужно указать, что он удовлетворяет интерфейсу Comparable и реализовать в нем метод compareTo(), который учитывает возможность сравнения B с A.

Итак, интерфейс Comparable дает нам возможность задавать порядок на множестве объектов одного или нескольких классов. Однако и этого не всегда хватает. Бывают случаи, когда в одной программе требуется иметь несколько различных вариантов порядка на одном и том же множестве. Например, если у нас есть список сотрудников, то нам может потребоваться порядок по фамилиям и порядок по табельным номерам. В этом случае интерфейс Comparable нас не спасает — он позволяет задать только один порядок.

В описанном случае вместо интерфейса Comparable следует использовать интерфейс Comparator.

Интерфейс Comparator .

Определен в пакете java.util. Работа с использованием Comparator отличается от того, что мы рассмотрели по интерфейсу Comparable. Здесь строится отдельный вспомогательный класс (будем называть его компаратор), используемый для сравнения объектов.

Обратимся к документации. Интерфейс Comparator имеет два метода

  public int compare(Object o1, Object o2)

    и

  public boolean equals(Object obj)
    

Второй из методов используется редко — он предназначен для сравнения самих компараторов. Более того, реализовывать данный метод необязательно.

Собственно сравнение объектов выполняет первый метод. Рассмотрим интерфейс Comparator на примере.

Пример

public class Employer {    // служащий
     int tabnom;        // табельный номер
     String name;      // ФИО
     static NameComparator nameComparator = new  NameComparator();
     static TabComparator tabComparator = new  TabComparator();

     public static Comparator getNameComparator() {
           return nameComparator;
     }

     public static Comparator getTabComparator() {
           return tabComparator;
     }

     static class NameComparator implements Comparator {

          public int compare(Object o1, Object o2) {
                return ((Employer)o1).name.compareTo(((Employer)o2).name);
          }
// метод equals() реализовывать не обязательно
     }

     static class TabComparator  implements Comparator {
          public int compare(Object o1, Object o2) {
                return ((Employer)o1).tabnom —  ((Employer)o2).tabnom;
          }
     }
   . . .
}
      

В классе Employer заданы два статических вложенных класса NameComparator и TabComparator, а также созданы объекты этих классов. Для получения конкретного компаратора созданы методы getNameComparator() и getTabComparator().

Имея такой класс, мы можем сравнивать объекты класса при помощи одного или другого компаратора. Например, рассмотрим, как построить TreeSet, упорядоченый по ФИО служащего.

TreeSet reestr = new TreeSet(Employer.getNameComparator());

Далее мы можем добавлять в reestr объекты класса Employer. Они будут автоматически упорядочиваться по ФИО.

На этом мы завершим рассмотрение множеств и рассмотрим практический пример использования множеств. Попутно углубим наши познания по изучению возможностей создания визуальных программ на Java.

Решим следующую задачу. Надо создать "Записную книжку" очень простой структуры. В нее заносится фамилия и список телефонов. Наше приложение будет очень простым и не будет "страдать от избытка функциональности", его внешний вид примерно следующий.

Здесь видны два поля ввода — для фамилии и списка телефонов, кнопка "Печатать" и поле для индикации количества записей в нашей книжке. Конечно, в таком приложении должны быть еще средства сохранения/восстановления информации, поиска и проч. Но это пока за рамками наших возможностей. Для этого нужно просто больше знать о Java.

Наше приложение должно работать так. При вводе информации во второе поле (Телефоны) информация (фамилия и телефон) будет запоминаться в некотором внутреннем хранилище программы, (мы будем для этого использовать TreeSet). При этом поле-индикатор количества записей изменяется, а поля ввода очищаются. При нажатии на кнопку "Печатать" весь накопленный нами список записей выводится на печать (в поток System.out) в некотором удобочитаемом формате.

Обратим внимание на внешний вид приложения.

• На экране явно видны две панели, причем с границами (border). Мы должны рассмотреть, как формировать границы панелей.
• Верхняя панель поделена на три горизонтальные части, в каждой из которых расположены различные визуальные компоненты (метки, поля и одна кнопка). Для формирования такого внешнего вида нужно познакомиться с менеджерами компоновки (Layout Manager). В частности, для нашего приложения понадобится менеджер GridLayout.

Разберем эти вопросы, прежде чем приступим к реализации.

Границы панелей.

JPanel pnl = new JPanel();
pnl.setBorder(BorderFactory.createEtchedBorder());
      

Менеджеры компоновки.

// PhoneNotes.java: Записная книжка

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;

public class PhoneNotes extends JFrame {

    JTextField fldFio = new JTextField(25);
    JTextField fldPhone = new JTextField(25);
    JTextField fldCnt = new JTextField(4);

    public PhoneNotes() {
     super("Записная книжка");

     try  {
       UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
     }
     catch(Exception e) {
     }

    setSize(400, 250);
    Container c = getContentPane();
// Центральная панель
    JPanel centerPanel = new JPanel(new GridLayout(3, 2, 5, 5));
    centerPanel.setBorder(BorderFactory.createEtchedBorder());
    JLabel aLabel = new JLabel("Фамилия ");
    centerPanel.add(aLabel);
    centerPanel.add(fldFio);
    aLabel = new JLabel("Телефон ");
    centerPanel.add(aLabel);
    centerPanel.add(fldPhone);
    JButton btn = new JButton("Печатать");
    centerPanel.add(btn);
    c.add(centerPanel, BorderLayout.CENTER);
// Нижняя панель
    JPanel statusPanel = new JPanel();
    statusPanel.setBorder(BorderFactory.createEtchedBorder());
    aLabel = new JLabel("Количество записей ");
    statusPanel.add(aLabel);
    fldCnt.setEnabled(false);
    statusPanel.add(fldCnt);
    c.add(statusPanel, BorderLayout.SOUTH);
// Listener'ы полей и кнопок
    fldPhone.addActionListener(new ActionListener(){
          public void actionPerformed(ActionEvent e) {
//   ???
          }
        });
    btn.addActionListener(new ActionListener(){
          public void actionPerformed(ActionEvent e) {
//   ???
          }
        });
    WindowListener wndCloser = new WindowAdapter() {
      public void windowClosing(WindowEvent e) {
        System.exit(0);
      }
    };
    addWindowListener(wndCloser);

    setVisible(true);
  }

  public static void main(String[] args) {
    new PhoneNotes();
  }
}
      

• 1. Улучшим внешний вид приложения. Изменим сетку с 3*2 на 3*1 и в каждую ячейку сетки добавим панель, а уже в эти панели будем добавлять метки, поля, кнопки.
• 2. Рассмотрим класс (бизнес класс) для хранения одной записи записной книжки. Это класс Person.

  // Person.java
  
  import java.io.*;
  
  public class Person implements Serializable {
  
      private String name;
      private String phone;
  
      Person(String name, String phone) {
          this.name = name;
          this.phone = phone;
      }
  
      Person() {
          this(null, null);
      }
  
      String getName() {
          return name;
      }
  
      String getPhone() {
          return phone;
      }
  
  }
          
  

  Этот класс предназначен для хранения информации по одной персоне.
• 3. В слушателе (listener) поля fldPhone реализуем создание объекта этого класса на основе информации из полей fldFio и fldPhone. Кроме того, реализуем очистку этих полей после создания данного объекта.
• 4. Добавим в класс PhoneNotes поле для коллекции записей (поле класса TreeSet) и реализуем занесение информации (объектов Person) в эту коллекцию.
• 5. В классе Person реализуем интерфейс Comparable, в частности, определим метод compareTo(...) для сравнения двух персон .
• 6. В классе Person определим также метод toString() для формирования строки из объекта. Используем этот метод для организации печати списка по кнопке "Печатать".