Discover
Stuart Boston
11 years ago
parent
e4dc8e9465
commit
45caa4d14d
@ -0,0 +1,23 @@
|
|||||||
|
package com.omertron.themoviedbapi.enumeration;
|
||||||
|
|
||||||
|
public enum SortBy {
|
||||||
|
|
||||||
|
POPULARITY_ASC,
|
||||||
|
POPULARITY_DESC,
|
||||||
|
RELEASE_DATE_ASC,
|
||||||
|
RELEASE_DATE_DESC,
|
||||||
|
REVENUE_ASC,
|
||||||
|
REVENUE_DESC,
|
||||||
|
PRIMARY_RELEASE_DATE_ASC,
|
||||||
|
PRIMARY_RELEASE_DATE_DESC,
|
||||||
|
ORIGINAL_TITLE_ASC,
|
||||||
|
ORIGINAL_TITLE_DESC,
|
||||||
|
VOTE_AVERAGE_ASC,
|
||||||
|
VOTE_AVERAGE_DESC,
|
||||||
|
VOTE_COUNT_ASC,
|
||||||
|
VOTE_COUNT_DESC;
|
||||||
|
|
||||||
|
public String getPropertyString() {
|
||||||
|
return this.name().toLowerCase().replace("_asc", ".asc").replaceAll("_desc", ".desc");
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -1,248 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2004-2015 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.discover;
|
|
||||||
|
|
||||||
import com.omertron.themoviedbapi.tools.Param;
|
|
||||||
import com.omertron.themoviedbapi.tools.TmdbParameters;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Generate a discover object for use in the MovieDbApi
|
|
||||||
* <p/>
|
|
||||||
* This allows you to just add the search components you are concerned with
|
|
||||||
*
|
|
||||||
* @author stuart.boston
|
|
||||||
*/
|
|
||||||
public class Discover {
|
|
||||||
|
|
||||||
private final TmdbParameters params = new TmdbParameters();
|
|
||||||
|
|
||||||
private static final int YEAR_MIN = 1900;
|
|
||||||
private static final int YEAR_MAX = 2100;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the parameters
|
|
||||||
* <p/>
|
|
||||||
* This will be used to construct the URL in the API
|
|
||||||
*
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public TmdbParameters getParams() {
|
|
||||||
return params;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Minimum value is 1 if included.
|
|
||||||
*
|
|
||||||
* @param page
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover page(int page) {
|
|
||||||
params.add(Param.PAGE, page);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ISO 639-1 code
|
|
||||||
*
|
|
||||||
* @param language
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover language(String language) {
|
|
||||||
params.add(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
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover sortBy(String sortBy) {
|
|
||||||
params.add(Param.SORT_BY, sortBy);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Toggle the inclusion of adult titles
|
|
||||||
*
|
|
||||||
* @param includeAdult
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover includeAdult(boolean includeAdult) {
|
|
||||||
params.add(Param.ADULT, includeAdult);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Filter the results release dates to matches that include this value.
|
|
||||||
*
|
|
||||||
* @param year
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover year(int year) {
|
|
||||||
if (checkYear(year)) {
|
|
||||||
params.add(Param.YEAR, year);
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Filter the results so that only the primary release date year has this
|
|
||||||
* value
|
|
||||||
*
|
|
||||||
* @param primaryReleaseYear
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover primaryReleaseYear(int primaryReleaseYear) {
|
|
||||||
if (checkYear(primaryReleaseYear)) {
|
|
||||||
params.add(Param.PRIMARY_RELEASE_YEAR, primaryReleaseYear);
|
|
||||||
}
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Only include movies that are equal to, or have a vote count higher than
|
|
||||||
* this value
|
|
||||||
*
|
|
||||||
* @param voteCountGte
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover voteCountGte(int voteCountGte) {
|
|
||||||
params.add(Param.VOTE_COUNT_GTE, voteCountGte);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Only include movies that are equal to, or have a higher average rating
|
|
||||||
* than this value
|
|
||||||
*
|
|
||||||
* @param voteAverageGte
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover voteAverageGte(float voteAverageGte) {
|
|
||||||
params.add(Param.VOTE_AVERAGE_GTE, voteAverageGte);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Only include movies with the specified genres.
|
|
||||||
* <p/>
|
|
||||||
* Expected value is an integer (the id of a genre).
|
|
||||||
* <p/>
|
|
||||||
* Multiple values can be specified.
|
|
||||||
* <p/>
|
|
||||||
* Comma separated indicates an 'AND' query, while a pipe (|) separated
|
|
||||||
* value indicates an 'OR'
|
|
||||||
*
|
|
||||||
* @param withGenres
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover withGenres(String withGenres) {
|
|
||||||
params.add(Param.WITH_GENRES, withGenres);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The minimum release to include.
|
|
||||||
* <p/>
|
|
||||||
* Expected format is YYYY-MM-DD.
|
|
||||||
*
|
|
||||||
* @param releaseDateGte
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover releaseDateGte(String releaseDateGte) {
|
|
||||||
params.add(Param.RELEASE_DATE_GTE, releaseDateGte);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The maximum release to include.
|
|
||||||
* <p/>
|
|
||||||
* Expected format is YYYY-MM-DD.
|
|
||||||
*
|
|
||||||
* @param releaseDateLte
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover releaseDateLte(String releaseDateLte) {
|
|
||||||
params.add(Param.RELEASE_DATE_LTE, releaseDateLte);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Only include movies with certifications for a specific country.
|
|
||||||
* <p/>
|
|
||||||
* When this value is specified, 'certificationLte' is required.
|
|
||||||
* <p/>
|
|
||||||
* A ISO 3166-1 is expected
|
|
||||||
*
|
|
||||||
* @param certificationCountry
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover certificationCountry(String certificationCountry) {
|
|
||||||
params.add(Param.CERTIFICATION_COUNTRY, certificationCountry);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Only include movies with this certification and lower.
|
|
||||||
* <p/>
|
|
||||||
* Expected value is a valid certification for the specified
|
|
||||||
* 'certificationCountry'.
|
|
||||||
*
|
|
||||||
* @param certificationLte
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover certificationLte(String certificationLte) {
|
|
||||||
params.add(Param.CERTIFICATION_LTE, certificationLte);
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Filter movies to include a specific company.
|
|
||||||
* <p/>
|
|
||||||
* Expected value is an integer (the id of a company).
|
|
||||||
* <p/>
|
|
||||||
* They can be comma separated to indicate an 'AND' query
|
|
||||||
*
|
|
||||||
* @param withCompanies
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
public Discover withCompanies(String withCompanies) {
|
|
||||||
params.add(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;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -0,0 +1,506 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) 2004-2015 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.model2.discover;
|
||||||
|
|
||||||
|
import com.omertron.themoviedbapi.enumeration.SortBy;
|
||||||
|
import com.omertron.themoviedbapi.tools.Param;
|
||||||
|
import com.omertron.themoviedbapi.tools.TmdbParameters;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate a discover object for use in the MovieDbApi
|
||||||
|
* <p/>
|
||||||
|
* This allows you to just add the search components you are concerned with
|
||||||
|
*
|
||||||
|
* @author stuart.boston
|
||||||
|
*/
|
||||||
|
public class Discover {
|
||||||
|
|
||||||
|
private final TmdbParameters params = new TmdbParameters();
|
||||||
|
|
||||||
|
private static final int YEAR_MIN = 1900;
|
||||||
|
private static final int YEAR_MAX = 2100;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the parameters
|
||||||
|
* <p/>
|
||||||
|
* This will be used to construct the URL in the API
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public TmdbParameters getParams() {
|
||||||
|
return params;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Minimum value is 1 if included.
|
||||||
|
*
|
||||||
|
* @param page
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover page(int page) {
|
||||||
|
params.add(Param.PAGE, page);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ISO 639-1 code
|
||||||
|
*
|
||||||
|
* @param language
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover language(String language) {
|
||||||
|
params.add(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
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover sortBy(SortBy sortBy) {
|
||||||
|
params.add(Param.SORT_BY, sortBy.getPropertyString());
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggle the inclusion of adult titles
|
||||||
|
*
|
||||||
|
* @param includeAdult
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover includeAdult(boolean includeAdult) {
|
||||||
|
params.add(Param.ADULT, includeAdult);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggle the inclusion of items marked as a video.
|
||||||
|
*
|
||||||
|
* Expected value is a boolean, true or false. Default is true.
|
||||||
|
*
|
||||||
|
* @param includeVideo
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover includeVideo(boolean includeVideo) {
|
||||||
|
params.add(Param.INCLUDE_VIDEO, includeVideo);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the results release dates to matches that include this value.
|
||||||
|
*
|
||||||
|
* @param year
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover year(int year) {
|
||||||
|
if (checkYear(year)) {
|
||||||
|
params.add(Param.YEAR, year);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the results so that only the primary release date year has this value
|
||||||
|
*
|
||||||
|
* @param primaryReleaseYear
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover primaryReleaseYear(int primaryReleaseYear) {
|
||||||
|
if (checkYear(primaryReleaseYear)) {
|
||||||
|
params.add(Param.PRIMARY_RELEASE_YEAR, primaryReleaseYear);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that are equal to, or have a vote count higher than this value
|
||||||
|
*
|
||||||
|
* @param voteCountGte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover voteCountGte(int voteCountGte) {
|
||||||
|
params.add(Param.VOTE_COUNT_GTE, voteCountGte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that are equal to, or have a vote count higher than this value
|
||||||
|
*
|
||||||
|
* @param voteCountLte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover voteCountLte(int voteCountLte) {
|
||||||
|
params.add(Param.VOTE_COUNT_LTE, voteCountLte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that are equal to, or have a higher average rating than this value
|
||||||
|
*
|
||||||
|
* @param voteAverageGte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover voteAverageGte(float voteAverageGte) {
|
||||||
|
params.add(Param.VOTE_AVERAGE_GTE, voteAverageGte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that are less than or equal to this value
|
||||||
|
*
|
||||||
|
* @param voteAverageLte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover voteAverageLte(float voteAverageLte) {
|
||||||
|
params.add(Param.VOTE_AVERAGE_LTE, voteAverageLte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The minimum release to include.
|
||||||
|
* <p/>
|
||||||
|
* Expected format is YYYY-MM-DD.
|
||||||
|
*
|
||||||
|
* @param releaseDateGte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover releaseDateGte(String releaseDateGte) {
|
||||||
|
params.add(Param.RELEASE_DATE_GTE, releaseDateGte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum release to include.
|
||||||
|
* <p/>
|
||||||
|
* Expected format is YYYY-MM-DD.
|
||||||
|
*
|
||||||
|
* @param releaseDateLte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover releaseDateLte(String releaseDateLte) {
|
||||||
|
params.add(Param.RELEASE_DATE_LTE, releaseDateLte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with certifications for a specific country.
|
||||||
|
* <p/>
|
||||||
|
* When this value is specified, 'certificationLte' is required.
|
||||||
|
* <p/>
|
||||||
|
* A ISO 3166-1 is expected
|
||||||
|
*
|
||||||
|
* @param certificationCountry
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover certificationCountry(String certificationCountry) {
|
||||||
|
params.add(Param.CERTIFICATION_COUNTRY, certificationCountry);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with this certification and lower.
|
||||||
|
* <p/>
|
||||||
|
* Expected value is a valid certification for the specified 'certificationCountry'.
|
||||||
|
*
|
||||||
|
* @param certificationLte
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover certificationLte(String certificationLte) {
|
||||||
|
params.add(Param.CERTIFICATION_LTE, certificationLte);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with this certification.
|
||||||
|
*
|
||||||
|
* Expected value is a valid certification for the specified 'certificationCountry'.
|
||||||
|
*
|
||||||
|
* @param certification
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover certification(String certification) {
|
||||||
|
params.add(Param.CERTIFICATION, certification);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that have this person id added as a cast member.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id of a person).
|
||||||
|
*
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'
|
||||||
|
*
|
||||||
|
* @param withCast
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCast(String withCast) {
|
||||||
|
params.add(Param.WITH_CAST, withCast);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include media that have these person IDs added as cast members.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withCast
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCast(WithBuilder withCast) {
|
||||||
|
return withCast(withCast.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that have this person id added as a crew member.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id of a person).
|
||||||
|
*
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
|
||||||
|
*
|
||||||
|
* @param withCrew
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCrew(String withCrew) {
|
||||||
|
params.add(Param.WITH_CREW, withCrew);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include media that have these person IDs added as crew members.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withCrew
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCrew(WithBuilder withCrew) {
|
||||||
|
return withCrew(withCrew.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter movies to include a specific company.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id of a company).
|
||||||
|
*
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'
|
||||||
|
*
|
||||||
|
* @param withCompanies
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCompanies(String withCompanies) {
|
||||||
|
params.add(Param.WITH_COMPANIES, withCompanies);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter movies to include a specific company.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withCompanies
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withCompanies(WithBuilder withCompanies) {
|
||||||
|
return withCompanies(withCompanies.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with the specified genres.
|
||||||
|
* <p/>
|
||||||
|
* Expected value is an integer (the id of a genre).
|
||||||
|
* <p/>
|
||||||
|
* Multiple values can be specified.
|
||||||
|
* <p/>
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'
|
||||||
|
*
|
||||||
|
* @param withGenres
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withGenres(String withGenres) {
|
||||||
|
params.add(Param.WITH_GENRES, withGenres);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with the specified genres.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withGenres
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withGenres(WithBuilder withGenres) {
|
||||||
|
return withGenres(withGenres.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with the specified genres.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id of a genre).
|
||||||
|
*
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
|
||||||
|
*
|
||||||
|
* @param withKeywords
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withKeywords(String withKeywords) {
|
||||||
|
params.add(Param.WITH_KEYWORDS, withKeywords);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies with the specified genres.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withKeywords
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withKeywords(WithBuilder withKeywords) {
|
||||||
|
return withKeywords(withKeywords.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that have these person id's added as a cast or crew member.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id or ids of a person).
|
||||||
|
*
|
||||||
|
* Comma separated indicates an 'AND' query, while a pipe (|) separated value indicates an 'OR'.
|
||||||
|
*
|
||||||
|
* @param withPeople
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withPeople(String withPeople) {
|
||||||
|
params.add(Param.WITH_PEOPLE, withPeople);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only include movies that have these person id's added as a cast or crew member.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withPeople
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withPeople(WithBuilder withPeople) {
|
||||||
|
return withPeople(withPeople.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the air dates that match this year
|
||||||
|
*
|
||||||
|
* Expected value is a year.
|
||||||
|
*
|
||||||
|
* @param year
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover firstAirDateYear(int year) {
|
||||||
|
if (checkYear(year)) {
|
||||||
|
params.add(Param.FIRST_AIR_DATE_YEAR, year);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the air dates to years that are greater than or equal to this year
|
||||||
|
*
|
||||||
|
* @param year
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover firstAirDateYearGte(int year) {
|
||||||
|
if (checkYear(year)) {
|
||||||
|
params.add(Param.FIRST_AIR_DATE_GTE, year);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter the air dates to years that are less than or equal to this year
|
||||||
|
*
|
||||||
|
* @param year
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover firstAirDateYearLte(int year) {
|
||||||
|
if (checkYear(year)) {
|
||||||
|
params.add(Param.FIRST_AIR_DATE_LTE, year);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter TV shows to include a specific network.
|
||||||
|
*
|
||||||
|
* Expected value is an integer (the id of a network).
|
||||||
|
*
|
||||||
|
* They can be comma separated to indicate an 'AND' query.
|
||||||
|
*
|
||||||
|
* @param withNetworks
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withNetworks(String withNetworks) {
|
||||||
|
params.add(Param.WITH_NETWORKS, withNetworks);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter TV shows to include a specific network.
|
||||||
|
*
|
||||||
|
* Use the WithBuilder to generate the list,e.g.
|
||||||
|
*
|
||||||
|
* new WithBuilder(1).and(2).and(3)
|
||||||
|
*
|
||||||
|
* @param withNetworks
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public Discover withNetworks(WithBuilder withNetworks) {
|
||||||
|
return withNetworks(withNetworks.build());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* check the year is between the min and max
|
||||||
|
*
|
||||||
|
* @param year
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
private boolean checkYear(int year) {
|
||||||
|
return year >= YEAR_MIN && year <= YEAR_MAX;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,112 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) 2004-2015 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, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* TheMovieDB API is distributed in the hope that it will be useful,
|
||||||
|
* 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, see <http://www.gnu.org/licenses/>.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package com.omertron.themoviedbapi.model2.discover;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class to create a String for the "with???" parameters of the Discover method
|
||||||
|
*
|
||||||
|
* @author Stuart
|
||||||
|
*/
|
||||||
|
public class WithBuilder {
|
||||||
|
|
||||||
|
StringBuilder value = new StringBuilder();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create the first ID in the string
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
public WithBuilder(int id) {
|
||||||
|
value.append(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create the first ID in the string
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
public WithBuilder(String id) {
|
||||||
|
value.append(id);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate the string to pass to the method
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public String build() {
|
||||||
|
return value.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate the string to pass to the method
|
||||||
|
*
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return build();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an "AND ID"
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public WithBuilder and(int id) {
|
||||||
|
value.append(",").append(id);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an "AND ID"
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public WithBuilder and(String id) {
|
||||||
|
value.append(",").append(id);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an "OR ID"
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public WithBuilder or(int id) {
|
||||||
|
value.append("|").append(id);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add an "OR ID"
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
public WithBuilder or(String id) {
|
||||||
|
value.append("|").append(id);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue