lost.tok.Author.java Source code

Introduction

Here is the source code for lost.tok.Author.java

Source

/* Tree of Knowledge - An information management Eclipse plugin
 * Copyright (C) 2007 Team Lost
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program 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 General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 
 * Boston, MA  02110-1301, USA.
 */

package lost.tok;

import org.dom4j.DocumentHelper;
import org.dom4j.Element;

/**
 * Contains all data related to an author of
 * a source in tree of knowledge
 * @author evgeni
 *
 */
public class Author {

    private Integer ID;
    public String name;
    public Integer rank;

    /**
     * Author class constructor
     * @param authRank
     * @param authName
     */
    public Author(Integer authRank, String authName) {
        name = authName;
        rank = authRank;
        ID = Math.abs(hashCode());
    }

    /**
     * Author class default constructor
     */
    public Author() {
    }

    /**
     * Set authors ID
     * @param authID
     */
    public void setID(Integer authID) {
        ID = authID;
    }

    /**
     * Get authors ID
     * @return
     */
    public Integer getID() {
        return ID;
    }

    /**
     * Set authors rank
     * @param authRank
     */
    public void setRank(Integer authRank) {
        rank = authRank;
    }

    /**
     * Get authors rank
     * @return
     */
    public Integer getRank() {
        return rank;
    }

    /**
     * Set authors name
     * @param authName
     */
    public void setName(String authName) {
        name = authName;
    }

    /**
     * Get authors name
     * @return
     */
    public String getName() {
        return name;
    }

    /**
     * Creating an author XML element
     * 
     * @return Element of Author
     */
    public Element toXML() {
        Element e = DocumentHelper.createElement("author"); //$NON-NLS-1$
        e.addText(getName());

        return e;
    }

    /**
     * Create authors hash code
     */
    public int hashCode() {
        return 57 * name.hashCode();
    }
}