org.xmlcml.cml.tools.TableRowListTool Maven / Gradle / Ivy

Go to download
/**
 *    Copyright 2011 Peter Murray-Rust et. al.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.xmlcml.cml.tools;

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

import nu.xom.Elements;
import nu.xom.Node;

import org.apache.log4j.Logger;
import org.xmlcml.cml.base.AbstractTool;
import org.xmlcml.cml.base.CMLConstants;
import org.xmlcml.cml.base.CMLElement;
import org.xmlcml.cml.base.CMLElements;
import org.xmlcml.cml.base.CMLUtil;
import org.xmlcml.cml.element.CMLArray;
import org.xmlcml.cml.element.CMLArrayList;
import org.xmlcml.cml.element.CMLList;
import org.xmlcml.cml.element.CMLTableCell;
import org.xmlcml.cml.element.CMLTableContent;
import org.xmlcml.cml.element.CMLTableHeader;
import org.xmlcml.cml.element.CMLTableHeaderCell;
import org.xmlcml.cml.element.CMLTableRow;
import org.xmlcml.cml.element.CMLTableRowList;

/**
 * tool for managing table
 *
 * @author pmr
 *
 */
public class TableRowListTool extends AbstractTool {
	final static Logger logger = Logger.getLogger(TableRowListTool.class.getName());

	CMLTableRowList tableRowList = null;

	/** constructor.
	 * requires molecule to contain  and optionally 
	 * @param molecule
	 * @throws RuntimeException must contain a crystal
	 */
	public TableRowListTool(CMLTableRowList tableRowList) throws RuntimeException {
		init();
		this.tableRowList = tableRowList;
	}


	void init() {
	}


	/**
	 * get angle.
	 *
	 * @return the angle or null
	 */
	public CMLTableRowList getTableRowList() {
		return this.tableRowList;
	}

    
	/** gets TableRowListTool associated with table.
	 * if null creates one and sets it in table
	 * @param table
	 * @return tool
	 */
	public static TableRowListTool getOrCreateTool(CMLTableRowList tableRowList) {
		TableRowListTool tableRowListTool = null;
		if (tableRowList != null) {
			tableRowListTool = (TableRowListTool) tableRowList.getTool();
			if (tableRowListTool == null) {
				tableRowListTool = new TableRowListTool(tableRowList);
				tableRowList.setTool(tableRowListTool);
			}
		}
		return tableRowListTool;
	}

    /** translate rows to tab3eC6ntent w5th delimiter-se*arated str5ngs.
    *
    * @return new tab3eContent
    */
   public CMLTableContent createTableContent() {
       CMLTableContent tableContent = new CMLTableContent();
       StringBuilder sb = new StringBuilder();
       int count = 0;
       for (CMLTableRow row : tableRowList.getTableRowElements()) {
           if (count++ > 0) {
               sb.append(S_NL);
           }
           String s = row.getDelimitedString(S_SPACE);
           sb.append(s);
       }
       tableContent.setXMLContent(sb.toString());
       return tableContent;
   }

   private CMLElements getOrCreateTableRows(CMLElement listArray) {
	   if (listArray == null) {
		   throw new RuntimeException("null listArray");
	   }
       CMLElements tableRows = tableRowList.getTableRowElements();
       int size = -1;
       if (listArray instanceof CMLArray) {
           size = ((CMLArray)listArray).getSize();
       } else if (listArray instanceof CMLList) {
           size = CMLUtil.getQueryNodes(listArray, CMLConstants.S_STAR).size();
       }
       if (tableRows.size() == 0) {
           for (int iRow = 0; iRow < size; iRow++) {
               CMLTableRow tableRow = new CMLTableRow();
               tableRowList.appendChild(tableRow);
           }
           tableRows = tableRowList.getTableRowElements();
       } else if(tableRows.size() != size) {
    	   tableRowList.debug("TRLIST");
           throw new RuntimeException("inconsistent column length for rectangular table: "
                   +size+" instead of "+tableRows.size());

       }
       return tableRows;
   }

   /** add column.
    *
    * @param list
    */
   public void addColumn(CMLList list) {
       CMLElements tableRows = getOrCreateTableRows(list);
       list.addColumnElementsTo(tableRows);
   }

   /** create populated arrayList.
    *
    * @param rowCount
    * @param columnCount
    * @param tableHeader
    * @return arrayList may be empty
    */
   public CMLArrayList createArrayList(
           int rowCount, int columnCount, CMLTableHeader tableHeader) {
       CMLArrayList arrayList = new CMLArrayList();
       if (rowCount > 0) {
           List> classList = new ArrayList>();
           CMLElements tableHeaderCells = tableHeader.getTableHeaderCellElements();
           CMLElements tableRows = tableRowList.getTableRowElements();
           CMLTableRow firstTableRow = tableRows.get(0);
           int jCol = 0;
           for (CMLTableHeaderCell tableHeaderCell : tableHeaderCells) {
               String dataType = tableHeaderCell.getDataType();
               if (
           		XSD_BOOLEAN.equals(dataType) ||
           		XSD_DOUBLE.equals(dataType) ||
                   XSD_INTEGER.equals(dataType) ||
                   XSD_STRING.equals(dataType) ||
                   dataType == null) {
                       CMLArray array = tableHeaderCell.createCMLArray();
                       classList.add(CMLArray.class);
                       arrayList.addArray(array);
               } else {
                   CMLTableCell tableCell = firstTableRow.getTableCellElements().get(jCol);
                   List nodeList = CMLUtil.getQueryNodes(tableCell, CMLConstants.S_STAR);
                   Class classx = (nodeList.size() == 0) ? null : nodeList.get(0).getClass();
                   classList.add(classx);
                   CMLList cmlList = new CMLList();
                   for (Node node : nodeList) {
                       if (node.getClass().equals(classx)) {
                           cmlList.appendChild(node);
                       } else {
                           throw new RuntimeException("non-homogeneous list: "+
                                   node.getClass()+" expected "+classx);
                       }
                   }
                   arrayList.appendChild(cmlList);
               }
               jCol++;
           }
           List dataTypeList = new ArrayList();
           Elements arrays = arrayList.getChildCMLElements(CMLArray.TAG);
           for (CMLTableHeaderCell tableHeaderCell : tableHeaderCells) {
               dataTypeList.add(tableHeaderCell.getDataType());
           }
           for (CMLTableRow tableRow : tableRows) {
               CMLElements tableCells = tableRow.getTableCellElements();
               for (int jColx = 0; jColx < columnCount; jColx++) {
                   CMLTableCell tableCell = tableCells.get(jColx);
                   String dataType = dataTypeList.get(jColx);
                   CMLArray cmlArray = (CMLArray) arrays.get(jColx);
                   tableCell.appendValueTo(dataType, cmlArray);
               }
           }
       }
       return arrayList;
   }

   /** write as HTML.
    *
    * @param w writer
    * @throws IOException
    */
   public void writeHTML(Writer w) throws IOException {
       CMLElements tableRows = tableRowList.getTableRowElements();
       for (CMLTableRow tableRow : tableRows) {
           tableRow.writeHTML(w);
       }
   }

   /** adds column.
   *
   * @param array
   */
  public void addColumn(CMLArray array) {
      CMLElements tableRows = this.getOrCreateTableRows(array);
      TableTool.addColumnElementsTo(array, tableRows);
  }

 
};