Package org.cytoscape.application.swing.search

Class AbstractNetworkSearchTaskFactory

java.lang.Object
org.cytoscape.work.AbstractTaskFactory
org.cytoscape.application.swing.search.AbstractNetworkSearchTaskFactory
All Implemented Interfaces:
NetworkSearchTaskFactory, TaskFactory
public abstract class AbstractNetworkSearchTaskFactory extends AbstractTaskFactory implements NetworkSearchTaskFactory
This abstract implementation of NetworkSearchTaskFactory makes the method getQueryComponent() optional. If your Network Search provider extends this class and doesn't overwrite the getQueryComponent() method, Cytoscape will use a default text field instead. It will also pass the new query text to the setQuery(String) method every time the content of the default text field changes.

  • Constructor Details

    • AbstractNetworkSearchTaskFactory

      protected AbstractNetworkSearchTaskFactory​(String id, String name, Icon icon)

    • AbstractNetworkSearchTaskFactory

      protected AbstractNetworkSearchTaskFactory​(String id, String name, String description, Icon icon)

    • AbstractNetworkSearchTaskFactory

      protected AbstractNetworkSearchTaskFactory​(String id, String name, String description, Icon icon, URL website)

  • Method Details

    • getId

      public String getId()
      Description copied from interface: NetworkSearchTaskFactory
      Returns the unique id of this network search provider. Use namespaces to make sure it is unique (e.g. "org.myCompany.mySearch").
      Specified by:
      getId in interface NetworkSearchTaskFactory
      Returns:
      A unique id for this search provider.

    • getName

      public String getName()
      Description copied from interface: NetworkSearchTaskFactory
      A short name to be displayed to the user.
      Specified by:
      getName in interface NetworkSearchTaskFactory
      Returns:
      The name of this search provider.

    • getDescription

      public String getDescription()
      Description copied from interface: NetworkSearchTaskFactory
      An optional short text describing what this search provider does.
      Specified by:
      getDescription in interface NetworkSearchTaskFactory
      Returns:
      A text that describes this search provider, which can be null.

    • getIcon

      public Icon getIcon()
      Description copied from interface: NetworkSearchTaskFactory
      An icon that represents this search provider.
      Specified by:
      getIcon in interface NetworkSearchTaskFactory
      Returns:
      If null, Cytoscape may provide a default or random icon for this search provider.

    • getWebsite

      public URL getWebsite()
      Description copied from interface: NetworkSearchTaskFactory
      An optional URL the user can use to find more information about this search provider.
      Specified by:
      getWebsite in interface NetworkSearchTaskFactory
      Returns:
      A URL to a website, which can be null.

    • getQuery

      public String getQuery()

    • setQuery

      public void setQuery​(String query)
      This method is called by Cytoscape whenever the user changes the query text.
      Parameters:
      query -

    • getTaskObserver

      public TaskObserver getTaskObserver()
      Description copied from interface: NetworkSearchTaskFactory
      If you want to be notified when the search task is finished, you should return a TaskObserver here. For example, you may want to display a dialog with a list of multiple network results, in case the user has to select one of them before the final network is created.
      Specified by:
      getTaskObserver in interface NetworkSearchTaskFactory
      Returns:
      Optional TaskObserver to be passed to the TaskManager when running the search task(s) created by this TaskFactory.

    • getQueryComponent

      public JComponent getQueryComponent()
      This implementation simply returns null, which means Cytoscape will provide a default query component, unless the subclass overwrites this method to return a custom component.
      Specified by:
      getQueryComponent in interface NetworkSearchTaskFactory
      Returns:
      If null, Cytoscape will create a basic search field for you.

    • getOptionsComponent

      public JComponent getOptionsComponent()
      This implementation simply returns null, which means that no options component will be displayed, unless the subclass overwrites this method to return a custom component.
      Specified by:
      getOptionsComponent in interface NetworkSearchTaskFactory
      Returns:
      If null, extra search options will not be available to the end user.

    • isReady

      public boolean isReady()
      A default implementation that simply checks whether or not the String returned by getQuery() is empty.
      Specified by:
      isReady in interface TaskFactory
      Overrides:
      isReady in class AbstractTaskFactory
      Returns:
      true if the TaskFactory has all necessary preconditions needed to generate a task that will execute properly, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object