com.dimajix.flowman.spec.history.HistorySpec.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.history

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.dimajix.common.TypeRegistry
import com.dimajix.flowman.execution.Context
import com.dimajix.flowman.history.StateStore
import com.dimajix.flowman.spec.Spec
import com.dimajix.flowman.spec.annotation.HistoryType
import com.dimajix.flowman.spi.ClassAnnotationHandler


object HistorySpec extends TypeRegistry[HistorySpec] {
}


@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true)
@JsonSubTypes(value = Array(
    new JsonSubTypes.Type(name = "none", value = classOf[NullHistorySpec]),
    new JsonSubTypes.Type(name = "jdbc", value = classOf[JdbcHistorySpec])
))
abstract class HistorySpec extends Spec[StateStore] {
    @JsonProperty(value="kind", access=Access.WRITE_ONLY, required = true) protected var kind: String = _

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

    /**
     * Returns a set of common properties
     *
     * @param context
     * @return
     */
    protected def instanceProperties(context: Context, properties: Option[StateStore.Properties]): StateStore.Properties = {
        require(context != null)
        val props = StateStore.Properties(
            context,
            kind
        )
        props
    }
}



class HistorySpecAnnotationHandler extends ClassAnnotationHandler {
    override def annotation: Class[_] = classOf[HistoryType]

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