commonMain.kotbase.Fragment.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of couchbase-lite Show documentation
Show all versions of couchbase-lite Show documentation
Couchbase Lite Community Edition for Kotlin Multiplatform
/*
* Copyright 2022-2023 Jeff Lockhart
*
* 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
*
* http://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 kotbase
import kotlinx.datetime.Instant
/**
* Fragment provides readonly access to data value. Fragment also provides subscript access
* by either key or index to the nested values which are wrapped by Fragment objects.
*/
public open class Fragment
internal constructor(
protected val parent: Any?,
protected val key: String?,
protected val index: Int?
) {
internal constructor(parent: Document, key: String) :
this(parent, key, null)
internal constructor(parent: Dictionary, key: String) :
this(parent, key, null)
internal constructor(parent: Result, key: String) :
this(parent, key, null)
internal constructor(parent: Array, index: Int) :
this(parent, null, index)
internal constructor(parent: Result, index: Int) :
this(parent, null, index)
internal constructor() : this(null, null, null)
private fun Result.select(keyAction: Result.(key: String) -> R, indexAction: Result.(index: Int) -> R): R {
return if (key != null) {
keyAction(key)
} else if (index != null) {
indexAction(index)
} else {
error("Either key or index should not be null")
}
}
/**
* Gets the fragment value. The value types are Blob, Array, Dictionary, Number,
* or String based on the underlying data type; or null if the value is null.
*/
public open val value: Any?
get() = when (parent) {
is Document -> parent.getValue(key!!)
is Dictionary -> parent.getValue(key!!)
is Array -> parent.getValue(index!!)
is Result -> parent.select({
getValue(it)
}, {
getValue(it)
})
else -> null
}
/**
* Gets the value as a string. Returns null if the value is null, or the value is not a string.
*/
public open val string: String?
get() = when (parent) {
is Document -> parent.getString(key!!)
is Dictionary -> parent.getString(key!!)
is Array -> parent.getString(index!!)
is Result -> parent.select({
getString(it)
}, {
getString(it)
})
else -> null
}
/**
* Gets the value as a Number. Returns null if the value
* doesn't exist, or its value is not a Number.
*/
public open val number: Number?
get() = when (parent) {
is Document -> parent.getNumber(key!!)
is Dictionary -> parent.getNumber(key!!)
is Array -> parent.getNumber(index!!)
is Result -> parent.select({
getNumber(it)
}, {
getNumber(it)
})
else -> null
}
/**
* Gets the value as an int. Floating point values will be rounded. The value true is
* returned as 1, false as 0. Returns 0 if the value is null or is not a numeric value.
*/
public open val int: Int
get() = when (parent) {
is Document -> parent.getInt(key!!)
is Dictionary -> parent.getInt(key!!)
is Array -> parent.getInt(index!!)
is Result -> parent.select({
getInt(it)
}, {
getInt(it)
})
else -> 0
}
/**
* Gets the value as a long. Floating point values will be rounded. The value true is
* returned as 1, false as 0. Returns 0 if the value is null or is not a numeric value.
*/
public open val long: Long
get() = when (parent) {
is Document -> parent.getLong(key!!)
is Dictionary -> parent.getLong(key!!)
is Array -> parent.getLong(index!!)
is Result -> parent.select({
getLong(it)
}, {
getLong(it)
})
else -> 0
}
/**
* Gets the value as a float. Integers will be converted to float. The value true is
* returned as 1.0, false as 0.0. Returns 0.0 if the value is null or is not a numeric value.
*/
public open val float: Float
get() = when (parent) {
is Document -> parent.getFloat(key!!)
is Dictionary -> parent.getFloat(key!!)
is Array -> parent.getFloat(index!!)
is Result -> parent.select({
getFloat(it)
}, {
getFloat(it)
})
else -> 0F
}
/**
* Gets the value as a double. Integers will be converted to double. The value true is
* returned as 1.0, false as 0.0. Returns 0.0 if the value is null or is not a numeric value.
*/
public open val double: Double
get() = when (parent) {
is Document -> parent.getDouble(key!!)
is Dictionary -> parent.getDouble(key!!)
is Array -> parent.getDouble(index!!)
is Result -> parent.select({
getDouble(it)
}, {
getDouble(it)
})
else -> 0.0
}
/**
* Gets the value as a boolean. Returns true if the value
* is not null, and is either true or a nonzero number.
*/
public open val boolean: Boolean
get() = when (parent) {
is Document -> parent.getBoolean(key!!)
is Dictionary -> parent.getBoolean(key!!)
is Array -> parent.getBoolean(index!!)
is Result -> parent.select({
getBoolean(it)
}, {
getBoolean(it)
})
else -> false
}
/**
* Get the value as a Blob. Returns null if the value is null, or the value is not a Blob.
*/
public open val blob: Blob?
get() = when (parent) {
is Document -> parent.getBlob(key!!)
is Dictionary -> parent.getBlob(key!!)
is Array -> parent.getBlob(index!!)
is Result -> parent.select({
getBlob(it)
}, {
getBlob(it)
})
else -> null
}
/**
* Gets the value as a date. JSON does not directly support dates, so the actual property value
* must be a string, which is then parsed according to the ISO-8601 date format (the default
* used in JSON.) Returns null if the value is null, is not a string, or is not parseable as a
* date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with
* or without milliseconds.
*/
public open val date: Instant?
get() = when (parent) {
is Document -> parent.getDate(key!!)
is Dictionary -> parent.getDate(key!!)
is Array -> parent.getDate(index!!)
is Result -> parent.select({
getDate(it)
}, {
getDate(it)
})
else -> null
}
/**
* Get the value as an Array, a mapping object of an array value.
* Returns null if the value is null, or the value is not an array.
*/
public open val array: Array?
get() = when (parent) {
is Document -> parent.getArray(key!!)
is Dictionary -> parent.getArray(key!!)
is Array -> parent.getArray(index!!)
is Result -> parent.select({
getArray(it)
}, {
getArray(it)
})
else -> null
}
/**
* Get a property’s value as a Dictionary, a mapping object of a dictionary
* value. Returns null if the value is null, or the value is not a dictionary.
*/
public open val dictionary: Dictionary?
get() = when (parent) {
is Document -> parent.getDictionary(key!!)
is Dictionary -> parent.getDictionary(key!!)
is Array -> parent.getDictionary(index!!)
is Result -> parent.select({
getDictionary(it)
}, {
getDictionary(it)
})
else -> null
}
/**
* Checks whether the value held by the fragment object exists or is null value or not.
*/
public val exists: Boolean
get() = value != null
/**
* Subscript access to a Fragment object by index.
*
* @param index The index. If the index value exceeds the bounds of the array,
* the MutableFragment object will represent a nil value.
*/
public open operator fun get(index: Int): Fragment {
val parent = when (parent) {
is Document -> parent.getValue(key!!)
is Dictionary -> parent.getValue(key!!)
is Array -> parent.getValue(this.index!!)
is Result -> parent.select({
getValue(it)
}, {
getValue(it)
})
else -> null
}
return if (parent is Array && index in 0 until parent.count) {
Fragment(parent, null, index)
} else {
Fragment()
}
}
/**
* Subscript access to a Fragment object by key.
*
* @param key The key.
*/
public open operator fun get(key: String): Fragment {
val parent = when (parent) {
is Document -> parent.getValue(this.key!!)
is Dictionary -> parent.getValue(this.key!!)
is Array -> parent.getValue(index!!)
is Result -> parent.select({
getValue(it)
}, {
getValue(it)
})
else -> null
}
return if (parent is Dictionary) {
Fragment(parent, key, null)
} else {
Fragment()
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy