com.github.jessemull.microflexbigdecimal.io.ResultListXML Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microflex-bigdecimal Show documentation
Microplate library for parsing wet lab data.
The newest version!
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 Declaration ----------------------------*/

package com.github.jessemull.microflexbigdecimal.io;

/*------------------------------- Dependencies -------------------------------*/

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

import com.github.jessemull.microflexbigdecimal.plate.Well;

/**
 * This is a wrapper class used to marshal/unmarshal a list of XML encoded results.
 * 
 * @author Jesse L. Mull
 * @update Updated Oct 17, 2016
 * @address http://www.jessemull.com
 * @email [email protected]
 */
@XmlRootElement(name = "results")
public class ResultListXML implements Iterable{
    
	/*---------------------------- Private Fields ----------------------------*/
    
    List results = new ArrayList();    // The results in the list
    
    /*------------------------------ Constructors ----------------------------*/
    
    public ResultListXML(){}
    
    /**
     * Creates an XML result list from a map.
     * @param    Map    the result map
     */
    public ResultListXML(Map map) {
        this.results.add(new ResultXML(map, "Result"));
    }
    
    /**
     * Creates an XML result list from a map and label.
     * @param    Map    the result map
     * @param    String                             the result label
     */
    public ResultListXML(Map map, String label) {
        this.results.add(new ResultXML(map, label));
    }
    
    /**
     * Creates an XML result list from a collection of maps.
     * @param    Collection>    collection of well objects
     */
    public ResultListXML(Collection> collection) {
    	
    	int index = 1;
    	
        for(Map map : collection) {
            this.results.add(new ResultXML(map, "Result" + index++));
        }
    }
    
    /**
     * Creates an XML result list from a collection of maps and a list of labels.
     * @param    Collection>    collection of well objects
     * @param    List                                   the result labels
     */
    public ResultListXML(Collection> collection, List labels) {
    	
    	int index = 0;
    	
        for(Map map : collection) {
            this.results.add(new ResultXML(map, labels.get(index++)));
        }
    }
    
    /*-------------------------- Getters and setters -------------------------*/
    
    /**
     * Sets the list of XML results.
     * @param    List    the new list of results
     */
    @XmlElement(name="result")
    public void setResults(List results) {
        this.results = results;
    }
    
    /**
     * Gets the list of XML results.
     * @return    the list of results
     */
    public List getResults() {
        return this.results;
    }

    /**
     * Returns the result at the index as a well set.
     * @param    int    the index
     * @return          the converted result
     */
    public ResultXML get(int index) {
    	return this.results.get(index);
    }
    
    /**
     * Returns the size of the result list.
     * @return    the result list size
     */
    public int size() {
    	return this.results.size();
    }

    /**
     * Returns an iterator for result list.
     * @return    Iterator
     */
	public Iterator iterator() {
		return results.iterator();
	}

}