TrackerStructure.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.squaleweb.applicationlayer.tracker;

import java.io.Serializable;

/**
 * Classe qui d�finit un objet utile seulement pour le traceur
 * 
 * @author M403988
 */
public class TrackerStructure implements Serializable
{

    /**
     * La liste des types possibles
     */
    /**
     * Cette valeur est pour quand on est pass� par une vue Facteur
     */
    public final static int FACTOR_VIEW = 0;

    /**
     * Cette valeur est pour quand on est pass� par une vue Composant
     */
    public final static int COMPONENT_VIEW = 1;

    /**
     * Cette valeur est pour quand on est pass� par une vue Top
     */
    public final static int TOP_VIEW = 2;

    /**
     * Valeur par d�fault
     */
    public final static int UNDEFINED = 3;

    /**
     * Le nom du lien tel qu'il est affich�
     */
    private String mDisplayName;

    /**
     * La valeur du lien
     */
    private String mLink;

    /**
     * Le type de l'�l�ment
     */
    private int mType;

    /**
     * Constructeur sans parametres
     */
    public TrackerStructure()
    {
        mDisplayName = "";
        mLink = "";
        mType = UNDEFINED;
    }

    /**
     * Constructeur
     * 
     * @param pDisplayName le nouveau nom � afficher
     * @param pLink le nouveau lien
     * @param pType le nouveau type
     */
    public TrackerStructure( String pDisplayName, String pLink, int pType )
    {
        mDisplayName = pDisplayName;
        mLink = pLink;
        mType = pType;
    }

    /**
     * @return le nom du lien tel qu'affich�
     */
    public String getDisplayName()
    {
        return mDisplayName;
    }

    /**
     * @return la valeur du lien
     */
    public String getLink()
    {
        return mLink;
    }

    /**
     * @return le type de l'�l�ment
     */
    public int getType()
    {
        return mType;
    }

    /**
     * @param pDisplayName le nouveau nom
     */
    public void setDisplayName( String pDisplayName )
    {
        mDisplayName = pDisplayName;
    }

    /**
     * @param pLink la nouvelle valeur du lien
     */
    public void setLink( String pLink )
    {
        mLink = pLink;
    }

    /**
     * @param pType le nouveau type de l'�l�ment
     */
    public void setType( int pType )
    {
        mType = pType;
    }

}