♻️ Refactor(FileDataSourceReader): Correct read function documentatio…

…n and type in txt-ndjson enumeration
srdc · Sep 10, 2024 · 30828c3 · 30828c3
1 parent 2777ba4
commit 30828c3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/tofhir-engine/src/main/scala/io/tofhir/engine/data/read/FileDataSourceReader.scala b/tofhir-engine/src/main/scala/io/tofhir/engine/data/read/FileDataSourceReader.scala
@@ -23,10 +23,12 @@ class FileDataSourceReader(spark: SparkSession) extends BaseDataSourceReader[Fil
   /**
    * Read the source data
    *
-   * @param mappingSourceBinding Configuration information for mapping source
-   * @param schema        Optional schema for the source
-   * @param limit         Limit the number of rows to read
-   * @param jobId         The identifier of mapping job which executes the mapping
+   * @param mappingSourceBinding   Configuration information for the mapping source
+   * @param mappingJobSourceSettings  Common settings for the source system
+   * @param schema          Optional schema for the source
+   * @param timeRange       Time range for the data to read if given
+   * @param limit           Limit the number of rows to read
+   * @param jobId           The identifier of mapping job which executes the mapping
    * @return
    * @throws IllegalArgumentException If the path is not a directory for streaming jobs.
    * @throws NotImplementedError      If the specified source format is not implemented.
@@ -108,7 +110,7 @@ class FileDataSourceReader(spark: SparkSession) extends BaseDataSourceReader[Fil
               .schema(csvSchema.orNull)
               .csv(finalPath)
         // assume that each line in the txt files contains a separate JSON object.
-        case SourceFileFormats.JSON | SourceFileFormats.TXT_NDJON=>
+        case SourceFileFormats.JSON | SourceFileFormats.TXT_NDJSON =>
           if(mappingJobSourceSettings.asStream)
             spark.readStream.options(mappingSourceBinding.options).schema(schema.orNull).json(finalPath)
               // add a dummy column called 'filename' to print a log when the data reading is started for a file

diff --git a/tofhir-engine/src/main/scala/io/tofhir/engine/model/FhirMappingTask.scala b/tofhir-engine/src/main/scala/io/tofhir/engine/model/FhirMappingTask.scala
@@ -140,7 +140,7 @@ object SourceFileFormats {
   final val PARQUET = "parquet"
   final val JSON = "json"
   final val AVRO = "avro"
-  final val TXT_NDJON = "txt-ndjson"
+  final val TXT_NDJSON = "txt-ndjson"
   final val TXT_CSV = "txt-csv"
   final val TXT = "txt"
 }