exfex-cvs-commit Mailing List for Extended Form of examination (Page 12)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/exfex/exfex/source/exfex/common/pluginsystem
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9548/source/exfex/common/pluginsystem

Modified Files:
	DependencyMap.java 
Log Message:
cloneable and new methods getSources, getDepended

Index: DependencyMap.java
===================================================================
RCS file: /cvsroot/exfex/exfex/source/exfex/common/pluginsystem/DependencyMap.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** DependencyMap.java	15 Sep 2005 18:11:02 -0000	1.9
--- DependencyMap.java	18 Sep 2005 18:51:32 -0000	1.10
***************
*** 3,6 ****
--- 3,9 ----
   *
   * $Log$
+  * Revision 1.10  2005/09/18 18:51:32  mstsxfx
+  * cloneable and new methods getSources, getDepended
+  *
   * Revision 1.9  2005/09/15 18:11:02  mstsxfx
   * documentation corrected
***************
*** 19,24 ****
  package exfex.common.pluginsystem;

! import java.util.*;
! import exfex.common.logging.*;

  /** Source of dependency class.
--- 22,34 ----
  package exfex.common.pluginsystem;

! import java.util.Enumeration;
! import java.util.Hashtable;
! import java.util.LinkedList;
! import java.util.List;
! import java.util.Map;
! import java.util.Set;
! 
! import exfex.common.logging.ILogger;
! import exfex.common.logging.LogManager;

  /** Source of dependency class.
***************
*** 40,43 ****
--- 50,58 ----
   * plugins (can be found in DependencyMap) should be considered for purging, 
   * because it was last implementator of this type and.
+  * <br>
+  * If you need to get list of all implementators, call getImplementators method.
+  * <br>
+  * Class is clonebale, so if you need to obtain deep copy of the map, use
+  * clone method.
   * <p>
   * NOTE: Class is not synchronized, so it can be used only from synchronized
***************
*** 46,52 ****
   * <pre>
   * 
-  * TODO use loggmanager
-  * 
   * Changes:
   * 6.8.2005	msts - created
   * </pre>
--- 61,66 ----
   * <pre>
   * 
   * Changes:
+  * 18.9.2005	msts - cloneable implementation
   * 6.8.2005	msts - created
   * </pre>
***************
*** 54,58 ****
   * @author msts
   */
