Skip to content
Open
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import org.groundplatform.android.model.submission.CaptureLocationTaskData
import org.groundplatform.android.model.submission.DateTimeTaskData
import org.groundplatform.android.model.submission.DrawAreaTaskData
import org.groundplatform.android.model.submission.DrawAreaTaskIncompleteData
import org.groundplatform.android.model.submission.DrawGeometryTaskData
import org.groundplatform.android.model.submission.DropPinTaskData
import org.groundplatform.android.model.submission.MultipleChoiceTaskData
import org.groundplatform.android.model.submission.NumberTaskData
Expand Down Expand Up @@ -55,6 +56,7 @@ internal object ValueJsonConverter {
is DrawAreaTaskData -> GeometryWrapperTypeConverter.toString(taskData.geometry)
is DropPinTaskData -> GeometryWrapperTypeConverter.toString(taskData.geometry)
is DrawAreaTaskIncompleteData -> GeometryWrapperTypeConverter.toString(taskData.geometry)
is DrawGeometryTaskData -> GeometryWrapperTypeConverter.toString(taskData.geometry)
is CaptureLocationTaskData -> taskData.toJSONObject()
is SkippedTaskData -> JSONObject().put(SKIPPED_KEY, true)
else -> throw UnsupportedOperationException("Unimplemented value class ${taskData.javaClass}")
Expand Down Expand Up @@ -115,6 +117,20 @@ internal object ValueJsonConverter {
DataStoreException.checkType(Point::class.java, geometry!!)
DropPinTaskData(geometry as Point)
}
Task.Type.DRAW_GEOMETRY -> {
if (obj is JSONObject) {
(obj as JSONObject).toCaptureLocationTaskData()
} else {
DataStoreException.checkType(String::class.java, obj)
val geometry = GeometryWrapperTypeConverter.fromString(obj as String)?.getGeometry()
DataStoreException.checkNotNull(geometry, "Missing geometry in draw geometry task result")
if (geometry is Point) {
DropPinTaskData(geometry)
} else {
DrawGeometryTaskData(geometry!!)
}
}
Comment on lines +121 to +132
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems error prone to me. I'd prefer if the entire object was encapsulated in DrawGeometryTaskData which can then internally have a location or geometry type data.

}
Task.Type.CAPTURE_LOCATION -> {
DataStoreException.checkType(JSONObject::class.java, obj)
(obj as JSONObject).toCaptureLocationTaskData()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ package org.groundplatform.android.data.remote.firebase.schema
import org.groundplatform.android.data.remote.firebase.schema.ConditionConverter.toCondition
import org.groundplatform.android.data.remote.firebase.schema.MultipleChoiceConverter.toMultipleChoice
import org.groundplatform.android.model.task.Condition
import org.groundplatform.android.model.task.DrawGeometry
import org.groundplatform.android.model.task.Task
import org.groundplatform.android.proto.Task as TaskProto
import org.groundplatform.android.proto.Task.DataCollectionLevel
import org.groundplatform.android.proto.Task.DrawGeometry.Method
import org.groundplatform.android.proto.Task.TaskTypeCase

/** Converts between Firestore nested objects and [Task] instances. */
Expand Down Expand Up @@ -50,12 +50,7 @@ internal object TaskConverter {
else -> Task.Type.DATE
}

private fun TaskProto.drawGeometryToTaskType(): Task.Type =
if (drawGeometry?.allowedMethodsList?.contains(Method.DRAW_AREA) == true) {
Task.Type.DRAW_AREA
} else {
Task.Type.DROP_PIN
}
private fun TaskProto.drawGeometryToTaskType(): Task.Type = Task.Type.DRAW_GEOMETRY

fun toTask(task: TaskProto): Task =
with(task) {
Expand Down Expand Up @@ -83,6 +78,16 @@ internal object TaskConverter {
multipleChoice,
task.level == DataCollectionLevel.LOI_METADATA,
condition = condition,
drawGeometry =
if (taskType == Task.Type.DRAW_GEOMETRY) {
DrawGeometry(
task.drawGeometry.requireDeviceLocation,
task.drawGeometry.minAccuracyMeters,
task.drawGeometry.allowedMethodsList.map { it.name },
)
} else {
null
},
)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import org.groundplatform.android.model.geometry.Polygon
import org.groundplatform.android.model.task.Task

/** A user-provided response to a geometry-based task ("drop a pin" or "draw an area"). */
sealed class GeometryTaskData(val geometry: Geometry) : TaskData
sealed class GeometryTaskData(open val geometry: Geometry) : TaskData

/** User-provided response to a "drop a pin" data collection [Task]. */
data class DropPinTaskData(val location: Point) : GeometryTaskData(location) {
Expand All @@ -38,3 +38,8 @@ data class DrawAreaTaskData(val area: Polygon) : GeometryTaskData(area) {
data class DrawAreaTaskIncompleteData(val lineString: LineString) : GeometryTaskData(lineString) {
override fun isEmpty(): Boolean = lineString.isEmpty()
}

/** User-provided response to a "draw a geometry" data collection [Task]. */
data class DrawGeometryTaskData(override val geometry: Geometry) : GeometryTaskData(geometry) {
override fun isEmpty(): Boolean = geometry.isEmpty()
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
* Copyright 2025 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.groundplatform.android.model.task

/**
* Suggested configuration for a task that involves drawing geometry on a map.
*
* @property isLocationLockRequired whether the user's location must be locked to the map viewport
* before they can start drawing.
* @property minAccuracyMeters the minimum accuracy (in meters) required for the user's location to
* be considered valid for drawing.
* @property allowedMethods the list of allowed methods for drawing geometry (e.g. "DROP_PIN",
* "DRAW_AREA").
*/
data class DrawGeometry(
val isLocationLockRequired: Boolean,
val minAccuracyMeters: Float,
val allowedMethods: List<String>,
)
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ constructor(
val multipleChoice: MultipleChoice? = null,
val isAddLoiTask: Boolean = false,
val condition: Condition? = null,
val drawGeometry: DrawGeometry? = null,
) {

// TODO: Define these in data layer!
Expand All @@ -48,6 +49,7 @@ constructor(
TIME,
DROP_PIN,
DRAW_AREA,
DRAW_GEOMETRY,
CAPTURE_LOCATION,
INSTRUCTIONS,
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import dagger.multibindings.IntoMap
import org.groundplatform.android.ui.datacollection.tasks.date.DateTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.geometry.DrawGeometryTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.instruction.InstructionTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.location.CaptureLocationTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.multiplechoice.MultipleChoiceTaskViewModel
Expand All @@ -48,6 +49,11 @@ import org.groundplatform.android.ui.tos.TermsOfServiceViewModel
@InstallIn(SingletonComponent::class)
@Module
abstract class ViewModelModule {
@Binds
@IntoMap
@ViewModelKey(DrawGeometryTaskViewModel::class)
abstract fun bindDrawGeometryTaskViewModel(viewModel: DrawGeometryTaskViewModel): ViewModel

@Binds
@IntoMap
@ViewModelKey(DrawAreaTaskViewModel::class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ import org.groundplatform.android.ui.common.EphemeralPopups
import org.groundplatform.android.ui.common.ViewModelFactory
import org.groundplatform.android.ui.datacollection.tasks.AbstractTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.date.DateTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.geometry.DrawGeometryTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.instruction.InstructionTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.location.CaptureLocationTaskViewModel
import org.groundplatform.android.ui.datacollection.tasks.multiplechoice.MultipleChoiceTaskViewModel
Expand Down Expand Up @@ -368,6 +369,7 @@ internal constructor(
Task.Type.DATE -> DateTaskViewModel::class.java
Task.Type.TIME -> TimeTaskViewModel::class.java
Task.Type.DROP_PIN -> DropPinTaskViewModel::class.java
Task.Type.DRAW_GEOMETRY -> DrawGeometryTaskViewModel::class.java
Task.Type.DRAW_AREA -> DrawAreaTaskViewModel::class.java
Task.Type.CAPTURE_LOCATION -> CaptureLocationTaskViewModel::class.java
Task.Type.INSTRUCTIONS -> InstructionTaskViewModel::class.java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import dagger.assisted.AssistedInject
import javax.inject.Provider
import org.groundplatform.android.model.task.Task
import org.groundplatform.android.ui.datacollection.tasks.date.DateTaskFragment
import org.groundplatform.android.ui.datacollection.tasks.geometry.DrawGeometryTaskFragment
import org.groundplatform.android.ui.datacollection.tasks.instruction.InstructionTaskFragment
import org.groundplatform.android.ui.datacollection.tasks.location.CaptureLocationTaskFragment
import org.groundplatform.android.ui.datacollection.tasks.multiplechoice.MultipleChoiceTaskFragment
Expand All @@ -41,11 +42,13 @@ constructor(
private val drawAreaTaskFragmentProvider: Provider<DrawAreaTaskFragment>,
private val captureLocationTaskFragmentProvider: Provider<CaptureLocationTaskFragment>,
private val dropPinTaskFragmentProvider: Provider<DropPinTaskFragment>,
private val drawGeometryTaskFragmentProvider: Provider<DrawGeometryTaskFragment>,
@Assisted fragment: Fragment,
@Assisted val tasks: List<Task>,
) : FragmentStateAdapter(fragment) {
override fun getItemCount(): Int = tasks.size

@Suppress("CyclomaticComplexMethod")
override fun createFragment(position: Int): Fragment {
val task = tasks[position]

Expand All @@ -55,6 +58,7 @@ constructor(
Task.Type.MULTIPLE_CHOICE -> MultipleChoiceTaskFragment()
Task.Type.PHOTO -> PhotoTaskFragment()
Task.Type.DROP_PIN -> dropPinTaskFragmentProvider.get()
Task.Type.DRAW_GEOMETRY -> drawGeometryTaskFragmentProvider.get()
Task.Type.DRAW_AREA -> drawAreaTaskFragmentProvider.get()
Task.Type.NUMBER -> NumberTaskFragment()
Task.Type.DATE -> DateTaskFragment()
Expand Down
Loading