/* -*- c-basic-offset: 2; indent-tabs-mode: nil; -*- */
/*
 * FreeDots -- MusicXML to braille music transcription
 *
 * Copyright 2008-2010 Mario Lang  All Rights Reserved.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details (a copy is included in the LICENSE.txt file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This file is maintained by Mario Lang <mlang@delysid.org>.
 */
package freedots.music;

import java.util.Comparator;

/** A chord limited to notes belonging to a particular voice.
 * <p>
 * In our current model, a chord belongs to a part and can potentially
 * span across staves and individual voices.  This is a property we inherited
 * from the structure of MusicXML documents.
 * <p>
 * However, in braille music a chord generally only belongs to a particular
 * voice because vertical alignment of several staves or voices is usually
 * not possible.
 */
@SuppressWarnings("serial")
public final class
VoiceChord extends AbstractChord<RhythmicElement> implements VoiceElement {
  private int staffNumber;
  private Staff staff = null;
  private String voiceName;

  public VoiceChord(final RhythmicElement initialNote) {
    super(initialNote);
    this.staffNumber = initialNote.getStaffNumber();
    this.voiceName = initialNote.getVoiceName();
    setStaff(initialNote.getStaff());
  }

  public Staff getStaff() { return staff; }
  public void setStaff(Staff staff) { this.staff = staff; }
  public int getStaffNumber() { return staffNumber; }

  /* FIXME: Seems inappropriate to have to impelement this */
  public boolean isRest() { return false; }

  public String getVoiceName() { return voiceName; }
  public void setVoiceName(String voiceName) {
    this.voiceName = voiceName;
    for (VoiceElement element:this) { element.setVoiceName(voiceName); }
  }

  public static class AscendingComparator implements Comparator<RhythmicElement> {
    public int compare(RhythmicElement n1, RhythmicElement n2) {
      AbstractPitch p1 = n1.getPitch();
      if (p1 == null) p1 = n1.getUnpitched();
      AbstractPitch p2 = n2.getPitch();
      if (p2 == null) p2 = n2.getUnpitched();
      return p1.compareTo(p2);
    }
  }
  public static class DescendingComparator implements Comparator<RhythmicElement> {
    public int compare(RhythmicElement n1, RhythmicElement n2) {
      AbstractPitch p1 = n1.getPitch();
      if (p1 == null) p1 = n1.getUnpitched();
      AbstractPitch p2 = n2.getPitch();
      if (p2 == null) p2 = n2.getUnpitched();

      return p2.compareTo(p1);
    }
  }
}