com.hfg.automation.tecan.TecanDeckConfig 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;


import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import com.hfg.automation.AutomationConfigurationException;
import com.hfg.automation.PlateRole;
import com.hfg.util.StringUtil;
import com.hfg.util.collection.CollectionUtil;
import com.hfg.util.collection.OrderedMap;

//------------------------------------------------------------------------------
/**
 Tecan deck configuration.
 
 @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 class TecanDeckConfig
{
   private String mName;
   private Map mDeckPositionMap;


   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //---------------------------------------------------------------------------
   public TecanDeckConfig(String inName)
   {
      setName(inName);
   }

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

   //---------------------------------------------------------------------------
   @Override
   public String toString()
   {
      return name();
   }

   //---------------------------------------------------------------------------
   public String name()
   {
      return mName;
   }

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

   //---------------------------------------------------------------------------
   public TecanDeckConfig defineDeckPosition(TecanDeckPosition inValue)
   {
      if (null == mDeckPositionMap)
      {
         mDeckPositionMap = new OrderedMap<>(5);
      }

      mDeckPositionMap.put(inValue.getLabel(), inValue);

      return this;
   }

   //---------------------------------------------------------------------------
   public List getDeckPositions()
   {
      return new ArrayList<>(mDeckPositionMap.values());
   }

   //---------------------------------------------------------------------------
   public List getDeckPositions(TecanLabwareContainerType inContainerType)
   {
      List requestedDeckPositions = null;

      if (CollectionUtil.hasValues(mDeckPositionMap))
      {
         for (TecanDeckPosition deckPosition : mDeckPositionMap.values())
         {
            if (deckPosition.getContainerType().equals(inContainerType))
            {
               if (null == requestedDeckPositions)
               {
                  requestedDeckPositions = new ArrayList<>(4);
               }

               requestedDeckPositions.add(deckPosition);
            }
         }
      }

      return requestedDeckPositions;
   }

   //---------------------------------------------------------------------------
   public TecanDeckPosition getDeckPosition(String inLabel)
   {
      return (mDeckPositionMap != null ? mDeckPositionMap.get(inLabel) : null);
   }

   //---------------------------------------------------------------------------
   public List getDeckPositionsByRole(PlateRole inRole)
   {
      List deckPositions = null;
      if (CollectionUtil.hasValues(mDeckPositionMap))
      {
         for (TecanDeckPosition deckPosition : mDeckPositionMap.values())
         {
            if (deckPosition.getRole() != null
                && deckPosition.getRole().equals(inRole))
            {
               if (null == deckPositions)
               {
                  deckPositions = new ArrayList<>(10);
               }

               deckPositions.add(deckPosition);
            }
         }
      }

      return deckPositions;
   }

   //---------------------------------------------------------------------------
   public void validateDeckPosition(String inTecanLabel)
   {
      if (CollectionUtil.hasValues(mDeckPositionMap)
            && ! mDeckPositionMap.containsKey(inTecanLabel))
      {
         throw new AutomationConfigurationException("The Tecan label " + StringUtil.singleQuote(inTecanLabel) + " is not defined in the deck configuration!");
      }
   }

}