org.stanwood.media.model
Class Film

java.lang.Object
  extended by org.stanwood.media.model.Film
All Implemented Interfaces:
IFilm, IVideo, IVideoActors, IVideoCertification, IVideoGenre, IVideoRating

public class Film
extends java.lang.Object
implements IFilm

This class is used to hold film related information


Constructor Summary
Film()
          Used to create a film
Film(java.lang.String id)
          Used to create a instance of the film class.
 
Method Summary
 void addChapter(Chapter chapter)
          Used to add a chapter to the film
 void addGenre(java.lang.String genre)
          Used to add a genre to the film
 java.util.List<Actor> getActors()
          Used to get a list of actors in the video
 java.util.List<Certification> getCertifications()
          Used to get a list of the films certifications
 java.util.List<Chapter> getChapters()
          Used to get the chapters of the film
 java.lang.String getCountry()
          This will return the country the film was made in, or null if it's not known.
 java.util.Date getDate()
          Used to get the release date of the film
 java.lang.String getDescription()
          Used to get the films long description
 java.util.List<java.lang.String> getDirectors()
          Used to get a list of directors for the film
 java.util.SortedSet<IVideoFile> getFiles()
          Used to get a list of files that belong to the video entry
 java.net.URL getFilmUrl()
          Used to get the URL used to get a summary of the film
 java.util.List<java.lang.String> getGenres()
          Used to get the genres that the film belongs too
 java.lang.String getId()
          Used to get the id of the film used by the source that it was read from.
 java.net.URL getImageURL()
          Used to get the URL of the film poster.
 java.lang.String getPreferredGenre()
          This is useful if the film belongs to more than one genres.
 Rating getRating()
          Used to get the global user rating of the film
 java.lang.String getSourceId()
          Used to get the source id of the source that was used to retrieve the film information.
 java.lang.String getStudio()
          Used to get the films studio
 java.lang.String getSummary()
          Used to get a summary of the film
 java.lang.String getTitle()
          Used to get the film title.
 java.util.List<java.lang.String> getWriters()
          Used to get a list of writers for the film
 void setActors(java.util.List<Actor> actors)
          Used to set the list of actors in the film
 void setCertifications(java.util.List<Certification> certifications)
          Used to set the films certifications
 void setChapters(java.util.List<Chapter> chapters)
          Used to set the chapter information for the film
 void setCountry(java.lang.String country)
          Used to set the country the film was made in.
 void setDate(java.util.Date date)
          Used to set the release date of the film
 void setDescription(java.lang.String description)
          Used to set the films long description
 void setDirectors(java.util.List<java.lang.String> directors)
          Used to set a list of directors for the episode
 void setFiles(java.util.Collection<IVideoFile> videoFiles)
          Used to set the list of files that belong to the video entry
 void setFilmUrl(java.net.URL url)
          Used to set the URL used to get a summary of the film
 void setGenres(java.util.List<java.lang.String> genres)
          Used to set the genres that the film belongs too
 void setId(java.lang.String id)
          Used to set the id of the film used by the source that it was read from.
 void setImageURL(java.net.URL imageURL)
          Used to set the URL of the film poster
 void setPreferredGenre(java.lang.String preferredGenre)
          Used to set the genre that is preferred in the list of genres.
 void setRating(Rating rating)
          Used to set the global user rating of the film
 void setSourceId(java.lang.String sourceId)
          Used to set the source id of the source that was used to retrieve the film information.
 void setStudio(java.lang.String studio)
          Used to set the films studio
 void setSummary(java.lang.String summary)
          Used to set the films summary
 void setTitle(java.lang.String title)
          Used to set the title of the film
 void setWriters(java.util.List<java.lang.String> writers)
          Used to set a list of writers for the film
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Film

public Film()
Used to create a film


Film

public Film(java.lang.String id)
Used to create a instance of the film class.

Parameters:
id - The id of the film used by the source that it was read from.
Method Detail

getPreferredGenre

public java.lang.String getPreferredGenre()
This is useful if the film belongs to more than one genres. It will returned the genre that is preferred.

Specified by:
getPreferredGenre in interface IVideoGenre
Returns:
The preferred genre or null if not or flagged as preferred.

setPreferredGenre

public void setPreferredGenre(java.lang.String preferredGenre)
Used to set the genre that is preferred in the list of genres.

Specified by:
setPreferredGenre in interface IVideoGenre
Parameters:
preferredGenre - The preferred genre

getId

public java.lang.String getId()
Used to get the id of the film used by the source that it was read from.

Specified by:
getId in interface IFilm
Returns:
The id of the film

setId

public void setId(java.lang.String id)
Used to set the id of the film used by the source that it was read from.

Specified by:
setId in interface IFilm
Parameters:
id - The id of the film

getSourceId

public java.lang.String getSourceId()
Used to get the source id of the source that was used to retrieve the film information.

Specified by:
getSourceId in interface IFilm
Returns:
The source id

setSourceId

public void setSourceId(java.lang.String sourceId)
Used to set the source id of the source that was used to retrieve the film information.

Specified by:
setSourceId in interface IFilm
Parameters:
sourceId - The source id

getTitle

public java.lang.String getTitle()
Used to get the film title.

Specified by:
getTitle in interface IVideo
Returns:
The film title.

setTitle

public void setTitle(java.lang.String title)
Used to set the title of the film

Specified by:
setTitle in interface IVideo
Parameters:
title - The title of the film

getActors

public java.util.List<Actor> getActors()
Used to get a list of actors in the video

