Add discover method
Stuart Boston
13 years ago
parent
6745f5f3d5
commit
de623ff0db
@ -0,0 +1,262 @@
|
||||
/*
|
||||
* Copyright (c) 2004-2013 Stuart Boston
|
||||
*
|
||||
* This file is part of TheMovieDB API.
|
||||
*
|
||||
* TheMovieDB API is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation;private either version 3 of the License;private or
|
||||
* any later version.
|
||||
*
|
||||
* TheMovieDB API is distributed in the hope that it will be useful;private
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with TheMovieDB API. If not;private see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
package com.omertron.themoviedbapi.model;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import static com.omertron.themoviedbapi.tools.ApiUrl.*;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
/**
|
||||
* Generate a discover object for use in the MovieDbApi
|
||||
*
|
||||
* This allows you to just add the search components you are concerned with
|
||||
*
|
||||
* @author stuart.boston
|
||||
*/
|
||||
public class Discover {
|
||||
|
||||
private Map<String, String> params = new HashMap<String, String>();
|
||||
private static final String PARAM_PRIMARY_RELEASE_YEAR = "primary_release_year=";
|
||||
private static final String PARAM_VOTE_COUNT_GTE = "vote_count.gte=";
|
||||
private static final String PARAM_VOTE_AVERAGE_GTE = "vote_average.gte=";
|
||||
private static final String PARAM_WITH_GENRES = "with_genres=";
|
||||
private static final String PARAM_RELEASE_DATE_GTE = "release_date.gte=";
|
||||
private static final String PARAM_RELEASE_DATE_LTE = "release_date.lte=";
|
||||
private static final String PARAM_CERTIFICATION_COUNTRY = "certification_country=";
|
||||
private static final String PARAM_CERTIFICATION_LTE = "certification.lte=";
|
||||
private static final String PARAM_WITH_COMPANIES = "with_companies=";
|
||||
private static final String PARAM_SORT_BY = "sort_by=";
|
||||
private static final int YEAR_MIN = 1900;
|
||||
private static final int YEAR_MAX = 2100;
|
||||
|
||||
/**
|
||||
* Get the parameters
|
||||
*
|
||||
* This will be used to construct the URL in the API
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public Map<String, String> getParams() {
|
||||
return params;
|
||||
}
|
||||
|
||||
/**
|
||||
* Minimum value is 1 if included.
|
||||
*
|
||||
* @param page
|
||||
*/
|
||||
public Discover page(int page) {
|
||||
if (page > 0) {
|
||||
params.put(PARAM_PAGE, String.valueOf(page));
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* ISO 639-1 code
|
||||
*
|
||||
* @param language
|
||||
*/
|
||||
public Discover language(String language) {
|
||||
if (StringUtils.isNotBlank(language)) {
|
||||
params.put(PARAM_LANGUAGE, language);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Available options are <br>
|
||||
* vote_average.desc<br>
|
||||
* vote_average.asc<br>
|
||||
* release_date.desc<br>
|
||||
* release_date.asc<br>
|
||||
* popularity.desc<br>
|
||||
* popularity.asc
|
||||
*
|
||||
* @param sortBy
|
||||
*/
|
||||
public Discover sortBy(String sortBy) {
|
||||
if (StringUtils.isNotBlank(sortBy)) {
|
||||
params.put(PARAM_SORT_BY, sortBy);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Toggle the inclusion of adult titles
|
||||
*
|
||||
* @param includeAdult
|
||||
*/
|
||||
public Discover includeAdult(boolean includeAdult) {
|
||||
params.put(PARAM_ADULT, String.valueOf(includeAdult));
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the results release dates to matches that include this value.
|
||||
*
|
||||
* @param year
|
||||
*/
|
||||
public Discover year(int year) {
|
||||
if (checkYear(year)) {
|
||||
params.put(PARAM_YEAR, String.valueOf(year));
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the results so that only the primary release date year has this value
|
||||
*
|
||||
* @param primaryReleaseYear
|
||||
*/
|
||||
public Discover primaryReleaseYear(int primaryReleaseYear) {
|
||||
if (checkYear(primaryReleaseYear)) {
|
||||
params.put(PARAM_PRIMARY_RELEASE_YEAR, String.valueOf(primaryReleaseYear));
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Only include movies that are equal to, or have a vote count higher than this value
|
||||
*
|
||||
* @param voteCountGte
|
||||
*/
|
||||
public Discover voteCountGte(int voteCountGte) {
|
||||
if (voteCountGte > 0) {
|
||||
params.put(PARAM_VOTE_COUNT_GTE, String.valueOf(voteCountGte));
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Only include movies that are equal to, or have a higher average rating than this value
|
||||
*
|
||||
* @param voteAverageGte
|
||||
*/
|
||||
public Discover voteAverageGte(float voteAverageGte) {
|
||||
if (voteAverageGte > 0) {
|
||||
params.put(PARAM_VOTE_AVERAGE_GTE, String.valueOf(voteAverageGte));
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Only include movies with the specified genres.
|
||||
*
|
||||
* Expected value is an integer (the id of a genre).
|
||||
*
|
||||
* Multiple values can be specified.
|
||||
*
|
||||
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'
|
||||
*
|
||||
* @param withGenres
|
||||
*/
|
||||
public Discover withGenres(String withGenres) {
|
||||
if (StringUtils.isNotBlank(withGenres)) {
|
||||
params.put(PARAM_WITH_GENRES, withGenres);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* The minimum release to include.
|
||||
*
|
||||
* Expected format is YYYY-MM-DD.
|
||||
*
|
||||
* @param releaseDateGte
|
||||
*/
|
||||
public Discover releaseDateGte(String releaseDateGte) {
|
||||
if (StringUtils.isNotBlank(releaseDateGte)) {
|
||||
params.put(PARAM_RELEASE_DATE_GTE, releaseDateGte);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* The maximum release to include.
|
||||
*
|
||||
* Expected format is YYYY-MM-DD.
|
||||
*
|
||||
* @param releaseDateLte
|
||||
*/
|
||||
public Discover releaseDateLte(String releaseDateLte) {
|
||||
if (StringUtils.isNotBlank(releaseDateLte)) {
|
||||
params.put(PARAM_RELEASE_DATE_LTE, releaseDateLte);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Only include movies with certifications for a specific country.
|
||||
*
|
||||
* When this value is specified, 'certificationLte' is required.
|
||||
*
|
||||
* A ISO 3166-1 is expected
|
||||
*
|
||||
* @param certificationCountry
|
||||
*/
|
||||
public Discover certificationCountry(String certificationCountry) {
|
||||
if (StringUtils.isNotBlank(certificationCountry)) {
|
||||
params.put(PARAM_CERTIFICATION_COUNTRY, certificationCountry);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Only include movies with this certification and lower.
|
||||
*
|
||||
* Expected value is a valid certification for the specified 'certificationCountry'.
|
||||
*
|
||||
* @param certificationLte
|
||||
*/
|
||||
public Discover certificationLte(String certificationLte) {
|
||||
if (StringUtils.isNotBlank(certificationLte)) {
|
||||
params.put(PARAM_CERTIFICATION_LTE, certificationLte);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter movies to include a specific company.
|
||||
*
|
||||
* Expected value is an integer (the id of a company).
|
||||
*
|
||||
* They can be comma separated to indicate an 'AND' query
|
||||
*
|
||||
* @param withCompanies
|
||||
*/
|
||||
public Discover withCompanies(String withCompanies) {
|
||||
if (StringUtils.isNotBlank(withCompanies)) {
|
||||
params.put(PARAM_WITH_COMPANIES, withCompanies);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* check the year is between the min and max
|
||||
*
|
||||
* @param year
|
||||
* @return
|
||||
*/
|
||||
private boolean checkYear(int year) {
|
||||
return (year >= YEAR_MIN && year <= YEAR_MAX);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue