mannie-taverna-scufl 0.6.2 → 0.7.0

data/README.rdoc

@@ -1,7 +1,7 @@
 = Taverna[http://taverna.sourceforge.net] 1 Interaction Gem
 
 Authors::       Stian Soiland, David Withers, Emmanuel Tagarira
-Version::       0.6.2
+Version::       0.7.0
 Contact::       taverna-hackers@lists.sourceforge.net
 URL::           http://taverna.sourceforge.net/
 Licence::       LGPL 3 (See LICENCE or http://www.gnu.org/licenses/lgpl.html)

data/Release_Notes.rdoc

@@ -1,8 +1,8 @@
-= Version 0.6.2
-Released:: Friday, September 11, 2009
-
-== Bug fixes
-- none
+= Version 0.7.0
+Released:: Monday, September 14, 2009
 
 == Added Functionality
-- Extraction of more metadata for soaplab and biomoby services, and artitrary wsdls.
+- Retrieval of processors directly connected/linked to the given processor.
+=== New instance method in Scufl::Model
+      get_processor_links(processor)
+=== New supporting object Scufl::ProcessorLinks

data/lib/scufl/model.rb

@@ -41,11 +41,85 @@ module Scufl # :nodoc:
       @coordinations = Array.new
     end
     
-    # Retrieve ALL the beanshell processors within the workflow.
+    # Retrieve ALL the beanshell processors WITHIN the given workflow model.
     def beanshells
-      return get_beanshells(self, [])
+      self.all_processors.select { |x| x.type == "beanshell" }
     end
     
+    # Retrieve ALL processors of that are webservices WITHIN the model.
+    def web_services
+      self.all_processors.select { |x| x.type =~ /wsdl|soaplab|biomoby/i }
+    end
+    
+    # Retrieve ALL processor objects WITHIN the given workflow model.
+    def all_processors
+      return get_processors(self, [])
+    end
+    
+    
+    # Retrieve ALL the links WITHIN the given workflow model.
+    def all_links
+      return get_links(self, [])
+    end
+    
+    # Retrieve ALL the sinks(outputs) WITHIN the given workflow model.
+    def all_sinks
+      return get_sinks(self, [])
+    end
+    
+    # Retrieve ALL the sources(inputs) WITHIN the given workflow model.    
+    def all_sources
+      return get_sources(self, [])
+    end
+    
+    # For the given dataflow, return the beanshells and/or services which 
+    # have direct links to or from the given processor.
+    # == Usage
+    #   my_processor = model.processor[0]
+    #   linked_processors = model.get_processors_linked_to(my_processor)
+    #   processors_feeding_into_my_processor = linked_processors.sources
+    #   processors_feeding_from_my_processor = linked_processors.sinks    
+    def get_processor_links(processor)
+      return nil unless processor
+      proc_links = ProcessorLinks.new
+      
+      # SOURCES
+      sources = self.all_links.select { |x| x.sink =~ /#{processor.name}:.+/ }
+      proc_links.sources = []
+
+      # SINKS
+      sinks = self.all_links.select { |x| x.source =~ /#{processor.name}:.+/ }
+      proc_links.sinks = []
+      temp_sinks = []
+      sinks.each { |x| temp_sinks << x.sink }
+      
+      # Match links by port into format
+      # my_port:name_of_link_im_linked_to:its_port
+      sources.each do |connection|
+        link = connection.sink
+        connected_proc_name = link.split(":")[0]
+        my_connection_port = link.split(":")[1]
+        
+        if my_connection_port
+          source = my_connection_port << ":" << connection.source
+          proc_links.sources << source if source.split(":").size == 3
+        end
+      end
+      
+      sinks.each do |connection|
+        link = connection.source
+        connected_proc_name = link.split(":")[0]
+        my_connection_port = link.split(":")[1]
+        
+        if my_connection_port
+          sink = my_connection_port << ":" << connection.sink
+          proc_links.sinks << sink if sink.split(":").size == 3
+        end
+      end
+      
+      return proc_links
+    end
+  
     private
     
     def get_beanshells(given_model, beans_collected) # :nodoc:
@@ -57,6 +131,46 @@ module Scufl # :nodoc:
       
       return beans_collected
     end
+    
+    def get_processors(given_model, procs_collected) # :nodoc:
+      wf_procs = given_model.processors.select { |x| x.type == "workflow" }
+      wf_procs.each { |x| get_processors(x.model, procs_collected) if x.model }
+      
+      procs = given_model.processors
+      procs.each { |a| procs_collected << a }
+      
+      return procs_collected
+    end
+    
+    def get_links(given_model, links_collected) # :nodoc:
+      wf_procs = given_model.processors.select { |x| x.type == "workflow" }
+      wf_procs.each { |x| get_links(x.model, links_collected) if x.model }
+      
+      links = given_model.links
+      links.each { |a| links_collected << a }
+      
+      return links_collected
+    end
+    
+    def get_sinks(given_model, sinks_collected) # :nodoc:
+      wf_procs = given_model.processors.select { |x| x.type == "workflow" }
+      wf_procs.each { |x| get_sinks(x.model, sinks_collected) if x.model }
+      
+      sinks = given_model.sinks
+      sinks.each { |a| sinks_collected << a }
+      
+      return sinks_collected
+    end
+    
+    def get_sources(given_model, sources_collected) # :nodoc:
+      wf_procs = given_model.processors.select { |x| x.type == "workflow" }
+      wf_procs.each { |x| get_sources(x.model, sources_collected) if x.model }
+      
+      sources = given_model.sources
+      sources.each { |a| sources_collected << a }
+      
+      return sources_collected
+    end
   end
   
   
@@ -110,6 +224,24 @@ module Scufl # :nodoc:
   end
 
 
+
+  # This object is returned after invoking model.get_processor_links(processor)
+  # .  The object contains two lists of processors.  Each element consists of: 
+  # the input or output port the processor uses as a link, the name of the
+  # processor being linked, and the port of the processor used for the linking,
+  # all seperated by a colon (:) i.e. 
+  #   my_port:name_of_processor:processor_port
+  class ProcessorLinks
+    # The processors whose output is fed as input into the processor used in
+    # model.get_processors_linked_to(processor).
+    attr_accessor :sources
+    
+    # A list of processors that are fed the output from the processor (used in
+    # model.get_processors_linked_to(processor) ) as input.
+    attr_accessor :sinks
+  end
+  
+
   
   # This contains basic descriptive information about the workflow model.
   class WorkflowDescription

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mannie-taverna-scufl
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors: 
 - David Withers
@@ -9,7 +9,7 @@ authors:
 autorequire: baclava, client, document, scufl
 bindir: bin
 cert_chain: 
-date: 2009-09-11 00:00:00 -07:00
+date: 2009-09-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,6 @@ files:
 - Release_Notes.rdoc
 has_rdoc: true
 homepage: http://www.mygrid.org.uk/
-licenses: 
 post_install_message: 
 rdoc_options: 
 - -N
@@ -89,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 1
 summary: Support for interacting with the Taverna workflow system (Scufl).