org.schedulesdirect.api

Class Lineup

java.lang.Object

org.schedulesdirect.api.Lineup

public class Lineup
extends Object

A Lineup represents a single television lineup available in a Headend

Only an EpgClient can instantiate objects of this class.

When there's a discrepancy between the descriptions of data found in this source code and that found here then the latter web source will always take precedence!

Author:

Derek Battams <derek@battams.ca>

Method Summary

Methods

Modifier and Type	Method and Description
void	fetchDetails(boolean fetchAirings) Fill in the details of this Lineup object
String	getId()
Date	getLastModified()
String	getLocation()
String	getName()
Map<String,List<String>>	getPhysicalStationMap()
Station	getStation(String stationId) Return the Station object for a given Station id in the lineup
Map<String,List<String>>	getStationMap()
Station[]	getStations()
String	getType()
String	getUri()
boolean	hasPhysicalMapping()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

fetchDetails

public void fetchDetails(boolean fetchAirings)
                  throws IOException

Fill in the details of this Lineup object

You must call this method before calling any of the object's accessor methods. The Lineup object is built in a JIT manner.

Until this method is called, a Lineup object only contains minimal data to help identify the lineup it represents. Since most of the details of a Lineup are gathered thru the construction of other objects, their construction is relatively expensive and is therefore implemented in a JIT manner. EpgClients that are accessing data from a local cache (i.e. ZipEpgClient) can usually safely call this method with fetchAirings=true whereas EpgClients hitting the remote Schedules Direct servers to fill this object in will probably want to do it on demand unless you know you need access to all the airings in all the lineup's stations. Either way, building a complete Lineup object over the network is going to be very slow; even slowing if you request all airings to be pulled down as well. Even ZipEpgClient should avoid pulling in all Airings for a Lineup unless you know you're going to need them all. Even with a local cache, building up the complete Lineup with all metadata and airings is still very expensive.

Parameters:

fetchAirings - If true, all Stations will fill in their Airings as well, otherwise Stations will fill Airings in as needed

Throws:

IOException - On any IO error

InvalidJsonObjectException - If the JSON response from upstream is not in the expected format

hasPhysicalMapping

public boolean hasPhysicalMapping()

Returns:

Returns true if this lineup has a physical channel mapping that differs from its logical channel mapping; this will usually occur for most OTA lineups

getLastModified

public Date getLastModified()

Returns:

The last time this lineup was modified upstream; use this to cache lineup data

getLocation

public String getLocation()

Returns:

The physical location of this headend (i.e. city/country/etc.); may not always be available

getName

public String getName()

Returns:

The name of this lineup; may not always be available

getStationMap

public Map<String,List<String>> getStationMap()

Returns:

Returns the mapping of station ids to channel numbers for this lineup; keys are station ids, values are arrays of channel numbers to which the station maps to

getPhysicalStationMap

public Map<String,List<String>> getPhysicalStationMap()

Returns:

Return the physical station mapping for this lineup; if there is no physical mapping for this lineup then the logical mapping is returned instead

getStations

public Station[] getStations()

Returns:

The array of stations available on this lineup

getStation

public Station getStation(String stationId)

Return the Station object for a given Station id in the lineup

Parameters:

stationId - The station id to fetch

Returns:

The Station object for the given station id or null if it's not available

getUri

public String getUri()

Returns:

the uri

toString

public String toString()

Overrides:

toString in class Object

getType

public String getType()

Returns:

the type

getId

public String getId()

Returns:

the id