aboutsummaryrefslogtreecommitdiff
path: root/src/net/cbaines/suma/Bus.java
blob: b36dd89e408b077ebe195660a51393e52c3e8335 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Southampton University Map App
 * Copyright (C) 2011  Christopher Baines
 * 
 * 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 net.cbaines.suma;

import com.j256.ormlite.field.DatabaseField;
import com.j256.ormlite.table.DatabaseTable;

/**
 * Represents a bus
 * 
 * @author Christopher Baines <cbaines8@gmail.com>
 * 
 */
@DatabaseTable(tableName = "buses")
public class Bus {

    final static String ID_FIELD_NAME = "id";
    final static String ROUTE_FIELD_NAME = "route";
    final static String DIRECTION_FIELD_NAME = "direction";

    @DatabaseField(generatedId = true)
    int gid;

    /**
     * The identification number of the bus.
     */
    @DatabaseField(canBeNull = true)
    String id;

    /**
     * The route the bus is travelling.
     */
    @DatabaseField(canBeNull = false, foreign = true)
    BusRoute route;

    /**
     * The direction which the bus is travelling.
     */
    @DatabaseField(canBeNull = true)
    String direction;

    /**
     * The destination the bus is travelling towards.
     */
    @DatabaseField(canBeNull = true, foreign = true)
    BusStop destination;

    Bus() {
    }

    /**
     * Create a bus.
     * 
     * @param id
     *            The identification number of the bus.
     * @param route
     *            The route the bus is travelling.
     * @param dir
     *            The direction which the bus is travelling.
     */
    Bus(String id, BusRoute route, String direction) {
	this.id = id;
	this.route = route;
	this.direction = direction;
    }

    /**
     * Create a bus.
     * 
     * @param id
     *            The identification number of the bus.
     * @param route
     *            The route the bus is travelling.
     */
    Bus(String id, BusRoute route) {
	this(id, route, null);
    }

    public String toString() {
	return String.valueOf(id + " (" + route.code + direction + ")");
    }

    String getName() {
	if (direction != null) {
	    return route.code + direction;
	} else {
	    return route.code;
	}
    }

    @Override
    public int hashCode() {
	final int prime = 31;
	int result = 1;
	result = prime * result + gid;
	return result;
    }

    @Override
    public boolean equals(Object obj) {
	if (this == obj)
	    return true;
	if (obj == null)
	    return false;
	if (getClass() != obj.getClass())
	    return false;
	Bus other = (Bus) obj;
	if (id != other.id)
	    return false;
	return true;
    }

}