Program (sdjson-api 0.20131021.1 API)

java.lang.Object
- org.schedulesdirect.api.Program

```
public class Program
extends Object
```
A Program represents the details of events and shows that are broadcast
Only 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>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Program.ColorCode` The color code of a program
`static class`	`Program.Credit` Represents a credit in a program
`static class`	`Program.Role` Represents the role of cast & crew members of a program
`static class`	`Program.SourceType` Represents the source of a program
`static class`	`Program.Team`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_PROGRAM` An empty Program object as a JSON string
`static Pattern`	`MOVIE_REGEX`
`static SimpleDateFormat`	`ORIG_FMT` The expected format of the original airing field

Method Summary

Methods
Modifier and Type	Method and Description
`protected float`	`calcStarValue()` Given a star rating from upstream, convert it to a number
`boolean`	`equals(Object obj)`
`String[]`	`getAdvisories()`
`String`	`getAlternateDescription()`
`String`	`getAlternateDescriptionShort()`
`String`	`getAlternateEpisodeNumber()`
`String`	`getAlternateTitle()`
`Program.ColorCode`	`getColorCode()`
`String`	`getCountryOfOrigin()`
`Program.Credit[]`	`getCredits()`
`String`	`getDescription()`
`String`	`getDescriptionLanguage()`
`String`	`getEpisodeNumber()`
`String`	`getEpisodeTitle()`
`Date`	`getGameStart()`
`String[]`	`getGenres()`
`String`	`getHoliday()`
`String`	`getId()`
`String`	`getMd5()`
`List<Map<String,Object>>`	`getMetadata()`
`Date`	`getOriginalAirDate()`
`ContentRating[]`	`getRatings()`
`int`	`getRunTime()`
`String`	`getSeriesDescription()`
`String[]`	`getShortDescriptions()`
`String[]`	`getShortTitles()`
`Program.SourceType`	`getSourceType()`
`String`	`getStarRating()`
`float`	`getStarRatingValue()`
`String`	`getStudio()`
`String`	`getSyndicatedEpisodeNumber()`
`Program.Team[]`	`getTeams()`
`String`	`getTitle()`
`String`	`getVenue()`
`int`	`getYear()`
`int`	`hashCode()`
`boolean`	`isMadeForTv()`
`void`	`setAdvisories(String[] advisories)`
`void`	`setAlternateDescription(String alternateDescription)`
`void`	`setAlternateDescriptionShort(String alternateDescriptionShort)`
`void`	`setAlternateEpisodeNumber(String alternateEpisodeNumber)`
`void`	`setAlternateTitle(String alternateTitle)`
`void`	`setColorCode(Program.ColorCode colorCode)`
`void`	`setCountryOfOrigin(String countryOfOrigin)`
`void`	`setCredits(Program.Credit[] credits)`
`void`	`setDescription(String description)`
`void`	`setDescriptionLanguage(String descriptionLanguage)`
`void`	`setEpisodeNumber(String episodeNumber)`
`void`	`setEpisodeTitle(String episodeTitle)`
`void`	`setGameStart(Date gameStart)`
`void`	`setGenres(String[] genres)`
`void`	`setHoliday(String holiday)`
`void`	`setId(String id)`
`void`	`setMadeForTv(boolean madeForTv)`
`void`	`setMd5(String md5)`
`void`	`setMetadata(List<Map<String,Object>> metadata)`
`void`	`setOriginalAirDate(Date originalAirDate)`
`void`	`setRatings(ContentRating[] ratings)`
`void`	`setRunTime(int runTime)`
`void`	`setSeriesDescription(String seriesDescription)`
`void`	`setShortDescriptions(String[] shortDescriptions)`
`void`	`setShortTitles(String[] shortTitles)`
`void`	`setSourceType(Program.SourceType sourceType)`
`void`	`setStarRating(String starRating)`
`void`	`setStudio(String studio)`
`void`	`setSyndicatedEpisodeNumber(String syndicatedEpisodeNumber)`
`void`	`setTeams(Program.Team[] teams)`
`void`	`setTitle(String title)`
`void`	`setVenue(String venue)`
`void`	`setYear(int year)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_PROGRAM
```
public static final String EMPTY_PROGRAM
```
    An empty Program object as a JSON string
    
    See Also:
    Constant Field Values
  - ORIG_FMT
```
public static final SimpleDateFormat ORIG_FMT
```
    The expected format of the original airing field
  - MOVIE_REGEX
```
public static final Pattern MOVIE_REGEX
```
- Method Detail
  - getMetadata
```
public List<Map<String,Object>> getMetadata()
```
    Returns:
    A list of maps where each map in the list contains metadata from a given external data source (such as thetvdb.com); never null, possibly empty if no metadata is available for this program; keys of map depend on datasource value, see wiki for details of what's available for each type of metadata map
  - getGenres
```
public String[] getGenres()
```
    Returns:
    The list of genres for this program; never null but may be empty if genre data isn't available for this program
  - getId
```
public String getId()
```
    Returns:
    Returns the unique upstream id (i.e. Data Direct) for this program
  - isMadeForTv
```
public boolean isMadeForTv()
```
    Returns:
    True if this program was made for tv or false otherwise
  - getDescription
```
public String getDescription()
```
    Returns:
    Returns the full description of this program; may be empty, never null
  - getEpisodeTitle
```
public String getEpisodeTitle()
```
    Returns:
    Returns the episode title for this program; may be empty, never null
  - getTitle
```
public String getTitle()
```
    Returns:
    Returns the full title of this program
  - getOriginalAirDate
```
public Date getOriginalAirDate()
```
    Returns:
    Returns the original airing date of this program or null if the data is not available
  - getDescriptionLanguage
```
public String getDescriptionLanguage()
```
    Returns:
    Returns the language that all the description fields are in or null if not provided by the source (assume English when null)
  - getSourceType
```
public Program.SourceType getSourceType()
```
    Returns:
    Returns the source type of this program
  - getSyndicatedEpisodeNumber
```
public String getSyndicatedEpisodeNumber()
```
    Returns:
    Returns the syndicated episode number or null if not available; this value is usually not too useful as there is no standard format
  - getColorCode
```
public Program.ColorCode getColorCode()
```
    Returns:
    Returns the color code for this program
  - getAdvisories
```
public String[] getAdvisories()
```
    Returns:
    Returns an array of additional advisories for this program; never null but may be empty
  - getAlternateEpisodeNumber
```
public String getAlternateEpisodeNumber()
```
    Returns:
    Returns an alternate episode number, if available, or null; if a value is returned it's probably not going to be too useful (no standard format)
  - getAlternateTitle
```
public String getAlternateTitle()
```
    Returns:
    An alternate title or null
  - getCredits
```
public Program.Credit[] getCredits()
```
    Returns:
    An array of credits for this program; never null but may be empty if no data is available
  - getAlternateDescription
```
public String getAlternateDescription()
```
    Returns:
    An alternate description or null
  - getAlternateDescriptionShort
```
public String getAlternateDescriptionShort()
```
    Returns:
    A shorter alternate description or null
  - getShortDescriptions
```
public String[] getShortDescriptions()
```
    Returns:
    An array of shorter descriptions for this program; sorted by longest to shortest; never null, never empty, but may just repeat the original description
  - getGameStart
```
public Date getGameStart()
```
    Returns:
    If this program refers to a sporting event, this will be the scheduled start time of the event itself; NOTE: currently this appears to represent the start time based on the event's local time zone, but that time zone isn't available so calculations are next to impossible
  - getHoliday
```
public String getHoliday()
```
    Returns:
    If this program is in reference to a holiday, this value specifies which holiday; null otherwise
  - getMd5
```
public String getMd5()
```
    Returns:
    The MD5 of this object, as computed by the UPSTREAM data source; currently no know way to validate this value
  - getRatings
```
public ContentRating[] getRatings()
```
    Returns:
    Returns the ratings of this program
  - getCountryOfOrigin
```
public String getCountryOfOrigin()
```
    Returns:
    Returns the program's country of origin or null
  - getStudio
```
public String getStudio()
```
    Returns:
    Returns the program's originating studio or null if not available
  - getRunTime
```
public int getRunTime()
```
    Returns:
    The running time of this program in seconds or 0 if not known
  - getStarRating
```
public String getStarRating()
```
    Returns:
    The star rating of this program or null if not available; only available for Programs with MV* ids
  - getStarRatingValue
```
public float getStarRatingValue()
```
    Returns:
    The star rating of this program, as a float; 0.0 if not available OR if the rating was indeed zero; when zero, check getStarRating() to see if it's null or not, null means there was no rating provided, empty string means zero rating (for movies)
  - calcStarValue
```
protected float calcStarValue()
                       throws ParseException
