app/io.schiar.fridgnet.model/AdministrativeUnit

AdministrativeUnit

data class AdministrativeUnit(val name: String, val administrativeLevel: AdministrativeLevel, var cartographicBoundary: CartographicBoundary? = null, val subAdministrativeUnits: IdentitySet<AdministrativeUnit> = IdentitySet(), val images: MutableSet<Image> = mutableSetOf())

Represents an administrative unit with its properties and relationships.

Constructors

AdministrativeUnit

constructor(name: String, administrativeLevel: AdministrativeLevel, cartographicBoundary: CartographicBoundary? = null, subAdministrativeUnits: IdentitySet<AdministrativeUnit> = IdentitySet(), images: MutableSet<Image> = mutableSetOf())

Properties

administrativeLevel

val administrativeLevel: AdministrativeLevel

The AdministrativeLevel of this unit (e.g., state, county, city).

cartographicBoundary

var cartographicBoundary: CartographicBoundary?

The CartographicBoundary object representing the outline of the unit on a map (can be null).

firstName

val firstName: String

Returns the first part of the unit's name, excluding names of outer administrative units. This assumes the name is formatted with outer unit names separated by commas (", "). If the name format is different, consider adjusting the splitting logic.

images

val images: MutableSet<Image>

A set containing all Image objects associated with this administrative unit (presumably images taken within its boundaries).

name

val name: String

The full name of the administrative unit, potentially including names of outer administrative units separated by commas (or other separators).

subAdministrativeUnits

val subAdministrativeUnits: IdentitySet<AdministrativeUnit>

A set containing all child administrative units under this unit.

Functions

activeCartographicBoundaryRegionsWithin

fun activeCartographicBoundaryRegionsWithin(boundingBox: BoundingBox): List<Region>

Handles active regions (regions that are visible and not unchecked by a user) from the cartographic boundary delimited by a bounding box.

flatMapSubCartographicBoundariesViewDataList

fun AdministrativeUnit.flatMapSubCartographicBoundariesViewDataList(administrativeUnit: AdministrativeUnit, cartographicBoundaries: MutableList<CartographicBoundaryViewData> = mutableListOf()): List<CartographicBoundaryViewData>

Recursively iterates over all sub-administrative units within an AdministrativeUnit and creates a list of converted CartographicBoundaryViewData objects.

toAdministrativeUnitViewData

fun AdministrativeUnit.toAdministrativeUnitViewData(): AdministrativeUnitViewData

Converts the AdministrativeUnit model into the view object AdministrativeUnitViewData used to represent administrative units in the UI.

toString

open override fun toString(): String