minor

[cdmlib.git] / cdmlib-io / src / main / java / eu / etaxonomy / cdm / io / common / IImportConfigurator.java

diff --git a/cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/IImportConfigurator.java b/cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/IImportConfigurator.java
index f3b69cbcb6b20c645c0715b8e16a18272f0873d8..e986f65628bb4b0bb5aa278f2b30308a850ff62b 100644 (file)
--- a/cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/IImportConfigurator.java
+++ b/cdmlib-io/src/main/java/eu/etaxonomy/cdm/io/common/IImportConfigurator.java
@@ -159,6 +159,16 @@ public interface IImportConfigurator extends IIoConfigurator {
        public void setDbSchemaValidation(\r
                        DbSchemaValidation dbSchemaValidation);\r
 \r
+       /**\r
+        * The reference that represents the source. E.g. if the import source is a database\r
+        * the returned reference should be of type eu.etaxonomy.cdm.model.reference.Database and \r
+        * should represent the according database.\r
+        * If the import comes from a file (e.g. XML) the returned value should best represent the \r
+        * source of this file (e.g. if the source of an XML file is a certain database this database\r
+        * should be mentioned as the source. Otherwise a eu.etaxonomy.cdm.model.reference.Generic \r
+        * reference with the name of the XML file should be returned value\r
+        * @return\r
+        */\r
        public ReferenceBase getSourceReference();\r
 \r
        \r