com.dimajix.flowman.spec.template.MappingTemplate.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowman-spec Show documentation
A Spark based ETL tool
There is a newer version: 1.2.0-synapse3.3-spark3.3-hadoop3.3
/*
 * Copyright (C) 2021 The Flowman Authors
 *
 * 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 com.dimajix.flowman.spec.template

import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonProperty
import com.kjetland.jackson.jsonSchema.annotations.JsonSchemaInject

import com.dimajix.flowman.execution.Context
import com.dimajix.flowman.model.BaseTemplate
import com.dimajix.flowman.model.Mapping
import com.dimajix.flowman.model.Prototype
import com.dimajix.flowman.model.Template
import com.dimajix.flowman.model.TemplateIdentifier
import com.dimajix.flowman.spec.mapping.MappingSpec


case class MappingTemplate(
    instanceProperties: Template.Properties,
    parameters: Seq[Template.Parameter],
    spec:Prototype[Mapping]
) extends BaseTemplate[Mapping] with com.dimajix.flowman.model.MappingTemplate {
    override protected def instantiateInternal(context: Context, props: Mapping.Properties): Mapping = {
        spec.instantiate(context, Some(props))
    }
}

class MappingTemplateSpec extends TemplateSpec {
    @JsonProperty(value="template", required=true) private var spec:MappingSpec = _

    override def instantiate(context: Context, properties:Option[Template.Properties] = None): MappingTemplate = {
        MappingTemplate(
            instanceProperties(context, properties),
            parameters.map(_.instantiate(context)),
            spec
        )
    }
}


@JsonSchemaInject(
  merge = false,
  json = """
      {
         "additionalProperties" : { "type": "string" },
         "properties" : {
            "kind" : {
               "type" : "string",
               "pattern": "template/.+"
            },
            "metadata" : {
              "$ref" : "#/definitions/MetadataSpec"
            },
            "broadcast" : {
              "type" : [ "boolean", "string" ]
            },
            "checkpoint" : {
              "type" : [ "boolean", "string" ]
            },
            "cache" : {
              "type" : "string"
            },
            "documentation" : {
              "$ref" : "#/definitions/MappingDocSpec"
            }
         }
      }
    """
)
class MappingTemplateInstanceSpec extends MappingSpec {
    @JsonIgnore
    private[spec] var args: Map[String, String] = Map()

    @JsonAnySetter
    private def setArg(name: String, value: String): Unit = {
        args = args.updated(name, value)
    }

    override def instantiate(context: Context, properties:Option[Mapping.Properties] = None): Mapping = {
        // get template name from member "kind"
        // Lookup template in context
        val identifier = TemplateIdentifier(kind.stripPrefix("template/"))
        val template = context.getTemplate(identifier).asInstanceOf[MappingTemplate]
        val props = instanceProperties(context, properties)

        // parse args
        val parsedArgs = template.arguments(context.evaluate(args))
        template.instantiate(context, props, parsedArgs)
    }
}