com.hfg.util.collection.DataTable 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.util.collection;



import com.hfg.html.HTMLTag;
import com.hfg.html.Span;

import java.lang.reflect.Method;
import java.util.Map;
import java.util.Set;

//------------------------------------------------------------------------------
/**
 Table containing sets of subject metadata.
 
  @author J. Alex Taylor, hairyfatguy.com
 
 */
//------------------------------------------------------------------------------
// com.hfg 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 DataTable extends AbstractSparseMatrix
{
   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------
   public DataTable()
   {
      super();
   }

   //--------------------------------------------------------------------------
   public DataTable(int inInitialRowCapacity, int inInitialColCapacity)
   {
      super(inInitialRowCapacity, inInitialColCapacity);
   }

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

   //--------------------------------------------------------------------------
   public DataTable addDataSet(DataColumn inDataColumn, Map inDataMap)
   {
      for (String subjectId : inDataMap.keySet())
      {
         put(subjectId, inDataColumn, inDataMap.get(subjectId));
      }

      return this;
   }

   //--------------------------------------------------------------------------
   public Map getRowData(String inRowKey)
   {
      return getRow(inRowKey);
   }

   //--------------------------------------------------------------------------
   public Map getDataSet(DataColumn inDataColumn)
   {
      return getCol(inDataColumn);
   }

   //--------------------------------------------------------------------------
   public Set getDataColumns()
   {
      return colKeySet();
   }

   //--------------------------------------------------------------------------
   public DataColumn getDataColumn(String inName)
   {
      DataColumn requestedCol = null;

      Set dataColumns = getDataColumns();
      if (CollectionUtil.hasValues(dataColumns))
      {
         for (DataColumn col : dataColumns)
         {
            if (col.getTitle().equals(inName))
            {
               requestedCol = col;
               break;
            }
         }
      }

      return requestedCol;
   }

   //--------------------------------------------------------------------------
   @Override
   public void removeCol(DataColumn inCol)
   {
      super.removeCol(inCol);
   }

   //--------------------------------------------------------------------------
   @Override
   public Set rowKeySet()
   {
      return super.rowKeySet();
   }

   //--------------------------------------------------------------------------
   /**
    Uses a formatting string (like "%.1f%%") specified via the DataColumn to
    render the object value for display.
    * @param inId subject key
    * @param inDataColumn the data column from which to retrieve the value
    * @return the String-formatted value
    */
   public String getFormatted(String inId, DataColumn inDataColumn)
   {
      String formattedValue = "";
      Object value = get(inId, inDataColumn);
      if (value != null)
      {
         if (inDataColumn.getFormatString() != null)
         {
            formattedValue = String.format(inDataColumn.getFormatString(), value);
         }
         else
         {
            formattedValue = value.toString();
         }
      }

      return formattedValue;
   }

   //--------------------------------------------------------------------------
   /**
    Uses a formatting string (like "%.1f%%") specified via the DataColumn to
    render the object value for display.
    * @param inId subject key
    * @param inDataColumn the data column from which to retrieve the value
    * @return the String-formatted value
    */
   public HTMLTag getHTMLFormatted(String inId, DataColumn inDataColumn)
   {
      Object value = get(inId, inDataColumn);

      HTMLTag formattedValue;
      try
      {
         Method method = value.getClass().getMethod("toHTMLTag");
         formattedValue = (HTMLTag) method.invoke(value);
      }
      catch (Exception e)
      {
         // Ignore exceptions. Just use the string value.
         formattedValue = new Span(getFormatted(inId, inDataColumn));
      }

      return formattedValue;
   }
}