```
    Given a star rating from upstream, convert it to a number
    
    Returns:
    The value of the star rating received
    
    Throws:
    
    ParseException - If an invalid character is encountered in the received string
  - getEpisodeNumber
```
public String getEpisodeNumber()
```
    Returns:
    Returns the episode number of this program or null if unknown; values returned are next to useless as there is no standard format for this value
  - getShortTitles
```
public String[] getShortTitles()
```
    Returns:
    An array of alternate, shorter titles sorted from longest to shortest; never empty, never null, but may just repeat the original title
  - getYear
```
public int getYear()
```
    Returns:
    Returns the year this program was made or zero if unknown; typically only provided for movies
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setId
```
public void setId(String id)
```
    Parameters:
    id - the id to set
  - setMadeForTv
```
public void setMadeForTv(boolean madeForTv)
```
    Parameters:
    madeForTv - the madeForTv to set
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    description - the description to set
  - setEpisodeTitle
```
public void setEpisodeTitle(String episodeTitle)
```
    Parameters:
    episodeTitle - the episodeTitle to set
  - setTitle
```
public void setTitle(String title)
```
    Parameters:
    title - the title to set
  - setOriginalAirDate
```
public void setOriginalAirDate(Date originalAirDate)
```
    Parameters:
    originalAirDate - the originalAirDate to set
  - setDescriptionLanguage
```
public void setDescriptionLanguage(String descriptionLanguage)
```
    Parameters:
    descriptionLanguage - the descriptionLanguage to set
  - setSourceType
```
public void setSourceType(Program.SourceType sourceType)
```
    Parameters:
    sourceType - the sourceType to set
  - setSyndicatedEpisodeNumber
```
public void setSyndicatedEpisodeNumber(String syndicatedEpisodeNumber)
```
    Parameters:
    syndicatedEpisodeNumber - the syndicatedEpisodeNumber to set
  - setColorCode
```
public void setColorCode(Program.ColorCode colorCode)
```
    Parameters:
    colorCode - the colorCode to set
  - setAdvisories
```
public void setAdvisories(String[] advisories)
```
    Parameters:
    advisories - the advisories to set
  - setAlternateEpisodeNumber
```
public void setAlternateEpisodeNumber(String alternateEpisodeNumber)
```
    Parameters:
    alternateEpisodeNumber - the alternateEpisodeNumber to set
  - setAlternateTitle
```
public void setAlternateTitle(String alternateTitle)
```
    Parameters:
    alternateTitle - the alternateTitle to set
  - setCredits
```
public void setCredits(Program.Credit[] credits)
```
    Parameters:
    credits - the credits to set
  - setAlternateDescription
```
public void setAlternateDescription(String alternateDescription)
```
    Parameters:
    alternateDescription - the alternateDescription to set
  - setAlternateDescriptionShort
```
public void setAlternateDescriptionShort(String alternateDescriptionShort)
```
    Parameters:
    alternateDescriptionShort - the alternateDescriptionShort to set
  - setShortDescriptions
```
public void setShortDescriptions(String[] shortDescriptions)
```
    Parameters:
    shortDescriptions - the shortDescriptions to set
  - setGameStart
```
public void setGameStart(Date gameStart)
```
    Parameters:
    gameStart - the gameStart to set
  - setHoliday
```
public void setHoliday(String holiday)
```
    Parameters:
    holiday - the holiday to set
  - setMd5
```
public void setMd5(String md5)
```
    Parameters:
    md5 - the md5 to set
  - setRatings
```
public void setRatings(ContentRating[] ratings)
```
    Parameters:
    mpaaRating - the mpaaRating to set
  - setCountryOfOrigin
```
public void setCountryOfOrigin(String countryOfOrigin)
```
    Parameters:
    countryOfOrigin - the countryOfOrigin to set
  - setStudio
```
public void setStudio(String studio)
```
    Parameters:
    studio - the studio to set
  - setRunTime
```
public void setRunTime(int runTime)
```
    Parameters:
    runTime - the runTime to set
  - setStarRating
```
public void setStarRating(String starRating)
                   throws ParseException
