MultipazProject

multipaz/org.multipaz.document/NameSpacedData

NameSpacedData

class NameSpacedData

Key/value pairs, organized by name space.

This class implements a data model which consists of a series of name spaces (identified by a string such as org.iso.18013.5.1) where each name space contains a number of key/value pairs where keys are strings and values are CBOR values.

While this happens to be similar to the mDL/MDOC data model used in ISO/IEC 18013-5:2021, it's flexible enough to be used to store document data for any kind of document.

This type is immutable.

Types

class Builder(nameSpacedDataToCopyFrom: NameSpacedData? = null)

A builder for NameSpacedData.

object Companion

Properties

val nameSpaceNames: List<String>

Names of all the namespaces.

Functions

fun encodeAsCbor(): ByteArray

Encodes the given NameSpacedData as CBOR.

fun getDataElement(nameSpaceName: String, dataElementName: String): ByteArray

Gets the raw CBOR for a data element.

getDataElementBoolean

fun getDataElementBoolean(nameSpaceName: String, dataElementName: String): Boolean

Like .getDataElement but decodes the CBOR as a boolean.

getDataElementByteString

fun getDataElementByteString(nameSpaceName: String, dataElementName: String): ByteArray

Like .getDataElement but decodes the CBOR as a byte string.

getDataElementNames

fun getDataElementNames(nameSpaceName: String): List<String>

Gets all data elements in a given namespace.

getDataElementNumber

fun getDataElementNumber(nameSpaceName: String, dataElementName: String): Long

Like .getDataElement but decodes the CBOR as a number.

getDataElementString

fun getDataElementString(nameSpaceName: String, dataElementName: String): String

Like .getDataElement but decodes the CBOR as a string.

fun hasDataElement(nameSpaceName: String, dataElementName: String): Boolean

Checks if there's a value for a given data element.

fun toDataItem(): DataItem