/FileExtraction/Java_unseen/rubato-composer_rubato-composer/java/src/org/rubato/math/module/NumberRing.java
/*
 * Copyright (C) 2001, 2005 Gérard Milmeister
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */

package org.rubato.math.module;

/**
 * Subclasses of this abstract class are the rings of integers,
 * rationals, reals and complex numbers. They are ordered in
 * the way just given.
 * 
 * @author Gérard Milmeister
 */
public abstract class NumberRing extends Ring {

    public int compareTo(Module object) {
        if (object instanceof NumberRing) {
            return compareTo((NumberRing)object); 
        }
        else if (object instanceof ZnRing) {
            return 1; 
        }
        else {
            return super.compareTo(object);
        }
    }
    
    /**
     * Compares this number ring with the number ring <code>r</code>.
     */
    public int compareTo(NumberRing r) {
        return getNumberRingOrder()-r.getNumberRingOrder();
    }

    /**
     * Returns a number that indicates the position in
     * the order of rings.
     */
    protected abstract int getNumberRingOrder();
}
