org.eclipse.gmt.modisco.discoverersmanager
Interface Discoverer

All Known Subinterfaces:
ExtendedInterface
All Known Implementing Classes:
DiscovererHandler

public interface Discoverer

Author:
Gabriel Barbier

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.util.Set<java.lang.String> getParameterKeys()
          To have a complete list of all parameters available in this discoverer.
 

Method Detail

applyTo

boolean applyTo(java.lang.Object source)
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)

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

discoverElement

org.eclipse.emf.ecore.resource.Resource discoverElement(java.lang.Object source,
                                                        org.eclipse.emf.common.util.URI target)
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)

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:
discoverElement(java.lang.Object, java.util.Map)

discoverElement

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. 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.

Parameters:
source - the selected object.
parameters - list of parameters pair (key, value)

getParameterKeys

java.util.Set<java.lang.String> getParameterKeys()
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 ...

Returns:
set of parameters names provided by this discoverer.