Android Open Source - Tvdb-Api-Android Tvdb Api

From Project

License

The source code is released under:
Apache License
If you think the Android project Tvdb-Api-Android listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
Java Source Code

package com.sburba.tvdbapi;
/*from  www  .  j  a va 2  s .co  m*/
import android.util.Log;

import com.android.volley.RequestQueue;
import com.android.volley.Response;
import com.sburba.tvdbapi.model.Actor;
import com.sburba.tvdbapi.model.Banner;
import com.sburba.tvdbapi.model.Episode;
import com.sburba.tvdbapi.model.Season;
import com.sburba.tvdbapi.model.Series;
import com.sburba.tvdbapi.parser.ActorListParser;
import com.sburba.tvdbapi.parser.BannerListParser;
import com.sburba.tvdbapi.parser.EpisodeParser;
import com.sburba.tvdbapi.parser.SeasonListParser;
import com.sburba.tvdbapi.parser.SeriesParser;
import com.sburba.tvdbapi.xml.XmlObjectListRequest;
import com.sburba.tvdbapi.xml.XmlObjectRequest;
import com.sburba.tvdbapi.xml.ZippedXmlObjectListRequest;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Collection;

@SuppressWarnings("unused")
public class TvdbApi {

    private static final String TAG = "TvdbApi";
    private static final String CHAR_ENCODING = "UTF-8";
    private static final String BASE_URL = "http://thetvdb.com/api/";
    private static final String SERIES_SEARCH = BASE_URL + "GetSeries.php?seriesname=";
    private static final String IMDB_SERIES_SEARCH = BASE_URL + "GetSeriesByRemoteID.php?imdbid=";

    private final String mApiKey;
    private final String mLanguage;
    private final RequestQueue mRequestQueue;

    /**
     * Create a new TvdbApi instance. This does not need to be a singleton object
     *
     * @param apiKey       Your TVDB api key
     * @param language     The two letter language code to use for queries, if null defaults to "en"
     * @param requestQueue The {@link RequestQueue} for api requests
     */
    public TvdbApi(String apiKey, String language, RequestQueue requestQueue) {
        mApiKey = apiKey;
        mLanguage = language;
        mRequestQueue = requestQueue;
    }