! class DependencySource
  {
  	/** List of implementators.
--- 68,72 ----
   * @author msts
   */
! class DependencySource implements Cloneable
  {
  	/** List of implementators.
***************
*** 87,90 ****
--- 101,118 ----
  	}

+ 	/** Initializating constructor.
+ 	 * 
+ 	 *  Sets fields values from parameters (uses shallow copy). Caller 
+ 	 *  should set parameters to cloned versions if needs deep copy.
+ 	 *  
+ 	 * @param source Source of dependency type plugin.
+ 	 * @param implList List of implementators.
+ 	 */
+ 	protected DependencySource(IPlugin source, PluginList implList)
+ 	{
+ 		this.source=source;
+ 		this.implList=implList;
+ 	}
+ 	
  	/** Insert implementator to the DependencySource.
  	 *
***************
*** 174,178 ****
  	public boolean compatible(IPlugin plg)//{{{
  	{
! 		if(PluginList.isCompatible(source,plg))
  			return true;
  		return false;
--- 202,206 ----
  	public boolean compatible(IPlugin plg)//{{{
  	{
! 		if(PluginList.areCompatibles(source,plg))
  			return true;
  		return false;
***************
*** 194,197 ****
--- 222,239 ----
  	}

+ 	/** Returns list of all Implementators.
+ 	 * 
+ 	 * Calls implList.toList method to get list of implementators. This
+ 	 * cause, that client can change list with no effect to the internal
+ 	 * list.
+ 	 * 
+ 	 * @see PluginList#toList
+ 	 * @return List of plugins that are source of dependency.
+ 	 */
+ 	public List<IPlugin> getImplementators()//{{{
+ 	{
+ 		return implList.toList();
+ 	}//}}}
+ 	
  	/** Find out if plugin is in this DependencySource.
  	 * 
***************
*** 208,213 ****
--- 250,276 ----
  		return implList.searchExact(plugin)==null ? false : true;
  	}
+ 	
+ 	@Override public String toString()
+ 	{
+ 		return new String("Dependency Source{"+implList.toString()+"}");
+ 	}
+ 
+ 	/** Deep copy maker.
+ 	 * Creates deep copy of this object. Source field is copied as referency
+ 	 * because it can be shared (we don't want to create more instances of
+ 	 * one plugin). Implementation list is deep copied (uses PluginList 
+ 	 * clone method).
+ 	 * 
+ 	 * @return New instance of DependencySource class.
+ 	 */
+ 	@Override public Object clone()
+ 	{
+ 		// creates new DependencySource object and calls its protected
+ 		// constructor with shallow source and deep implList copies.
+ 		return new DependencySource(source, (PluginList)implList.clone());
+ 	}
  }

+ 
  /** Class to keep dependency relations.
   *
***************
*** 243,253 ****
   * (whith the same type and name) use changeImplementator method. This can be
   * used for example when conflicting plugin replaced and old plugin.
!  * <li>TODO: If you, for any reason, need to find out dependencies (sources of 
!  * dependecies) of given plugin, use getDependencies method.
!  * <li>On the other hand, if you need all depended plugins on given one, use
!  * getDepended method.
   * </ul>
!  * NOTE: This class is not synchronized, so it should be called from
!  * safe (or synchronized) environment.
   *
   * @see exfex.common.pluginsystem.DependencySource
--- 306,316 ----
   * (whith the same type and name) use changeImplementator method. This can be
   * used for example when conflicting plugin replaced and old plugin.
!  * <li>if you need all depended plugins on given one, use getDepended method.
!  * <li>if you need to get all dependency sources, call getSources method.
!  * <li>Class is clonebale, so if you need to obtain deep copy of the map, use
!  * clone method.
   * </ul>
!  * NOTE: This class is not synchronized, so it should be called from  safe 
!  * (or synchronized) environment.
   *
   * @see exfex.common.pluginsystem.DependencySource
***************
*** 259,263 ****
   * 
   * Changes:
!  * 9.8.2005	msts - created
   * </pre>
   */
--- 322,332 ----
   * 
   * Changes:
!  * 
!  * TODO: serialization
!  * 
!  * 18.9.2005	msts - 	cloneable implementation
!  * 			consolidation method for plugin conflict handling
!  * 			getSources and getDepended methods add
!  * 9.8.2005	msts - 	created
   * </pre>
   */
***************
*** 272,280 ****
  		// Creates map with initial capacity 100 
  		// TODO get value from setting
! 		map=new Hashtable<DependencySource, PluginList>(100);
  	}

  	/** Creates dependency relation.
  	 * 
  	 * Two situation can happen in this method:
  	 * <ul>
--- 341,379 ----
  		// Creates map with initial capacity 100 
  		// TODO get value from setting
! 		map=new Hashtable<DependencySource, PluginList>(100)
! 		{
! 			static final private long serialVersionUID = 1L;
! 			
! 			/** Creates deep copy of the map. */
! 			@Override public Object clone()
! 			{
! 				// clone each key, vlaue pair from table
! 				// uses clone method for both key and value
! 				Hashtable<DependencySource, PluginList> result=new Hashtable<DependencySource, PluginList>();
! 				Set<Map.Entry<DependencySource, PluginList>> pairs=this.entrySet();
! 				for(Map.Entry<DependencySource, PluginList> e : pairs)
! 					result.put((DependencySource)e.getKey().clone(),(PluginList)e.getValue().clone());
! 				
! 				return (Object)result;
! 			}
! 		};
! 	}
! 	
! 	/** Initialization constructor.
! 	 * 
! 	 * Sets mao field to the given parameter (uses shallow copy). Caller 
! 	 *  should set parameters to cloned versions if needs deep copy.
! 	 * 
! 	 * @param map Map to use to initialide map field. 
! 	 */
! 	protected DependencyMap(Hashtable<DependencySource, PluginList> map)
! 	{
! 		this.map=map;
  	}

  	/** Creates dependency relation.
  	 * 
+ 	 * Inserts pair (source, depended) to the map.
+ 	 * <p>
  	 * Two situation can happen in this method:
  	 * <ul>
***************
*** 282,296 ****
  	 * source plugin has never been add to the map. So we create
  	 * new DependencySource object from source plugin and linked list
! 	 * with one member depended. This is initialization of dependency
  	 * relation.
  	 * <li>
! 	 * there already exist DependencySource object compatible with source 
  	 * plugin. We will call DependencySource.put on it and append it's 
! 	 * dependency list (value in map) with depended 
  	 * </ul>
  	 *
  	 * @param source Source of the dependency.
  	 * @param depended Depended plugin on source.
- 	 * @see DependencySource#put
  	 */
  	public void addDependency(IPlugin source, IPlugin depended)//{{{
--- 381,397 ----
  	 * source plugin has never been add to the map. So we create
  	 * new DependencySource object from source plugin and linked list
! 	 * with one depended member. This is initialization of dependency
  	 * relation.
  	 * <li>
! 	 * there already exists DependencySource object compatible with source 
  	 * plugin. We will call DependencySource.put on it and append it's 
! 	 * dependency list (value in map) with depended (using addPlugin method
! 	 * with overwrite flag set to true)
  	 * </ul>
  	 *