Specified by:
getActors in interface IVideoActors
Returns:
The list of actors in the video

setActors

public void setActors(java.util.List<Actor> actors)
Used to set the list of actors in the film

Specified by:
setActors in interface IVideoActors
Parameters:
actors - The list of actors in the film

getDirectors

public java.util.List<java.lang.String> getDirectors()
Used to get a list of directors for the film

Specified by:
getDirectors in interface IVideo
Returns:
A list of directors for the film

setDirectors

public void setDirectors(java.util.List<java.lang.String> directors)
Used to set a list of directors for the episode

Specified by:
setDirectors in interface IVideo
Parameters:
directors - The list of directors for the episode

getWriters

public java.util.List<java.lang.String> getWriters()
Used to get a list of writers for the film

Specified by:
getWriters in interface IVideo
Returns:
Get a list of writers for the film

setWriters

public void setWriters(java.util.List<java.lang.String> writers)
Used to set a list of writers for the film

Specified by:
setWriters in interface IVideo
Parameters:
writers - The list of writers

getSummary

public java.lang.String getSummary()
Used to get a summary of the film

Specified by:
getSummary in interface IVideo
Returns:
The summary of the film

setSummary

public void setSummary(java.lang.String summary)
Used to set the films summary

Specified by:
setSummary in interface IVideo
Parameters:
summary - The films summary

setFilmUrl

public void setFilmUrl(java.net.URL url)
Used to set the URL used to get a summary of the film

Specified by:
setFilmUrl in interface IFilm
Parameters:
url - The summary URL

getFilmUrl

public java.net.URL getFilmUrl()
Used to get the URL used to get a summary of the film

Specified by:
getFilmUrl in interface IFilm
Returns:
The summary URL

setGenres

public void setGenres(java.util.List<java.lang.String> genres)
Used to set the genres that the film belongs too

Specified by:
setGenres in interface IVideoGenre
Parameters:
genres - The genres that the film belongs too

getGenres

public java.util.List<java.lang.String> getGenres()
Used to get the genres that the film belongs too

Specified by:
getGenres in interface IVideoGenre
Returns:
The genres the film belongs too

addGenre

public void addGenre(java.lang.String genre)
Used to add a genre to the film

Specified by:
addGenre in interface IVideoGenre
Parameters:
genre - the genre to add

getCertifications

public java.util.List<Certification> getCertifications()
Used to get a list of the films certifications

Specified by:
getCertifications in interface IVideoCertification
Returns:
The films certification list

setCertifications

public void setCertifications(java.util.List<Certification> certifications)
Used to set the films certifications

Specified by:
setCertifications in interface IVideoCertification
Parameters:
certifications - The films certifications

getRating

public Rating getRating()
Used to get the global user rating of the film

Specified by:
getRating in interface IVideoRating
Returns:
The global user rating of the show

setRating

public void setRating(Rating rating)
Used to set the global user rating of the film

Specified by:
setRating in interface IVideoRating
Parameters:
rating - The global user rating of the show

getDate

public java.util.Date getDate()
Used to get the release date of the film

Specified by:
getDate in interface IFilm
Returns:
The release date of the film

setDate

public void setDate(java.util.Date date)
Used to set the release date of the film

Specified by:
setDate in interface IFilm
Parameters:
date - The release date of the film

setImageURL

public void setImageURL(java.net.URL imageURL)
Used to set the URL of the film poster

Specified by:
setImageURL in interface IFilm
Parameters:
imageURL - The URL of the film poster.

getImageURL

public java.net.URL getImageURL()
Used to get the URL of the film poster. This will return null if a poster could not be found.

Specified by:
getImageURL in interface IFilm
Returns:
The film poster, or null if it does not have one

addChapter

public void addChapter(Chapter chapter)
Used to add a chapter to the film

Specified by:
addChapter in interface IFilm
Parameters:
chapter - The chapter to add

getChapters

public java.util.List<Chapter> getChapters()
Used to get the chapters of the film

Specified by:
getChapters in interface IFilm
Returns:
The chapters of the film

setChapters

public void setChapters(java.util.List<Chapter> chapters)
Used to set the chapter information for the film

Specified by:
setChapters in interface IFilm
Parameters:
chapters - The chapters of the film

setDescription

public void setDescription(java.lang.String description)
Used to set the films long description

Specified by:
setDescription in interface IFilm
Parameters:
description - The films long description

getDescription

public java.lang.String getDescription()
Used to get the films long description

Specified by:
getDescription in interface IFilm
Returns:
the films long description

getCountry

public java.lang.String getCountry()
This will return the country the film was made in, or null if it's not known.

Specified by:
getCountry in interface IFilm
Returns:
the country the film was made in.

setCountry

public void setCountry(java.lang.String country)
Used to set the country the film was made in.

Specified by:
setCountry in interface IFilm
Parameters:
country - the country to set

getFiles

public java.util.SortedSet<IVideoFile> getFiles()
Used to get a list of files that belong to the video entry

Specified by:
getFiles in interface IVideo
Returns:
The list of files

setFiles

public void setFiles(java.util.Collection<IVideoFile> videoFiles)
Used to set the list of files that belong to the video entry

Specified by:
setFiles in interface IVideo
Parameters:
videoFiles - The list of files

setStudio

public void setStudio(java.lang.String studio)
Used to set the films studio

Specified by:
setStudio in interface IFilm
Parameters:
studio - the films studio

getStudio

public java.lang.String getStudio()
Used to get the films studio

Specified by:
getStudio in interface IFilm
Returns:
the films studio

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object