com.orientechnologies.orient.etl.OETLComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of orientdb-etl Show documentation

ETL tools for OrientDB NoSQL document graph dbms

The newest version!

/*
 *
 *  * Copyright 2010-2016 OrientDB LTD (info(-at-)orientdb.com)
 *  *
 *  * 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.orientechnologies.orient.etl;

import com.orientechnologies.orient.core.command.OCommandContext;
import com.orientechnologies.orient.core.db.document.ODatabaseDocument;
import com.orientechnologies.orient.core.record.impl.ODocument;
import com.orientechnologies.orient.etl.context.OETLContext;

/** ETL basic component. Each ETL component must implement this interface. */
public interface OETLComponent {

  /** @return */
  ODocument getConfiguration();

  /**
   * Called by the @OETLProcessor
   *
   * @param configuration
   * @param context
   */
  void configure(ODocument configuration, OCommandContext context);

  void begin(ODatabaseDocument db);

  void end();

  /**
   * Return the symbolic name of the component
   *
   * @return the name of the component
   */
  String getName();

  OETLContext getContext();

  OETLProcessor getProcessor();

  void setProcessor(OETLProcessor processor);
}