ModuleRest.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale 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 3 of the
 * License, or any later version.
 *
 * Squale 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squalerest.model;

import java.util.ArrayList;
import java.util.List;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;

/**
 * Module class used for the export
 */
@XStreamAlias( "module" )
public class ModuleRest
{

    /**
     * The name of the module
     */
    @XStreamAsAttribute
    private String name;
    
    /**
     * The grid link to the module
     */
    @XStreamAsAttribute
    private String grid;

    /**
     * The id of the module
     */
    @XStreamAsAttribute
    private String id;

    /**
     * The list of factor of the module
     */
    @XStreamImplicit
    private List<FactorRest> datas;

    /**
     * The list of tag of the module
     */
    private List<TagRest> tags;

    /**
     * The list of volumetry measure linked to the module
     */
    @XStreamImplicit
    private List<VolumetryRest> volumetry;

    /**
     * Default constructor
     */
    public ModuleRest()
    {
        datas = new ArrayList<FactorRest>();
        tags = new ArrayList<TagRest>();
        volumetry = new ArrayList<VolumetryRest>();
    }

    /**
     * Constructor
     * 
     * @param pId The id of the module
     * @param pName The name of the module
     * @param pGrid The grid linked to the module
     */
    public ModuleRest( String pId, String pName, String pGrid )
    {
        id = pId;
        name = pName;
        grid = pGrid;
        //datas = new ArrayList<FactorRest>();
        //tags = new ArrayList<TagRest>();
        //volumetry = new ArrayList<VolumetryRest>();
    }

    /**
     * Getter method for the attribute id
     * 
     * @return The id of the module
     */
    public String getId()
    {
        return id;
    }

    /**
     * Setter method for the attribute id
     * 
     * @param pId The new id of the module
     */
    public void setId( String pId )
    {
        id = pId;
    }

    /**
     * Getter method for the attribute name
     * 
     * @return The name of the module
     */
    public String getName()
    {
        return name;
    }

    /**
     * Setter method for the attribute name
     * 
     * @param pName The new name of the module
     */
    public void setName( String pName )
    {
        name = pName;
    }

    /**
     * Getter method for the attribute datas
     * 
     * @return The list of data linked to the module
     */
    public List<FactorRest> getDatas()
    {
        return datas;
    }

    /**
     * Add a factor to the list of datas
     * 
     * @param factor The factor to add
     */
    public void addDatas( FactorRest factor )
    {
        if(datas == null)
        {
            datas = new ArrayList<FactorRest>();
        }
        datas.add( factor );
    }

    /**
     * Getter method for the attribute tags
     * 
     * @return The list of tags linked to the module
     */
    public List<TagRest> getTags()
    {
        return tags;
    }

    /**
     * Setter method for the attribute tags
     * 
     * @param pTags The new list of tags
     */
    public void setTags( List<TagRest> pTags )
    {
        tags = pTags;
    }

    /**
     * Getter method for the attribute volumetry
     * 
     * @return The volumetry The list of volumetry informations
     */
    public List<VolumetryRest> getVolumetry()
    {
        return volumetry;
    }

    /**
     * Add a volumetry value
     * 
     * @param volumetryValue A volumetry value
     */
    public void addVolumetry( VolumetryRest volumetryValue )
    {
        if(volumetry == null)
        {
            volumetry =  new ArrayList<VolumetryRest>();
        }
        volumetry.add( volumetryValue );
    }

    /**
     * Getter method for the grid attribute
     * 
     * @return The grid linked to the module
     */
    public String getGrid()
    {
        return grid;
    }

    /**
     * Setter method for the grid attribute
     * 
     * @param pGrid The new grid linked to the module
     */
    public void setGrid( String pGrid )
    {
        this.grid = pGrid;
    }

}