//
//  PPrimBase.java
//  Klimt
//
//  Created by Simon Urbanek on Wed Oct 29 2003.
//  Copyright (c) 2003 __MyCompanyName__. All rights reserved.
//

package org.rosuda.ibase.toolkit;

import java.awt.*;
import java.awt.event.*;
import java.util.*;

import org.rosuda.ibase.*;
import org.rosuda.pograss.*;
import org.rosuda.util.*;

/** Very basic plot primitive without any graphical representation, but with case handling. This abstract class can be used as a base for any plot primitives that use ID reference lists. Methods concerning graphical representation (paint..., contains, intersects) are left abstract.
*/
public abstract class PPrimBase implements PlotPrimitive {
    public Color col;
    
    /** references (IDs) to cases represented by this primitive */
    public int[] ref;

    public String toString() {
        return "PPrimBase["+cases()+" cases]";
    }

    public int[] getCaseIDs() { return ref; }
    public int getPrimaryCase() { return (ref==null||ref.length!=1)?-1:ref[0]; }
    public boolean representsCase(int cid) {
        if (ref==null || ref.length<1) return false;
        if (ref.length==1) return ref[0]==cid;
        int i=0;
        while (i<ref.length) { if (ref[i++]==cid) return true; };
        return false;
    }

    public int cases() { return (ref==null)?0:ref.length; }
    
    /** sets mark for cases represented by this PlotPrimitive in following fashion: if the case is already marked then its mark is set to setTo, otherwise the mark is set to true. */
    public void setMark(SMarker m, boolean setTo) {
        if (ref!=null) {
            int j=0, pts=ref.length;
            while (j<pts) {
                m.set(ref[j],m.at(ref[j])?setTo:true);
                j++;
            }
        }
    }

    /** calculates the proportion of cases with the given mark in relation to total population of cases represented by this PlotPrimitive. The value ranges between 0.0 (no cases with such mark) to 1.0 (all cases with that mark) */
    public double getMarkedProportion(SMarker m, int mark) {
        Stopwatch sw=new Stopwatch();
        if (ref!=null && m!=null) {
            int j=0, pts=ref.length;
            if (pts==0) return 0d;
            int sc=0;
            while (j<pts) {
                if (m.get(ref[j])==mark) sc++;
                j++;
            }
            sw.profile("PlotPrimitive.getMarkedProportion");
            return ((double)sc)/((double)pts);
        }
        return 0d;
    }

    /** returns the main color of the primitive */
    public Color getColor() { return col; }
}