com.wgzhao.addax.common.spi.Writer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of addax-common Show documentation

There is a newer version: 4.1.4

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.wgzhao.addax.common.spi;

import com.wgzhao.addax.common.base.BaseObject;
import com.wgzhao.addax.common.plugin.AbstractJobPlugin;
import com.wgzhao.addax.common.plugin.AbstractTaskPlugin;
import com.wgzhao.addax.common.plugin.RecordReceiver;
import com.wgzhao.addax.common.util.Configuration;

import java.util.List;

/**
 * 每个Writer插件需要实现Writer类，并在其内部实现Job、Task两个内部类。
 */
public abstract class Writer
        extends BaseObject
{
    /**
     * 每个Writer插件必须实现Job内部类
     */
    public abstract static class Job
            extends AbstractJobPlugin
    {
        /**
         * 切分任务。

         *
         * @param mandatoryNumber 为了做到Reader、Writer任务数对等，这里要求Writer插件必须按照源端的切分数进行切分。否则框架报错！
         *
         * @return list of configuration
         */
        public abstract List split(int mandatoryNumber);
    }

    /**
     * 每个Writer插件必须实现Task内部类
     */
    public abstract static class Task
            extends AbstractTaskPlugin
    {

        public abstract void startWrite(RecordReceiver lineReceiver);

        public boolean supportFailOver() {return false;}
    }
}