    /**
     * Search the TVDB for a {@link Series} based on the series name
     *
     * @param seriesName    The series to search for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void searchSeries(String seriesName, Response.Listener<Collection<Series>> listener,
                             Response.ErrorListener errorListener) {
        String query;
        try {
            query = URLEncoder.encode(seriesName, CHAR_ENCODING);
        } catch (UnsupportedEncodingException e) {
            Log.wtf(TAG, "How the hell is " + CHAR_ENCODING + " not supported? Dropping request");
            return;
        }

        String requestUrl = SERIES_SEARCH + query + "&language=" + mLanguage;
        XmlObjectListRequest<Series, SeriesParser> seriesRequest =
                new XmlObjectListRequest<Series, SeriesParser>(new SeriesParser(),
                                                               requestUrl, listener,
                                                               errorListener);

        mRequestQueue.add(seriesRequest);
    }

    /**
     * Get a {@link Series} from the IMDB ID
     *
     * @param imdbId        The IMDB ID
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getSeriesFromImdbId(String imdbId, Response.Listener<Series> listener,
                                    Response.ErrorListener errorListener) {
        String requestUrl = IMDB_SERIES_SEARCH + imdbId;

        XmlObjectRequest<Series, SeriesParser> seriesRequest =
                new XmlObjectRequest<Series, SeriesParser>(new SeriesParser(), requestUrl, listener,
                                                           errorListener);

        mRequestQueue.add(seriesRequest);
    }

    /**
     * Get all of the {@link Season}s for a given {@link Series}
     *
     * @param series        {@link Series} to get the seasons for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getSeasons(Series series, Response.Listener<Collection<Season>> listener,
                           Response.ErrorListener errorListener) {
        getSeasons(series.id, listener, errorListener);
    }

    /**
     * Get all of the {@link Season}s for a given TVDB Series ID
     *
     * @param seriesId      TVDB Series ID
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getSeasons(int seriesId, Response.Listener<Collection<Season>> listener,
                           Response.ErrorListener errorListener) {
        String requestUrl = getSeriesRequestUrl(seriesId);

        ZippedXmlObjectListRequest<Season, SeasonListParser> seasonRequest =
                new ZippedXmlObjectListRequest<Season, SeasonListParser>(
                        new SeasonListParser(mLanguage), requestUrl, listener, errorListener);

        mRequestQueue.add(seasonRequest);
    }

    /**
     * Get all of the {@link Episode}s for a given {@link Series}
     *
     * @param series        {@link Series} to get the episodes for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisodes(Series series, Response.Listener<Collection<Episode>> listener,
                            Response.ErrorListener errorListener) {
        getEpisodes(series.id, listener, errorListener);
    }

    /**
     * Get all of the {@link Episode}s for a given TVDB Series ID
     *
     * @param seriesId      TVDB Series ID
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisodes(int seriesId, Response.Listener<Collection<Episode>> listener,
                            Response.ErrorListener errorListener) {
        getEpisodes(seriesId, EpisodeParser.ALL_SEASONS, listener, errorListener);
    }

    /**
     * Get the {@link Episode}s for a specific {@link Season}
     *
     * @param season        {@link Season} to get the episodes for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisodes(Season season, Response.Listener<Collection<Episode>> listener,
                            Response.ErrorListener errorListener) {
        getEpisodes(season.seriesId, season.seasonNumber, listener, errorListener);
    }

    /**
     * Get {@link Episode}s for a given TVDB Series ID and season number
     *
     * @param seriesId      TVDB Series ID
     * @param seasonNumber  The season number
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisodes(int seriesId, int seasonNumber,
                            Response.Listener<Collection<Episode>> listener,
                            Response.ErrorListener errorListener) {
        String requestUrl = getSeriesRequestUrl(seriesId);

        ZippedXmlObjectListRequest<Episode, EpisodeParser> episodeRequest =
                new ZippedXmlObjectListRequest<Episode, EpisodeParser>(
                        new EpisodeParser(mLanguage, seasonNumber), requestUrl, listener,
                        errorListener);

        mRequestQueue.add(episodeRequest);
    }

    /**
     * Get a specific {@link Episode} with the default show order
     *
     * @param series        {@link Series} for the episode
     * @param seasonNumber  The season number
     * @param episodeNumber The episode number
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisode(Series series, int seasonNumber, int episodeNumber,
                           Response.Listener<Episode> listener,
                           Response.ErrorListener errorListener) {
        getEpisode(series, seasonNumber, episodeNumber, SHOW_ORDER.DEFAULT, listener,
                   errorListener);
    }

    /**
     * Get a specific {@link Episode} with a specific {@link SHOW_ORDER}
     *
     * @param series        {@link Series} for the episode
     * @param seasonNumber  The season number
     * @param episodeNumber The episode number
     * @param showOrder     The TVDB show order
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisode(Series series, int seasonNumber, int episodeNumber, SHOW_ORDER showOrder,
                           Response.Listener<Episode> listener,
                           Response.ErrorListener errorListener) {
        getEpisode(series.id, seasonNumber, episodeNumber, showOrder, listener, errorListener);
    }

    /**
     * Get a specific {@link Episode} with a specific {@link SHOW_ORDER}
     *
     * @param seriesId      TVDB Series ID
     * @param seasonNumber  The season number
     * @param episodeNumber The episode number
     * @param showOrder     The TVDB show order
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisode(int seriesId, int seasonNumber, int episodeNumber, SHOW_ORDER showOrder,
                           Response.Listener<Episode> listener,
                           Response.ErrorListener errorListener) {
        String showOrderModifier;
        if (showOrder == SHOW_ORDER.ABSOLUTE) {
            showOrderModifier = "/absolute/";
        } else if (showOrder == SHOW_ORDER.DVD) {
            showOrderModifier = "/dvd/";
        } else {
            showOrderModifier = "/default/";
        }
        String requestUrl =
                BASE_URL + mApiKey + "/series/" + seriesId + showOrderModifier + seasonNumber +
                "/" + episodeNumber + "/" + mLanguage + ".xml";

        XmlObjectRequest<Episode, EpisodeParser> episodeRequest = new XmlObjectRequest<Episode,
                EpisodeParser>(new EpisodeParser(mLanguage), requestUrl, listener, errorListener);

        mRequestQueue.add(episodeRequest);
    }

    /**
     * Get a specific {@link Episode} with a specific {@link SHOW_ORDER}
     *
     * @param season        The season
     * @param episodeNumber The episode number
     * @param showOrder     The TVDB show order
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getEpisode(Season season, int episodeNumber, SHOW_ORDER showOrder,
                           Response.Listener<Episode> listener,
                           Response.ErrorListener errorListener) {
        String showOrderModifier;
        if (showOrder == SHOW_ORDER.ABSOLUTE) {
            showOrderModifier = "/absolute/";
        } else if (showOrder == SHOW_ORDER.DVD) {
            showOrderModifier = "/dvd/";
        } else {
            showOrderModifier = "/default/";
        }
        String requestUrl =
                BASE_URL + mApiKey + "/series/" + season.seriesId + showOrderModifier + season.seasonNumber +
                "/" + episodeNumber + "/" + mLanguage + ".xml";

        XmlObjectRequest<Episode, EpisodeParser> episodeRequest = new XmlObjectRequest<Episode,
                EpisodeParser>(new EpisodeParser(mLanguage), requestUrl, listener, errorListener);

        mRequestQueue.add(episodeRequest);
    }

    /**
     * Get all {@link Banner}s for a {@link Series}
     * This does not actually download the banners, it only loads the url metadata
     *
     * @param series        The {@link Series} to download banners for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getBanners(Series series, Response.Listener<Collection<Banner>> listener,
                           Response.ErrorListener errorListener) {
        getBanners(series.id, listener, errorListener);
    }

    /**
     * Get all {@link Banner}s for a TVDB series ID
     * This does not actually download the banners, it only loads the url metadata
     *
     * @param seriesId      TVDB Series ID
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getBanners(int seriesId, Response.Listener<Collection<Banner>> listener,
                           Response.ErrorListener errorListener) {
        getBanners(seriesId, BannerListParser.ALL_SEASONS, listener, errorListener);
    }

    /**
     * Get {@link Banner}s for a season
     *
     * @param seriesId      TVDB Series ID
     * @param seasonNumber  The season number
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getBanners(int seriesId, int seasonNumber,
                           Response.Listener<Collection<Banner>> listener,
                           Response.ErrorListener errorListener) {
        String requstUrl = getSeriesRequestUrl(seriesId);

        ZippedXmlObjectListRequest<Banner, BannerListParser> bannerRequest =
                new ZippedXmlObjectListRequest<Banner, BannerListParser>(
                        new BannerListParser(seasonNumber), requstUrl, listener, errorListener);

        mRequestQueue.add(bannerRequest);
    }

    /**
     * Get {@link Actor}s for a {@link Series}
     *
     * @param series        The {@link Series} to download {@link Actor}s for
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getActors(Series series, Response.Listener<Collection<Actor>> listener,
                          Response.ErrorListener errorListener) {
        getActors(series.id, listener, errorListener);
    }

    /**
     * Get {@link Actor}s for a TVDB Series ID
     *
     * @param seriesId      TVDB Series ID
     * @param listener      {@link Response.Listener} for receiving the result
     * @param errorListener {@link Response.ErrorListener} for receiving any errors
     */
    public void getActors(int seriesId, Response.Listener<Collection<Actor>> listener,
                          Response.ErrorListener errorListener) {
        String requestUrl = BASE_URL + mApiKey + "/series/" + seriesId + "/actors.xml";

        XmlObjectListRequest<Actor, ActorListParser> actorRequest = new XmlObjectListRequest
                <Actor, ActorListParser>(new ActorListParser(), requestUrl, listener,
                                         errorListener);

        mRequestQueue.add(actorRequest);
    }

    private String getSeriesRequestUrl(int seriesId) {
        return BASE_URL + mApiKey + "/series/" + seriesId + "/all/" + mLanguage + ".zip";
    }

    public static enum SHOW_ORDER {DEFAULT, DVD, ABSOLUTE}
}
Java Source Code List
