xyz.nickr.jomdb

Class JavaOMDB

java.lang.Object

xyz.nickr.jomdb.JavaOMDB

public class JavaOMDB
extends Object

The API entry point.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	IMDB_ID_PATTERN A regular expression matching valid IMDB IDs.

Constructor Summary

Constructors

Constructor and Description
JavaOMDB() Creates an instance.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	get(Map<String,String> params) Queries the OMDB API with given query parameters.
JOMDBRequests	getRequests() Gets the corresponding JOMDBRequests object.
SearchResults	search(String search) Searches for titles with specified text.
SeasonResult	seasonById(String imdbId, String season) Gets a season by title's IMDB ID and season number.
SeasonResult	seasonByName(String title, String season) Gets a season by title name and season number.
TitleResult	titleById(String imdbId) Gets a title by its IMDB ID, with a short plot.
TitleResult	titleById(String imdbId, boolean fullPlot) Gets a title by its IMDB ID, optionally with a full plot.
TitleResult	titleByName(String title) Gets a title by its name, with a short plot.
TitleResult	titleByName(String title, boolean fullPlot) Gets a title by its name, optionally with a full plot.

Methods inherited from class java.lang.Object

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

Field Detail

IMDB_ID_PATTERN

public static final Pattern IMDB_ID_PATTERN

A regular expression matching valid IMDB IDs.

Constructor Detail

JavaOMDB

public JavaOMDB()

Creates an instance.

Method Detail

getRequests

public JOMDBRequests getRequests()

Gets the corresponding JOMDBRequests object.

Returns:

The requests object.

get

public org.json.JSONObject get(Map<String,String> params)
                        throws JOMDBException

Queries the OMDB API with given query parameters.

Parameters:

params - The parameters.

Returns:

The JSON object describing the query result.

Throws:

JOMDBException - when an error occurs while retrieving or parsing JSON

search

public SearchResults search(String search)

Searches for titles with specified text.

Parameters:

search - The search text.

Returns:

The search results.

titleByName

public TitleResult titleByName(String title)

Gets a title by its name, with a short plot.

Parameters:

title - The title's name.

Returns:

The title.

titleByName

public TitleResult titleByName(String title,
                               boolean fullPlot)

Gets a title by its name, optionally with a full plot.

Parameters:

title - The title's name.

fullPlot - Whether or not to get the full plot.

Returns:

The title.

titleById

public TitleResult titleById(String imdbId)

Gets a title by its IMDB ID, with a short plot.

Parameters:

imdbId - The title's IMDB ID.

Returns:

The title.

titleById

public TitleResult titleById(String imdbId,
                             boolean fullPlot)

Gets a title by its IMDB ID, optionally with a full plot.

Parameters:

imdbId - The title's IMDB ID.

fullPlot - Whether or not to get the full plot.

Returns:

The title.

seasonByName

public SeasonResult seasonByName(String title,
                                 String season)

Gets a season by title name and season number.

Parameters:

title - The title name.

season - The season number.

Returns:

The season.

seasonById

public SeasonResult seasonById(String imdbId,
                               String season)

Gets a season by title's IMDB ID and season number.

Parameters:

imdbId - The title's IMDB ID.

season - The season number.

Returns:

The season.