com.dimajix.flowman.spec.relation.RelationSpec.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) 2018 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.relation

import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonProperty.Access
import com.fasterxml.jackson.annotation.JsonSubTypes
import com.fasterxml.jackson.annotation.JsonTypeInfo
import com.fasterxml.jackson.databind.annotation.JsonTypeResolver

import com.dimajix.common.TypeRegistry
import com.dimajix.flowman.execution.Context
import com.dimajix.flowman.model.Category
import com.dimajix.flowman.model.Metadata
import com.dimajix.flowman.model.Relation
import com.dimajix.flowman.spec.NamedSpec
import com.dimajix.flowman.spec.annotation.RelationType
import com.dimajix.flowman.spec.documentation.RelationDocSpec
import com.dimajix.flowman.spec.template.CustomTypeResolverBuilder
import com.dimajix.flowman.spec.template.RelationTemplateInstanceSpec
import com.dimajix.flowman.spi.ClassAnnotationHandler


object RelationSpec extends TypeRegistry[RelationSpec] {
    final class NameResolver extends NamedSpec.NameResolver[RelationSpec]
}

/**
  * Interface class for declaring relations (for sources and sinks) as part of a model
  */
@JsonTypeResolver(classOf[CustomTypeResolverBuilder])
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible=true)
@JsonSubTypes(value = Array(
    new JsonSubTypes.Type(name = "file", value = classOf[FileRelationSpec]),
    new JsonSubTypes.Type(name = "generic", value = classOf[GenericRelationSpec]),
    new JsonSubTypes.Type(name = "hiveTable", value = classOf[HiveTableRelationSpec]),
    new JsonSubTypes.Type(name = "hiveQuery", value = classOf[HiveQueryRelationSpec]),
    new JsonSubTypes.Type(name = "hiveUnionTable", value = classOf[HiveUnionTableRelationSpec]),
    new JsonSubTypes.Type(name = "hiveView", value = classOf[HiveViewRelationSpec]),
    new JsonSubTypes.Type(name = "jdbcQuery", value = classOf[JdbcQueryRelationSpec]),
    new JsonSubTypes.Type(name = "jdbcTable", value = classOf[JdbcTableRelationSpec]),
    new JsonSubTypes.Type(name = "jdbcView", value = classOf[JdbcViewRelationSpec]),
    new JsonSubTypes.Type(name = "local", value = classOf[LocalRelationSpec]),
    new JsonSubTypes.Type(name = "mock", value = classOf[MockRelationSpec]),
    new JsonSubTypes.Type(name = "empty", value = classOf[EmptyRelationSpec]),
    new JsonSubTypes.Type(name = "provided", value = classOf[ProvidedRelationSpec]),
    new JsonSubTypes.Type(name = "template", value = classOf[TemplateRelationSpec]),
    new JsonSubTypes.Type(name = "values", value = classOf[ValuesRelationSpec]),
    new JsonSubTypes.Type(name = "template/*", value = classOf[RelationTemplateInstanceSpec])
))
abstract class RelationSpec extends NamedSpec[Relation] {
    @JsonProperty(value="kind", access=Access.WRITE_ONLY, required = true) protected var kind: String = _
    @JsonProperty(value="description", required = false) private var description: Option[String] = None
    @JsonProperty(value="documentation", required = false) private var documentation: Option[RelationDocSpec] = None

    override def instantiate(context:Context, properties:Option[Relation.Properties] = None) : Relation

    /**
      * Returns a set of common properties
      * @param context
      * @return
      */
    override protected def instanceProperties(context:Context, properties:Option[Relation.Properties]) : Relation.Properties = {
        require(context != null)
        val name = context.evaluate(this.name)
        val props = Relation.Properties(
            context,
            metadata.map(_.instantiate(context, name, Category.RELATION, kind)).getOrElse(Metadata(context, name, Category.RELATION, kind)),
            context.evaluate(description),
            documentation.map(_.instantiate(context))
        )
        properties.map(p => props.merge(p)).getOrElse(props)
    }
}


class RelationSpecAnnotationHandler extends ClassAnnotationHandler {
    override def annotation: Class[_] = classOf[RelationType]

    override def register(clazz: Class[_]): Unit =
        RelationSpec.register(clazz.getAnnotation(classOf[RelationType]).kind(), clazz.asInstanceOf[Class[_ <: RelationSpec]])
}