/*
  * Copyright 2007 Sun Microsystems, Inc.  All Rights Reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun in the LICENSE file that accompanied this code.
  *
  * 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
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */ 

package com.sun.media.sound;

/**
 * 
 * This class stores the identity of source and destinations in connection blocks, see ModelConnectionBlock.
 * 
 * @version %I%, %E%
 * @author Karl Helgason
 */ 
public class ModelIdentifier {
	
/*
 *  Object    Variable
 *  ------    --------
 *  
 *  // INPUT parameters
 *  noteon    keynumber                7 bit midi value
 *            velocity                 7 bit midi vale
 *            on                       1 or 0
 *            
 *  midi      pitch                    14 bit midi value
 *            channel_pressure         7 bit midi value
 *            poly_pressure            7 bit midi value
 *  
 *  midi_cc   0 (midi control #0       7 bit midi value
 *            1 (midi control #1       7 bit midi value
 *            ...
 *            127 (midi control #127   7 bit midi value
 *            
 *  midi_rpn  0 (midi rpn control #0)  14 bit midi value
 *            1 (midi rpn control #1)  14 bit midi value
 *            ....
 *  
 *  // DAHDSR envelope generator
 *  eg        (null)
 *            delay                    timecent
 *            attack                   timecent
 *            hold                     timecent
 *            decay                    timecent
 *            sustain                  0.1 %
 *            release                  timecent
 * 
 *  // Low frequency oscillirator (sine wave)
 *  lfo       (null)
 *            delay                    timcent
 *            freq                     cent
 *             
 *  // Resonance LowPass Filter 6dB slope
 *  filter    (null) (output/input)
 *            freq                     cent
 *            q                        cB
 *            
 *  // The oscillator with preloaded wavetable data           
 *  osc       (null)
 *            pitch                    cent
 *            
 *  // Output mixer pins
 *  mixer     gain                     cB
 *            pan                      0.1 %  
 *            reverb                   0.1 %
 *            chorus                   0.1 %
 *            
 */	
	

	private String object = null;
	private String variable = null;
	private int instance = 0;
	
	public ModelIdentifier(String object)
	{
		this.object = object;
	}
	public ModelIdentifier(String object, int instance)
	{
		this.object = object;
		this.instance = instance;
	}	
	public ModelIdentifier(String object, String variable)
	{
		this.object = object;
		this.variable = variable;
		
	}
	public ModelIdentifier(String object, String variable, int instance)
	{
		this.object = object;
		this.variable = variable;
		this.instance = instance;

	}
	
	public int getInstance() {
		return instance;
	}
	public void setInstance(int instance) {
		this.instance = instance;
	}
	public String getObject() {
		return object;
	}
	public void setObject(String object) {
		this.object = object;
	}
	public String getVariable() {
		return variable;
	}
	public void setVariable(String variable) {
		this.variable = variable;
	}
	
	
	public boolean equals(Object obj) {
		if(!(obj instanceof ModelIdentifier)) return false;
		ModelIdentifier mobj = (ModelIdentifier)obj;
		if((object == null) != (mobj.object == null)) return false;
		if((variable == null) != (mobj.variable == null)) return false;
		if(mobj.getInstance() != getInstance()) return false;
		if(!(object == null || object.equals(mobj.object))) return false;
		if(!(variable == null || variable.equals(mobj.variable))) return false;
		return true;
		
	}
	public String toString()
	{
		if(variable == null) return object+"[" + instance + "]"; else return object + "[" + instance + "]" + "." + variable;
	}
}