org.appops.job.JobPipeline Maven / Gradle / Ivy

Go to download
/*
 * AppOps is a Java framework to develop, deploy microservices with ease and is available for free
 * and common use developed by AinoSoft ( www.ainosoft.com )
 *
 * AppOps and AinoSoft are registered trademarks of Aino Softwares private limited, India.
 *
 * Copyright (C) <2016> 
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version along with applicable additional terms as
 * provisioned by GPL 3.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License and applicable additional terms
 * along with this program.
 *
 * If not, see  and 
 */


package org.appops.job;

import java.util.LinkedList;

/**
 * A {@link org.appops.job.JobStage} list that describes the jobs configuration. It contains list of
 * meta information required for job execution.
 *
 * @author suraj
 * @version $Id: $Id
 */
public class JobPipeline extends JobStage {
  private LinkedList jobStageList;
  private String ioConverterInterfaceName;
  private String ioConverterServiceName;

  /**
   * Default constructor where guid is generated using {@link org.appops.core.GuidGenerator} and set
   * to {@link org.appops.job.JobPipeline}.
   */
  public JobPipeline() {

  }

  /**
   * {@link java.util.LinkedList} of {@link org.appops.job.JobStage}.
   *
   * @return list of job stages.
   */
  public LinkedList getJobStageList() {
    if (jobStageList == null) {
      jobStageList = new LinkedList();
    }
    return jobStageList;
  }

  /**
   * 
   * Setter for the field jobStageList.
   * 
   *
   * @param jobStageList a {@link java.util.LinkedList} object.
   */
  public void setJobStageList(LinkedList jobStageList) {
    this.jobStageList = jobStageList;
  }

  /**
   * Add Job stage into job pipeline.
   *
   * @param jobStage job stage to be add into job pipeline.
   * @return true if added successfully otherwise false.
   */
  public boolean jobEntry(JobStage jobStage) {
    jobStage.setGuid(this.getGuid());
    return getJobStageList().add(jobStage);
  }

  /**
   * It returns the first {@link org.appops.job.JobStage} from JobPipeline.
   *
   * @return first {@link org.appops.job.JobStage} from JobPipeline.
   */
  public JobStage popFirstJobStage() {
    if (this.jobStageList != null && !this.jobStageList.isEmpty()) {
      JobStage jobStage = this.jobStageList.get(0);
      jobStageList.remove(jobStage);
      return jobStage;
    }
    return null;
  }

  /**
   * 
   * Getter for the field ioConverterInterfaceName.
   * 
   *
   * @return a {@link java.lang.String} object.
   */
  public String getIoConverterInterfaceName() {
    return ioConverterInterfaceName;
  }

  /**
   * 
   * Setter for the field ioConverterInterfaceName.
   * 
   *
   * @param ioConverterInterfaceName a {@link java.lang.String} object.
   */
  public void setIoConverterInterfaceName(String ioConverterInterfaceName) {
    this.ioConverterInterfaceName = ioConverterInterfaceName;
  }

  /**
   * 
   * Getter for the field ioConverterServiceName.
   * 
   *
   * @return a {@link java.lang.String} object.
   */
  public String getIoConverterServiceName() {
    return ioConverterServiceName;
  }

  /**
   * 
   * Setter for the field ioConverterServiceName.
   * 
   *
   * @param ioConverterServiceName a {@link java.lang.String} object.
   */
  public void setIoConverterServiceName(String ioConverterServiceName) {
    this.ioConverterServiceName = ioConverterServiceName;
  }

}