com.hfg.automation.tecan.plateop.TecanPlateOp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.automation.tecan.plateop;


import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;

import com.hfg.automation.plateop.PlateOp;
import com.hfg.automation.tecan.TecanDeckConfig;
import com.hfg.util.StringUtil;
import com.hfg.util.collection.CollectionUtil;

//------------------------------------------------------------------------------
/**
 Base class for Tecan plate operations.
 
 @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public abstract class TecanPlateOp implements PlateOp, Cloneable
{
   private String           mName;
   private TecanDeckConfig mDeckConfig;
   private String           mComment;
   private Integer          mOutputOrder;
   private List     mWarnings;

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   public TecanPlateOp setName(String inValue)
   {
      mName = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public String name()
   {
      return (StringUtil.isSet(mName) ? mName : getClass().getSimpleName());
   }

   //---------------------------------------------------------------------------
   public TecanPlateOp setDeckConfig(TecanDeckConfig inValue)
   {
      mDeckConfig = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public TecanDeckConfig getDeckConfig()
   {
      return mDeckConfig;
   }


   //---------------------------------------------------------------------------
   public abstract void generateWorklist(OutputStream inStream) throws IOException;

   //---------------------------------------------------------------------------
   public TecanPlateOp setComment(String inValue)
   {
      mComment = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public String getComment()
   {
      return mComment;
   }


   //---------------------------------------------------------------------------
   public boolean producedWarnings()
   {
      return CollectionUtil.hasValues(mWarnings);
   }

   //---------------------------------------------------------------------------
   public List getWarnings()
   {
      return mWarnings;
   }


   //---------------------------------------------------------------------------
   /**
    If the protocol is instructed to output a single worklist, the output of the
    plate operations can be ordered independent of their execution order by setting
    output orders via this method.
    * @param inValue the order of this plate op's output with a worklist
    * @return this op object to facilitate method chaining
    */
   public TecanPlateOp setOutputOrder(Integer inValue)
   {
      mOutputOrder = inValue;
      return this;
   }

   //---------------------------------------------------------------------------
   public Integer getOutputOrder()
   {
      return mOutputOrder;
   }

   //---------------------------------------------------------------------------
   protected void addWarning(String inValue)
   {
      if (null == mWarnings)
      {
         mWarnings = new ArrayList<>(10);
      }

      mWarnings.add(inValue);
   }

}