Exportable Interface Reference

List of all members.


Detailed Description

Each method of an IAccessAdapter should be annotated with this annotation if it is a method which could be used to export the returned data into XML. Before export, Tesla analyzes each method of the selected IAccessAdapter, and allows the use of a method if both return type and parameters can be processed.
The return type matches iff <l> It is either a primitive, or It is one of the classes String or Annotation, or It is one of DataObject, Collection or Map or a sub interface of these. <l>
Parameters match iff <l> The method has no parameters, or The method has exactly one parameter, and this is either of type Range or TeslaDocument, or The method has exactly one parameter, and this is a String which refers to a signal by annotating it as SignalId, or The method has two parameters, where one parameter matches the conditions above, and the second is of type Order, or. The method has only primitive or String parameters (not annotated with SignalId), and the visualizer restriction defines default values to be used when calling the method. <l>

See also:
IFrequencyAccessAdapter IFrequencyAccessAdapter as an example which uses both SignalId and default values.
ITfIdfAccessAdapter ITfIdfAccessAdapter#getTypesWithBestScore(String, int) as an example which uses a combination of SignalId and default values.
Author:
sschwieb

Public Methods

boolean recommended () default false
String displayName ()
String[] defaults () default

Package Functions

String description () default"No Description available."

Method Details

String [] defaults ( )

If a method which should be called for export requires parameters, this array can be used to set useful default values. Note: Only primitive values and Strings can be referred this way. null is a legal value for Strings only. This features has not been tested well yet!

Returns:
String description ( ) [package]

Returns the description of the method, as it will be displayed in the export dialog. By default, this value is set to "No Description available.". Developers should, however, set a short description such that users will be able to decide which method to select.

Returns:
String displayName ( )

Returns the name of the method, as it should be displayed in the export dialog and in the generated XML data.

Returns:
boolean recommended ( )

Returns true if the method is recommended (and should be enabled automatically)

Returns: