|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface is meant to provide easy access to a database, a specific file format or any other data source that provides information about a CD.
The CDox program will use this classes typically the following way: it gets the various description strings for all classes/plugins and displays them to the user (in the case that he wants to fill in the values for the type of his CD automatically), if their data type matches the current CD type. If the user chooses to configure a data source (and the data source can be configured at all), the configuration dialog of the source is shown. The user can also decide to perform the retrieval of the data, in which case there is created a data object, normally by giving search information to it. That object is then used to retrieve the data.
Method Summary | |
java.lang.Class |
getDataType()
Returns the class of data which this source provides. |
java.lang.String |
getDescription()
Returns a short description for this source. |
boolean |
hasConfigurationDialog()
Used to determine whether there is a configuration dialog for this source. |
Data |
retrieveData()
This method will be invoked to get the data. |
void |
showConfigurationDialog(java.awt.Frame parent)
Shows a configuration dialog where some options can be configured concerning this source. |
Method Detail |
public java.lang.String getDescription()
public java.lang.Class getDataType()
public boolean hasConfigurationDialog()
public void showConfigurationDialog(java.awt.Frame parent)
parent
- the parent frame.public Data retrieveData()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |