org.tinymediamanager.scraper

Class MediaScrapeOptions

java.lang.Object

org.tinymediamanager.scraper.MediaScrapeOptions

public class MediaScrapeOptions
extends Object

This class is used to set the scrape options for scraping.

Since:

2.1

Author:

Manuel Laggner

Constructor Summary

Constructors

Constructor and Description
MediaScrapeOptions(MediaType type)

Method Summary

Methods

Modifier and Type	Method and Description
MediaArtwork.MediaArtworkType	getArtworkType() Get the preferred artwork type
CountryCode	getCountry() Get the desired country for scraping
MediaArtwork.FanartSizes	getFanartSize() Get the desired fanart size for scraping
String	getId(String providerId) Get the id for the given provider id
String	getImdbId() Get the imdb id - just a convenience method to get the Id for the provider imdb
Locale	getLanguage() Get the desired language for the scrape
MediaMetadata	getMetadata() Get any previous scraped meta data
MediaArtwork.PosterSizes	getPosterSize() Get the desired poster size for scraping
MediaSearchResult	getResult() Get a previous found search result
int	getTmdbId() Get the tmdb id - just a convenience method to get the Id for the provider tmdb
MediaType	getType() Get the media type
void	setArtworkType(MediaArtwork.MediaArtworkType artworkType) Set the preferred artwork type
void	setCountry(CountryCode country) Set the desired country for scraping
void	setFanartSize(MediaArtwork.FanartSizes fanartSize) Set the desired fanart size for scraping
void	setId(String providerId, String id) Set an media id for a provider id
void	setImdbId(String imdbId) Set the imdb id - just a convenience method to set the Id for the provider imdb
void	setLanguage(Locale language) Set the desired language for the scrape
void	setMetadata(MediaMetadata metadata) Set any existing meta data
void	setPosterSize(MediaArtwork.PosterSizes posterSize) Set the desired poster size for scraping
void	setResult(MediaSearchResult result) Set a search result if available
void	setTmdbId(int tmdbId) Set the itdb id - just a convenience method to set the Id for the provider tmdb
String	toString() Uses ReflectionToStringBuilder to generate a toString for the specified object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaScrapeOptions

public MediaScrapeOptions(MediaType type)

Method Detail

getResult

public MediaSearchResult getResult()

Get a previous found search result

Returns:

the search result if available or null

setResult

public void setResult(MediaSearchResult result)

Set a search result if available

Parameters:

result - the search result

getId

public String getId(String providerId)

Get the id for the given provider id

Parameters:

providerId - the provider Id

Returns:

the id or null

setId

public void setId(String providerId,
         String id)

Set an media id for a provider id

Parameters:

providerId - the provider id

id - the media id

getImdbId

public String getImdbId()

Get the imdb id - just a convenience method to get the Id for the provider imdb

Returns:

the imdbid or an empty string

getTmdbId

public int getTmdbId()

Get the tmdb id - just a convenience method to get the Id for the provider tmdb

Returns:

the tmdbid or 0

setImdbId

public void setImdbId(String imdbId)

Set the imdb id - just a convenience method to set the Id for the provider imdb

Parameters:

imdbId - the imdb id

setTmdbId

public void setTmdbId(int tmdbId)

Set the itdb id - just a convenience method to set the Id for the provider tmdb

Parameters:

tmdbId - the tmdb id

getArtworkType

public MediaArtwork.MediaArtworkType getArtworkType()

Get the preferred artwork type

Returns:

the artwork type

setArtworkType

public void setArtworkType(MediaArtwork.MediaArtworkType artworkType)

Set the preferred artwork type

Parameters:

artworkType - the artwork type

getMetadata

public MediaMetadata getMetadata()

Get any previous scraped meta data

Returns:

the meta data or null

setMetadata

public void setMetadata(MediaMetadata metadata)

Set any existing meta data

Parameters:

metadata - the meta data

getType

public MediaType getType()

Get the media type

Returns:

the media type

getLanguage

public Locale getLanguage()

Get the desired language for the scrape

Returns:

the language

setLanguage

public void setLanguage(Locale language)

Set the desired language for the scrape

Parameters:

language - language

getCountry

public CountryCode getCountry()

Get the desired country for scraping

Returns:

the country

setCountry

public void setCountry(CountryCode country)

Set the desired country for scraping

Parameters:

country - the country

getFanartSize

public MediaArtwork.FanartSizes getFanartSize()

Get the desired fanart size for scraping

Returns:

the desired fanart size

getPosterSize

public MediaArtwork.PosterSizes getPosterSize()

Get the desired poster size for scraping

Returns:

the desired poster size

setFanartSize

public void setFanartSize(MediaArtwork.FanartSizes fanartSize)

Set the desired fanart size for scraping

Parameters:

fanartSize - the desired fanart size

setPosterSize

public void setPosterSize(MediaArtwork.PosterSizes posterSize)

Set the desired poster size for scraping

Parameters:

posterSize - the desired poster size

toString

public String toString()

Uses ReflectionToStringBuilder to generate a toString for the specified object.

Overrides:

toString in class Object

Returns:

the String result

See Also:

ReflectionToStringBuilder.toString(Object)