| | 70 | |
| | 71 | == Java Interface == |
| | 72 | {{{ |
| | 73 | public interface DataSource { |
| | 74 | |
| | 75 | /** |
| | 76 | * Gets the id of this data source. |
| | 77 | * |
| | 78 | * @return A identifier for the data source. |
| | 79 | */ |
| | 80 | public String getID(); |
| | 81 | |
| | 82 | /** |
| | 83 | * Set the ID of this data source. |
| | 84 | * |
| | 85 | * @param id the new ID |
| | 86 | */ |
| | 87 | public void setID(String id); |
| | 88 | |
| | 89 | /** |
| | 90 | * Gets the name of this data source. |
| | 91 | * |
| | 92 | * @return A descriptive name for the data source. |
| | 93 | */ |
| | 94 | public String getName(); |
| | 95 | |
| | 96 | /** |
| | 97 | * Sets the name of this data source. |
| | 98 | * |
| | 99 | * @param name A descriptive name for the data source. |
| | 100 | */ |
| | 101 | public void setName(String name); |
| | 102 | |
| | 103 | /** |
| | 104 | * Set a configuration attribute supported by the specific datasource |
| | 105 | * implementation class. Unknown elements and incorrectly encoded attributes |
| | 106 | * end element text are silently ignored. |
| | 107 | * |
| | 108 | * @param attributeName The XML element name used to identify the configuration attribute. |
| | 109 | * @param atts The element's attributes, encoded as a Map of key-value-pairs. |
| | 110 | * @param text the element's textual contents. |
| | 111 | */ |
| | 112 | public void setConfigAttribute(String attributeName, Map<String, String> atts, String text); |
| | 113 | |
| | 114 | /** |
| | 115 | * Writes all config attributes of the datasource to a given XML writer. |
| | 116 | * |
| | 117 | * @param xmlWriter the XMLWriter to which the config attributes will be written. |
| | 118 | * @throws IOException passed on by the XMLWriter. |
| | 119 | */ |
| | 120 | public void writeConfigAttributes(XmlWriter xmlWriter) throws IOException; |
| | 121 | } |
| | 122 | }}} |