Package org.intermine.client.services
Class WidgetService
- java.lang.Object
-
- org.intermine.client.core.Service
-
- org.intermine.client.services.WidgetService
-
public class WidgetService extends Service
A class for managing widget operations. This service provides information directly, and manages interactions for other services. Normally the user should obtain an instance of this class through the ServiceFactory class. Any authentication provided to that parent class will be used in all requests that need authentication by the WidgetService. The services provided include:- Getting information about the available widgets
-
-
Field Summary
-
Fields inherited from class org.intermine.client.core.Service
resourceUrl, VERSION
-
-
Constructor Summary
Constructors Constructor Description WidgetService(java.lang.String rootUrl, java.lang.String applicationName)
UseServiceFactory
instead of constructor for creating this service .
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<Widget>
getChartWidgets()
java.util.List<Widget>
getEnrichmentWidgets()
Widget
getWidget(java.lang.String name)
java.util.List<Widget>
getWidgets()
-
Methods inherited from class org.intermine.client.core.Service
assureOutputFormatSpecified, clearCache, createGetRequest, createPostRequest, executeRequest, getAPIVersion, getApplicationName, getFactory, getIntResponse, getRootUrl, getStringResponse, getUrl, getVersion, setAuthentication, setAuthentication, setConnectionTimeout, setFactory
-
-
-
-
Constructor Detail
-
WidgetService
public WidgetService(java.lang.String rootUrl, java.lang.String applicationName)
UseServiceFactory
instead of constructor for creating this service .- Parameters:
rootUrl
- root URLapplicationName
- application name
-
-
Method Detail
-
getWidgets
public java.util.List<Widget> getWidgets()
- Returns:
- Get the available widgets.
-
getWidget
public Widget getWidget(java.lang.String name)
- Parameters:
name
- The name of the widget you want.- Returns:
- A widget by name, or null.
-
getChartWidgets
public java.util.List<Widget> getChartWidgets()
- Returns:
- All chart widgets.
-
getEnrichmentWidgets
public java.util.List<Widget> getEnrichmentWidgets()
- Returns:
- All enrichment widgets.
-
-