fuzzysystem.java

A Java class representation of a fuzzy cognitive map which contains a set of factors and relationsh

/*

Fuzzy Cognitive Map
Copyright (c) 2001, Guillermo Ochoa de Aspuru

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

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.
http://www.gnu.org

================================================

Author: Guillermo Ochoa de Aspuru
        http://www.ochoadeaspuru.com
        [e-mail]

================================================

Change Log:

Date          Version        Who
25 Nov 2001 - 0.0            G. Ochoa de Aspuru
Created

*/

import java.util.*;

/**
This class represents a fuzzy system (also know as a fuzzy cognitive
map). The fuzzy system contains a set of factors and relationships 
between them.
@author Guillermo Ochoa de Aspuru
*/
public class FuzzySystem {

	// Vector of Factor. The factors of this fuzzy map.
	private Vector factorCollection;
	// The name of this fuzzy system
	private String systemName;
	
	/** 
	Default constructor.
	*/
	FuzzySystem()
	{
		this("");
	}
	
	/**
	Constructor.
	@param n the name of this fuzzy system.
	*/
	FuzzySystem(final String n)
	{
		systemName = n;
		factorCollection = new Vector();
	}
	
	/**
	Returns the name of this fuzzy system.
	@return the name of this fuzzy map.
	*/
	public String getName()
	{
		return systemName;
	}
	
	/**
	Sets the name of this fuzzy system.
	@param n the name for this fuzzy system.
	*/
	public void setName(final String n)
	{
		systemName = n;
	}
	
	/**
	Returns the number of factors of this fuzzy system.
	@return the number of factors.
	*/
	public int getNumberOfFactors()
	{
		return factorCollection.size();
	}
	
	/**
	Returns a reference to one of the factors of this
	fuzzy system.
	@param index the index of the factor required (zero based).
	@return the factor of this fuzzy system at the required position.
	*/
	public Factor getFactorByIndex(int index)
	{
		return (Factor)(factorCollection.elementAt(index));
	}
	
	/**
	Returns the collection of factors of this fuzzy map.
	@return a <code>Vector</code> of <code>Factor</code> objects.
	*/
	public Vector getFactors()
	{
		return factorCollection;
	}
	
	/**
	Sets the collection of factors of this fuzzy map.
	@param a <code>Vector</code> of <code>Factor</code> objects.
	*/
	public void setFactors(Vector f)
	{
		factorCollection = f;
	}
	
	/**
	Adds a factor to this fuzzy system.
	@param a <code>Factor</code> object to be added to this
	fuzzy map.
	*/
	public void addFactor(Factor f)
	{
		factorCollection.addElement(f);
	}
	
	/**
	Removes the factor of this system at the indicated position.
	@param index the position of the factor to be removed (zero based).
	*/
	public void removeFactorByIndex(int index)
	{
		// Get the factor to be removed
		Factor removedFactor = (Factor)(factorCollection.elementAt(index));
			
		// Remove the factor from the collection of factors
		factorCollection.removeElementAt(index);
			
		// Loop over the remaining factors of the collection of factors
		// and remove the factor as a cause
		for (int j = 0; j < factorCollection.size(); ++j) {
			((Factor)(factorCollection.elementAt(j))).removeCause(removedFactor);
		}
	}
	
	/**
	Removes all the factors of this fuzzy system.
	*/
	public void removeAllFactors()
	{
		factorCollection.removeAllElements();
	}

}