+ 	 * @see DependencySource#put
+ 	 * @see PluginList#addPlugin(IPlugin, boolean)
  	 * @param source Source of the dependency.
  	 * @param depended Depended plugin on source.
  	 */
  	public void addDependency(IPlugin source, IPlugin depended)//{{{
***************
*** 310,314 ****
  				PluginList deplist=map.get(element);
  				element.put(source);
! 				deplist.addPlugin(depended);
  				return;
  			}
--- 411,415 ----
  				PluginList deplist=map.get(element);
  				element.put(source);
! 				deplist.addPlugin(depended,true);
  				return;
  			}
***************
*** 342,346 ****
  		{
  			DependencySource source=keys.nextElement();
! 			if(PluginList.isCompatible(source.getPluginType(),plugin))
  			{
  				// It is compatible, so calls put method on
--- 443,447 ----
  		{
  			DependencySource source=keys.nextElement();
! 			if(PluginList.areCompatibles(source.getPluginType(),plugin))
  			{
  				// It is compatible, so calls put method on
***************
*** 403,407 ****
  	public void releaseDependency(IPlugin depended)//{{{
  	{
! 		List<DependencySource> sourcelist=getSources(depended);
  		if(sourcelist==null)
  			return;
--- 504,508 ----
  	public void releaseDependency(IPlugin depended)//{{{
  	{
! 		List<DependencySource> sourcelist=getDependencySources(depended);
  		if(sourcelist==null)
  			return;
***************
*** 436,470 ****
  		}
  	}//}}}

! 	/** Change all original for replace in map.
! 	 *
! 	 * Change all occurence of original (comparing according reference)
! 	 * for replace plugin implementator. Plugins must have the compatible
! 	 * type and the same name.
! 	 * <p>
! 	 * This method is used when we need to replace implementator without
! 	 * removing original from map (an all actions that will follow).
  	 * 
! 	 * @param original Original plugin in map.
! 	 * @param replace Replace for original.
  	 */
! 	public void changeImplementator(IPlugin original,IPlugin replace)//{{{
  	{
! 		LogManager.getInstance().getLogger("PLUGMNG_LOGGER").log(ILogger.Level.INFO,"DependencyMap.changeImplementator changing all "+original+" with replace "+replace);
! 		// goes thorought all keys and all values and replace 
! 		// original with replace
  		Enumeration<DependencySource> keys=map.keys();
  		while(keys.hasMoreElements())
  		{
  			DependencySource source=keys.nextElement();
! 			source.changeImplementator(original,replace);
! 			PluginList deps=map.get(source);
! 			if(deps.changePlugin(original,replace))
! 				LogManager.getInstance().getLogger("PLUGMNG_LOGGER").log(ILogger.Level.DEBUG,"DependencyMap.changeImplementator replaced in dependency list. source="+source.getPluginType());
  		}
! 
! 	}//}}}

! 	/** Search for dependency sources for plugin.
  	*
  	* Search for all sources of dependency for given plugin. This is helper 
--- 537,622 ----
  		}
  	}//}}}
+ 

! 	/** Consolidates dependency map.
  	 * 
! 	 * Changes map according request to change oldone plugin for newone.
! 	 * This occures in conflic situation when newone is going to replace
! 	 * oldone plugin. 
! 	 * <p>
! 	 * <b>Process of change</b>:
! 	 * <ul>
! 	 * <li>Both plugins have to have same type (have to be interface 
! 	 * compatible - uses PluginList.isCompatible static method). If they 
! 	 * aren't returns an error.
! 	 * <li>If oldone is depednency source, just change implementators.
! 	 * <li>Removes oldone from dependencies lists (according referency uses
! 	 * removeExactPlugin method)
! 	 * </ul>
! 	 * @param oldone Original plugin inserted in map.
! 	 * @param newone Replace for oldone plugin.
! 	 * @return 0 if everything ok, negative number otherwise. Error usually
! 	 * means critical situation, because it means that caller doesn't 
! 	 * performed all needed checking.
  	 */
! 	public int consolidateDependencies(IPlugin oldone, IPlugin newone)
  	{
! 		// type compatibility check
! 		if(!PluginList.areTypeSame(oldone,newone))
! 			return -1;
! 		
! 		// change dependency sources
  		Enumeration<DependencySource> keys=map.keys();
  		while(keys.hasMoreElements())
  		{
  			DependencySource source=keys.nextElement();
! 			if(source.isSource(oldone))
! 			{
! 				// oldone is inserted in dependency source
! 				// we will change oldone for newone and exit
! 				// loop (we assume the each plugin can be in one
! 				// dependency source)
! 				source.changeImplementator(oldone,newone);
! 				LogManager.getInstance().getLogger("PLUGMNG_LOGGER").log(ILogger.Level.DEBUG,"DependencyMap.consolidateDependencies changed dependency source "+source);
! 				break;
! 			}
  		}
! 		
! 		// All dependencies of newone are set properly (common with
! 		// oldone are also set to newone (addDependency works in 
! 		// overwrite mode)
! 		
! 		// Set view of the map to easy traverse dependency lists
! 		Set<Map.Entry<DependencySource,PluginList>> deps=map.entrySet();
! 		
! 		// list of all dependency sources that became orphan (without
! 		// empty dependency list. These are removed from map after
! 		// traversing map. (We can't remove them directly because of
! 		// iteration)
! 		List<DependencySource> empty=new LinkedList<DependencySource>();
! 		
! 		// traverse dependency map and removes all occurance of oldone
! 		for(Map.Entry<DependencySource,PluginList> d : deps)
! 		{
! 			if(d.getValue().removeExactPlugin(oldone))
! 			{
! 				LogManager.getInstance().getLogger("PLUGMNG_LOGGER").log(ILogger.Level.DEBUG,"DependencyMap.consolidateDependencies Removed redundant dependency - "+oldone+" from "+d.getKey());
! 				if(d.getValue().size()==0)
! 					empty.add(d.getKey());
! 				
! 			}
! 		}
! 		
! 		// removes all dependency sources with empty dep list
! 		for(DependencySource s : empty)
! 		{
! 			map.remove(s);
! 			LogManager.getInstance().getLogger("PLUGMNG_LOGGER").log(ILogger.Level.DEBUG,"DependencyMap.consolidateDependencies Removed dependency source "+s+" with no depended plugins");
! 		}
! 		
! 		return 0;
! 	}

! 	/** Search for dependency sources for given plugin.
  	*
  	* Search for all sources of dependency for given plugin. This is helper 
***************
*** 475,479 ****
  	* found.
  	*/
! 	protected List<DependencySource> getSources(IPlugin depended)//{{{
  	{
  		List<DependencySource> sources=new LinkedList<DependencySource>();
--- 627,631 ----
  	* found.
  	*/
! 	protected List<DependencySource> getDependencySources(IPlugin depended)//{{{
  	{
  		List<DependencySource> sources=new LinkedList<DependencySource>();
***************
*** 498,501 ****
--- 650,655 ----
  	}//}}}

+ 	// Informational methods.
+ 	
  	/** Returns list of depended plugins.
  	 * 
***************
*** 522,532 ****
  		{
  			DependencySource dsource=keys.nextElement();
- 			PluginList deplist=map.get(source);
  			if(dsource.isSource(source))
! 			{
! 				return new  LinkedList<IPlugin>(deplist.toList());
! 			}
  		}
  		return null;
  	}//}}}
  }
--- 676,732 ----
  		{
  			DependencySource dsource=keys.nextElement();
  			if(dsource.isSource(source))
! 				return map.get(dsource).toList();
  		}
  		return null;
  	}//}}}
+ 
+ 	/** Returns all sources of dependencies.
+ 	 * 
+ 	 * Creates list of all dependencies sources. Each elements of returned
+ 	 * list is list which contains all implementators.
+ 	 * Changes made to lists don't take any effect on this dependency map.
+ 	 * It's just for informational character.
+ 	 * 
+ 	 * @return List containing lists as elements. Each inner list represents
+ 	 * one dependency source and its elements (plugins) are all 
+ 	 * implementators. 
+ 	 */
+ 	public List<List<IPlugin>> getSources()
+ 	{
+ 		Enumeration<DependencySource> keys=map.keys();
+ 		List<List<IPlugin>> result=new LinkedList<List<IPlugin>>();
+ 		List<IPlugin> impls;
+ 		
+ 		/* Goes throught all keys in map and for each DependencySource
+ 		   gets all implementator and insert them to the impls.
+ 		   Each impls inserts to the result list (resulting list
+ 		   will have same memebers as keys.size(). Each element of
+ 		   resulting list is list with key's implementators count).
+ 		 */
+ 		while(keys.hasMoreElements())
+ 		{
+ 			DependencySource source=keys.nextElement();
+ 			impls=source.getImplementators();
+ 			
+ 			result.add(impls);
+ 		}
+ 		
+ 		return result;
+ 	}
+ 
+ 	@Override public String toString()//{{{
+ 	{
+ 		return map.toString();
+ 	}//}}}
+ 
+ 	/** Deep copy creator.
+ 	 * Use this method to create new deep copy instance of this object.
+ 	 * 
+ 	 * @return New instance of DependencyMap class.
+ 	 */
+ 	@Override public Object clone()
+ 	{
+ 		return new DependencyMap((Hashtable)map.clone());
+ 	}
  }

2005	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep (93)	Oct (134)	Nov (29)	Dec (14)
2006	Jan (20)	Feb (1)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct (15)	Nov	Dec

exfex-cvs-commit Mailing List for Extended Form of examination (Page 12)

exfex-cvs-commit — Commit info mails