```
    Parameters:
    starRating - the starRating to set
    
    Throws:
    
    ParseException - Thrown if the arugment is not a valid star rating string
  - setEpisodeNumber
```
public void setEpisodeNumber(String episodeNumber)
```
    Parameters:
    episodeNumber - the episodeNumber to set
  - setShortTitles
```
public void setShortTitles(String[] shortTitles)
```
    Parameters:
    shortTitles - the shortTitles to set
  - setYear
```
public void setYear(int year)
```
    Parameters:
    year - the year to set
  - setGenres
```
public void setGenres(String[] genres)
```
    Parameters:
    genres - the genres to set
  - setMetadata
```
public void setMetadata(List<Map<String,Object>> metadata)
```
    Parameters:
    metadata - the metadata to set
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getSeriesDescription
```
public String getSeriesDescription()
```
    Returns:
    the seriesDescription
  - setSeriesDescription
```
public void setSeriesDescription(String seriesDescription)
```
    Parameters:
    seriesDescription - the seriesDescription to set
  - getVenue
```
public String getVenue()
```
    Returns:
    the venue; typically only provided for (some) sports event programs or null otherwise
  - setVenue
```
public void setVenue(String venue)
```
    Parameters:
    venue - the venue to set
  - getTeams
```
public Program.Team[] getTeams()
```
    Returns:
    the teams; identifies teams competing in a sports event program; will be an empty array when not available/not applicable
  - setTeams
```
public void setTeams(Program.Team[] teams)
```
    Parameters:
    teams - the teams to set

Class Program

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_PROGRAM

ORIG_FMT

MOVIE_REGEX

Method Detail

getMetadata

getGenres

getId

isMadeForTv

getDescription

getEpisodeTitle

getTitle

getOriginalAirDate

getDescriptionLanguage

getSourceType

getSyndicatedEpisodeNumber

getColorCode

getAdvisories

getAlternateEpisodeNumber

getAlternateTitle

getCredits

getAlternateDescription

getAlternateDescriptionShort

getShortDescriptions

getGameStart

getHoliday

getMd5

getRatings

getCountryOfOrigin

getStudio

getRunTime

getStarRating

getStarRatingValue

calcStarValue

getEpisodeNumber

getShortTitles

getYear

toString

setId

setMadeForTv

setDescription

setEpisodeTitle

setTitle

setOriginalAirDate

setDescriptionLanguage

setSourceType

setSyndicatedEpisodeNumber

setColorCode

setAdvisories

setAlternateEpisodeNumber

setAlternateTitle

setCredits

setAlternateDescription

setAlternateDescriptionShort

setShortDescriptions

setGameStart

setHoliday

setMd5

setRatings

setCountryOfOrigin

setStudio

setRunTime

setStarRating

setEpisodeNumber

setShortTitles

setYear

setGenres

setMetadata

hashCode

equals

getSeriesDescription

setSeriesDescription

getVenue

setVenue

getTeams