core/com.arnyminerz.escalaralcoiaicomtat.core.data.climb.dataclass/DataClass

DataClass

abstract class DataClass<A : DataClassImpl, B : DataClassImpl, D : DataRoot<*>>(val displayName: String, val timestampMillis: Long, val imagePath: String, val kmzPath: String?, val location: GeoPoint?, val metadata: DataClassMetadata, val displayOptions: DataClassDisplayOptions) : DataClassImpl

The main data storage class.

Author

Arnau Mora

Since

20210830

Parameters

The children type.

A reference of the current type.

displayName

The name that will be displayed to the user.

timestampMillis

The creation date of the DataClass in milliseconds.

imagePath

The path of the DataClass' image on the server.

kmzPath

The path of the DataClass' KMZ file on the server. May be null if not applicable or non-existing.

location

The coordinates of the DataClass to show in a map.

metadata

Some metadata of the DataClass.

displayOptions

Options for displaying in the UI.

Constructors

DataClass

fun DataClass(displayName: String, timestampMillis: Long, imagePath: String, kmzPath: String?, location: GeoPoint?, metadata: DataClassMetadata, displayOptions: DataClassDisplayOptions)

Types

Companion

object Companion

Functions

data

abstract fun data(): D

Converts the DataClass into a Search Data class.

describeContents

abstract fun describeContents(): Int

displayMap

abstract override fun displayMap(): Map<String, Serializable?>

Returns a map used to display the stored data to the user. Keys should be the parameter name, and the value the value to display. Should be overridden by target class.

equals

open operator override fun equals(other: Any?): Boolean

Checks if the DataClass is the same as another one.

get

@WorkerThread

suspend fun get(context: Context, index: Int): A

Gets the children element at index. May throw IndexOutOfBoundsException if children have not been loaded.

@WorkerThread

suspend fun get(context: Context, objectId: String): A?

Finds an DataClass inside a list with an specific id. If it's not found, null is returned.

getChildren

@WorkerThread

inline suspend fun <R : Comparable<R>> getChildren(context: Context, crossinline sortBy: (A) -> R?): List<A>

Returns the children of the DataClass.

getCount

@WorkerThread

suspend fun getCount(context: Context): Int

Returns the amount of children the DataClass has.

getParent

suspend fun <D : DataClass<*, *, *>> getParent(context: Context): D?

Gets the parent element of the DataClass.

getSize

@WorkerThread

suspend fun ~~getSize~~(context: Context): Int

Returns the amount of children the DataClass has.

has

@WorkerThread

suspend fun has(context: Context, objectId: String): Boolean

hashCode

open override fun hashCode(): Int

hasStorageUrl

fun hasStorageUrl(): Boolean

Checks if the DataClass has a stored downloadUrl.

Image

@Composable

fun Image(modifier: Modifier = Modifier, imageLoadParameters: ImageLoadParameters? = null, isPlaceholder: Boolean = false, onFinishLoading: () -> Unit)

imageFile

fun imageFile(context: Context): File?

Returns the File that represents the image of the DataClass

isEmpty

@WorkerThread

suspend fun isEmpty(context: Context): Boolean

Checks if the data class has children. Note: won't load children, will just use the already loaded ones.

isNotEmpty

@WorkerThread

suspend fun isNotEmpty(context: Context): Boolean

Checks if the data class doesn't have any children

kmzFile

@WorkerThread

suspend fun kmzFile(context: Context, permanent: Boolean): File

Gets the KMZ file path. If it has never been loaded, it gets loaded from the server. Otherwise, it gets loaded from cache.

toString

open override fun toString(): String

Converts the DataClass to a String for showing in debug or to the user. The string contains the first letter of the namespace, followed by a slash (/) and the objectId.