org.transitime.db.structs

Class Agency

java.lang.Object

org.transitime.db.structs.Agency

All Implemented Interfaces:

java.io.Serializable

@Entity
public class Agency
extends java.lang.Object
implements java.io.Serializable

Contains data from the agency.txt GTFS file. This class is for reading/writing that data to the db.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Agency(int configRev, GtfsAgency gtfsAgency, java.util.List<Route> routes) For creating object to be written to db.

Method Summary

Modifier and Type	Method and Description
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes rev from the Agencies table
boolean	equals(java.lang.Object obj) Needed because have a composite ID for Hibernate storage
static java.util.List<Agency>	getAgencies(org.hibernate.Session session, int configRev) Returns List of Agency objects for the specified database revision.
static java.util.List<Agency>	getAgencies(java.lang.String agencyId, int configRev) Returns the list of agencies for the specified project ID.
int	getConfigRev()
Extent	getExtent()
java.lang.String	getFareUrl()
java.lang.String	getId() Note that this method returns the GTFS agency_id which is usually different from the Transitime agencyId
java.lang.String	getLang()
java.lang.String	getName()
java.lang.String	getPhone()
Time	getTime() Returns cached Time object which allows one to easly convert epoch time to time of day and such.
java.util.TimeZone	getTimeZone() Returns cached TimeZone object for agency.
static java.util.TimeZone	getTimeZoneFromDb(java.lang.String agencyId) Reads the current timezone for the agency from the agencies database
java.lang.String	getTimeZoneStr() Valid timezone format is at http://en.wikipedia.org/wiki/List_of_tz_zones
java.lang.String	getUrl()
int	hashCode() Needed because have a composite ID for Hibernate storage
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Agency

public Agency(int configRev,
              GtfsAgency gtfsAgency,
              java.util.List<Route> routes)

For creating object to be written to db.

Parameters:

configRev -

gtfsAgency -

routes -

Method Detail

deleteFromRev

public static int deleteFromRev(org.hibernate.Session session,
                                int configRev)
                         throws org.hibernate.HibernateException

Deletes rev from the Agencies table

Parameters:

session -

configRev -

Returns:

Number of rows deleted

Throws:

org.hibernate.HibernateException

getAgencies

public static java.util.List<Agency> getAgencies(org.hibernate.Session session,
                                                 int configRev)
                                          throws org.hibernate.HibernateException

Returns List of Agency objects for the specified database revision.

Parameters:

session -

configRev -

Returns:

Throws:

org.hibernate.HibernateException

getAgencies

public static java.util.List<Agency> getAgencies(java.lang.String agencyId,
                                                 int configRev)

Returns the list of agencies for the specified project ID.

Parameters:

agencyId - Specifies name of database

configRev -

Returns:

getTimeZoneFromDb

public static java.util.TimeZone getTimeZoneFromDb(java.lang.String agencyId)

Reads the current timezone for the agency from the agencies database

Parameters:

agencyId -

Returns:

The TimeZone, or null if not successful

getTimeZone

public java.util.TimeZone getTimeZone()

Returns cached TimeZone object for agency. Useful for creating Calendar objects and such.

Returns:

The TimeZone object for this agency

getTime

public Time getTime()

Returns cached Time object which allows one to easly convert epoch time to time of day and such.

Returns:

Time object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Needed because have a composite ID for Hibernate storage

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Needed because have a composite ID for Hibernate storage

Overrides:

equals in class java.lang.Object

getConfigRev

public int getConfigRev()

Returns:

the configRev

getId

public java.lang.String getId()

Note that this method returns the GTFS agency_id which is usually different from the Transitime agencyId

Returns:

the agencyId

getName

public java.lang.String getName()

Returns:

the agencyName

getUrl

public java.lang.String getUrl()

Returns:

the agencyUrl

getTimeZoneStr

public java.lang.String getTimeZoneStr()

Valid timezone format is at http://en.wikipedia.org/wiki/List_of_tz_zones

Returns:

the agencyTimezone as a String

getLang

public java.lang.String getLang()

Returns:

the agencyLang

getPhone

public java.lang.String getPhone()

Returns:

the agencyPhone

getFareUrl

public java.lang.String getFareUrl()

Returns:

the agencyFareUrl

getExtent

public Extent getExtent()

Returns:

The extent of all the stops for the agency