wiki:ApertureDataSource

Version 23 (modified by anonymous, 19 years ago) (diff)

--

ApertureDataSource

Java Interface

Probably equal to source:trunk/gnowsis/src/org/gnowsis/data/datasource/DataSource.java

Changelog:

  • removed setConfigAttribute and writeConfigAttributes: the choice to store DataSource configuration and the way to do that is probably an application decision. This functionality should be moved to a utility class.
 /**
  * A DataSource defines the characteristics of a source from which DataObjects
  * can be extracted. A Datasource contains all information necessary to realize
  * these objects, such as paths, usernames, passwords, etc.
  */
public interface DataSource {

        /**
         * Method added from Gnowsis
         *
         *
         *
         * get the configuration of this datasource.
         * The configuration is always passed to the constructor.
         * @return the configuration
         */
        public DataSourceConfig getDSConfig();
 
        /**
         * Method added from Gnowsis
         *
         * The Aduna Interface identifies DataSources by ID and Name.
         * Gnowsis uses Uris 
         *
         * return the uri identifying this datasource inside gnowsis.
         * The uri is usually the uri of the resource in the DSConfig.
         * The uri is unique inside one gnowsis installation.
         * @return the uri of this datasource
         */
         public String getUri();

        /**
         * Gets the id of this data source.
         * 
         * @return A identifier for the data source.
         */
        public String getID();

        /**
         * Set the ID of this data source.
         * 
         * @param id the new ID
         */
        public void setID(String id);

        /**
         * Gets the name of this data source.
         * 
         * @return A descriptive name for the data source.
         */
        public String getName();

        /**
         * Sets the name of this data source.
         * 
         * @param name A descriptive name for the data source.
         */
        public void setName(String name);
}