org.eclipse.gmt.modisco.discoverersmanager.handlers
Class DiscovererHandler

java.lang.Object
  extended by org.eclipse.gmt.modisco.discoverersmanager.handlers.DiscovererHandler
All Implemented Interfaces:
Discoverer

public class DiscovererHandler
extends java.lang.Object
implements Discoverer

Author:
Gabriel Barbier

Constructor Summary
DiscovererHandler(Discoverer delegateParemeter)
           
 
Method Summary
 boolean applyTo(java.lang.Object source)
          To determine if source object could be handled by the discoverer.
 void discoverElement(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> parameters)
          Generic method to discover a source element, it allows more different use cases.
 org.eclipse.emf.ecore.resource.Resource discoverElement(java.lang.Object source, org.eclipse.emf.common.util.URI target)
          Execute discovery task with selected object.
 java.lang.String getName()
           
 java.util.Set<java.lang.String> getParameterKeys()
          To have a complete list of all parameters available in this discoverer.
 java.lang.String[] getPaths()
           
 void setName(java.lang.String name)
           
 void setPaths(java.lang.String[] paths)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DiscovererHandler

public DiscovererHandler(Discoverer delegateParemeter)
Method Detail

applyTo

public boolean applyTo(java.lang.Object source)
Description copied from interface: Discoverer
To determine if source object could be handled by the discoverer. Each discoverer has to implements this method with its own criteria to filter selected object, If the source object is managed by this discoverer, the discoverer menu will be available in popup menu when users click with contextual button (right-click)

Specified by:
applyTo in interface Discoverer
Parameters:
source - the selected object.
Returns:
true if selected object is managed by this discoverer, false other else.

discoverElement

public org.eclipse.emf.ecore.resource.Resource discoverElement(java.lang.Object source,
                                                               org.eclipse.emf.common.util.URI target)
Description copied from interface: Discoverer
Execute discovery task with selected object. This is a method adapted to common use of discoverers. For a more generic method, see discoverElement(Object source, Map parameters)

Specified by:
discoverElement in interface Discoverer
Parameters:
source - the selected object.
target - the target uri if provided, null other else.
Returns:
the EMF resource of target model discovered from source.
See Also:
Discoverer.discoverElement(java.lang.Object, java.util.Map)

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set

getName

public java.lang.String getName()
Returns:
the name

setPaths

public void setPaths(java.lang.String[] paths)
Parameters:
paths - the paths to set

getPaths

public java.lang.String[] getPaths()
Returns:
the paths

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

discoverElement

public void discoverElement(java.lang.Object source,
                            java.util.Map<java.lang.String,java.lang.Object> parameters)
Description copied from interface: Discoverer
Generic method to discover a source element, it allows more different use cases. Because there is no constraints to expected result, we have a way to drive elements discovery with a wide configuration panel. This method has to be used in coordination with "getParameterKeys" method to know which parameters are available.

Specified by:
discoverElement in interface Discoverer
Parameters:
source - the selected object.
parameters - list of parameters pair (key, value)

getParameterKeys

public java.util.Set<java.lang.String> getParameterKeys()
Description copied from interface: Discoverer
To have a complete list of all parameters available in this discoverer. Further informations should be provided to indicate features of each parameter, for example, direction kind (in, out, in-out), if parameter is optional or not ...

Specified by:
getParameterKeys in interface Discoverer
Returns:
set of parameters names provided by this discoverer.