com.github.jessemull.microflex.doubleflex.io.WellSetListPOJODouble Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microflex Show documentation
Microplate library for parsing wet lab data.
There is a newer version: 1.0.4
/**
 * 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.microflex.doubleflex.io;

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

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import com.github.jessemull.microflex.doubleflex.plate.WellSetDouble;

/**
 * This is a wrapper class for importing or exporting a list of JSON encoded well set objects.
 * 
 * @author Jesse L. Mull
 * @update Updated Oct 17, 2016
 * @address http://www.jessemull.com
 * @email [email protected]
 */
public class WellSetListPOJODouble implements Iterable {
	
	/*---------------------------- Private fields ----------------------------*/
	
	private List wellsets = new ArrayList();
	
	/*------------------------------ Constructors ----------------------------*/
	
	public WellSetListPOJODouble(){}
	
    /**
     * Creates a well set list POJO from a well set object.
     * @param    WellSetDouble    the well set object
     */
    public WellSetListPOJODouble(WellSetDouble single) {
      this.wellsets.add(new WellSetPOJODouble(single));
    }
    
    /**
     * Creates a well set list POJO from a collection of well set objects.
     * @param    Collection    the collection of sets
     */
    public WellSetListPOJODouble(Collection collection) {
        for(WellSetDouble set : collection) {
            this.wellsets.add(new WellSetPOJODouble(set));
        }
    }
    
    /**
     * Creates a well set list POJO from an array of well set objects.
     * @param    WellSetDouble    the well set object
     */
    public WellSetListPOJODouble(WellSetDouble[] array) {
        for(WellSetDouble set : array) {
            this.wellsets.add(new WellSetPOJODouble(set));
        }
    }
    
    /*------------------------- Getters and setters --------------------------*/
    
    /**
     * Sets the list of well sets.
     * @param   List    the new list of well sets
     */
    public void setWellsets(List wellsets) {
        this.wellsets = wellsets;
    }
      
    /**
     * Returns the list of sets.
     * @return    the list of well sets
     */
    public List getWellsets() {
    	return this.wellsets;
    }
    
    /**
     * Returns the well set at the indicated index.
     * @param    int    the index into the well list
     * @return          the well set POJO
     */
    public WellSetPOJODouble get(int index) {
        return this.wellsets.get(index);
    }
    
    /*----------------- Methods for iterating over the list ------------------*/
    
    /**
     * Returns an iterator for the list of well sets.
     * @return    the iterator
     */
    public Iterator iterator() {
        return this.wellsets.iterator();
    }
    
    /**
     * Returns the size of the well set list.
     * @return    the size of the list
     */
    public int size() {
        return this.wellsets.size();
    }
}