com.atlan.pkg.serde.cell.GlossaryXformer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of package-toolkit-runtime Show documentation

Atlan custom package runtime toolkit

There is a newer version: 4.2.0

Show newest version

/* SPDX-License-Identifier: Apache-2.0
   Copyright 2023 Atlan Pte. Ltd. */
package com.atlan.pkg.serde.cell

import com.atlan.model.assets.Asset
import com.atlan.model.assets.Glossary
import com.atlan.model.assets.GlossaryTerm
import com.atlan.pkg.PackageContext

/**
 * Static object to transform glossary assignment references.
 */
object GlossaryXformer {
    const val GLOSSARY_DELIMITER = "@@@"

    /**
     * Encodes (serializes) a glossary reference into a string form.
     *
     * @param ctx context in which the package is running
     * @param asset to be encoded
     * @return the string-encoded form for that asset
     */
    fun encode(
        ctx: PackageContext<*>,
        asset: Asset,
    ): String {
        return when (asset) {
            is Glossary -> {
                val glossary = ctx.glossaryCache.getByGuid(asset.guid)
                if (glossary is Glossary) {
                    glossary.name
                } else {
                    ""
                }
            }
            else -> AssetRefXformer.encode(ctx, asset)
        }
    }

    /**
     * Decodes (deserializes) a string form into a glossary reference object.
     *
     * @param ctx context in which the package is running
     * @param assetRef the string form to be decoded
     * @param fieldName the name of the field containing the string-encoded value
     * @return the glossary reference represented by the string
     */
    fun decode(
        ctx: PackageContext<*>,
        assetRef: String,
        fieldName: String,
    ): Asset {
        return when (fieldName) {
            GlossaryTerm.ANCHOR.atlanFieldName -> {
                ctx.glossaryCache.getByIdentity(assetRef)?.trimToReference()
                    ?: throw NoSuchElementException("Parent glossary $assetRef not found (in $fieldName).")
            }
            else -> AssetRefXformer.decode(ctx, assetRef, fieldName)
        }
    }
}