/*
GNU General Public License
CacheWolf is a software for PocketPC, Win and Linux that
enables paperless caching.
It supports the sites geocaching.com and opencaching.de

Copyright (C) 2006  CacheWolf development team
See http://www.cachewolf.de/ for more information.
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; version 2 of the License.

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 St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package CacheWolf.database;

import CacheWolf.utils.SafeXML;

/**
 * This contains the basic information of a GC travelbug.
 * 
 * @author salzkammergut
 * 
 */
public class Travelbug {
    /**
     * GC unique id or guid (both are used depending on how the TB is picked up).
     * Travelbugs retrieved from a cache use the guid, travelbugs entered manually
     * use the id
     */
    private String guid; // 0
    /** GC Name i.e. "First Roman Geocoin" */
    private String name; // 1
    /** GC tracking no i.e. 652345, needed for logging */
    private String trackingNo; // 2
    /** GC Mission */
    private String mission; // 3

    /** Construct a travelbug with a given name */
    public Travelbug(String name) {
	this("", name, "");
    }

    /** Construct a travelbug with id, name and mission */
    public Travelbug(String guid, String name, String mission) {
	this.guid = guid;
	this.name = SafeXML.html2iso8859s1(name);
	this.mission = mission;
	setTrackingNo("");
    }

    public String getGuid() {
	return guid;
    }

    public void setGuid(String guid) {
	this.guid = guid;
    }

    public String getName() {
	return name;
    }

    public void setName(String name) {
	this.name = SafeXML.html2iso8859s1(name);
    }

    public String getTrackingNo() {
	return trackingNo;
    }

    public void setTrackingNo(String trackingNo) {
	this.trackingNo = trackingNo;
    }

    public void setMission(String mission) {
	this.mission = mission;
    }

    public String getMission() {
	return this.mission;
    }

    /** Return XML representation of travelbug for storing in cache.xml */
    public String toXML() {
	StringBuffer s = new StringBuffer(300);
	s.append("  <tb guid=\"");
	s.append(guid);
	s.append("\"><name><![CDATA[");
	s.append(name);
	s.append("]]></name><![CDATA[");
	s.append(mission);
	s.append("]]></tb>\n");
	return s.toString();
    }

    /** Return HTML representation of travelbug for display on screen */
    public String toHtml() {
	StringBuffer s = new StringBuffer(300);
	s.append("<b>Name:</b> ");
	s.append(name);
	s.append("<br>");
	s.append(mission);
	s.append("<hr>");
	return s.toString();
    }

}