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



import java.lang.reflect.Constructor;
import java.util.Collection;

import com.hfg.bio.HfgBioXML;
import com.hfg.util.StringUtil;
import com.hfg.xml.XMLNode;

//------------------------------------------------------------------------------
/**
 Interface for instances of plates.
 
 @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 interface Plate extends LabwareContainer, Comparable
{

   public String name();

   public Plate setName(String inValue);


   public String getBarcode();

   public Plate setBarcode(String inValue);


   public PlateType getType();


   public Plate setLayout(PlateLayout inValue);

   public PlateLayout getLayout();


   public W allocateWell(WellRef inWellRef);

   public Plate setWell(W inWell);

   public W getWell(WellRef inRef);

   public boolean isFull();

   public Collection getOccupiedWells();

   //--------------------------------------------------------------------------
   public static Plate instantiate(XMLNode inXMLNode)
   {
      inXMLNode.verifyTagName(AutomationXML.PLATE);

      String classname = inXMLNode.getAttributeValue(HfgBioXML.CLASS_ATT);
      if (! StringUtil.isSet(classname))
      {
         throw new RuntimeException("No " + AutomationXML.CLASS_ATT + " specified on plate's XML tag!");
      }

      Plate plate = null;

      try
      {
         Class clazz = Class.forName(classname);
         Constructor constructor = clazz.getConstructor(XMLNode.class);
         plate = (Plate) constructor.newInstance(inXMLNode);
      }
      catch (Exception e)
      {
         throw new RuntimeException("Error during plate instantiation from its XML tag!", e);
      }

      return plate;
   }
}