MediaMetadata (tinyMediaManager scraper API 1.1 API)

java.lang.Object
- org.tinymediamanager.scraper.MediaMetadata

```
public class MediaMetadata
extends Object
```
The Class MediaMetadata. This is the main class to transport meta data.

Since:

1.0

Author:

Manuel Laggner

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ABSOLUTE_NR`
`static String`	`BACKGROUND_URL`
`static String`	`COLLECTION_NAME`
`static String`	`COUNTRY`
`static String`	`EPISODE_NR`
`static String`	`EPISODE_NR_COMBINED`
`static String`	`EPISODE_NR_DISPLAY`
`static String`	`EPISODE_NR_DVD`
`static String`	`IMDB`
`static Date`	`INITIAL_DATE`
`static String`	`ORIGINAL_TITLE`
`static String`	`PLOT`
`static String`	`POSTER_URL`
`static String`	`PRODUCTION_COMPANY`
`static String`	`PROVIDER_ID`
`static String`	`RATING`
`static String`	`RELEASE_DATE`
`static String`	`RUNTIME`
`static String`	`SEASON_NR`
`static String`	`SEASON_NR_COMBINED`
`static String`	`SEASON_NR_DISPLAY`
`static String`	`SEASON_NR_DVD`
`static String`	`SPOKEN_LANGUAGES`
`static String`	`STATUS`
`static String`	`TAGLINE`
`static String`	`TITLE`
`static String`	`TMDB`
`static String`	`TMDB_SET`
`static String`	`TOP_250`
`static String`	`TVDB`
`static String`	`VOTE_COUNT`
`static String`	`YEAR`

Constructor Summary

Constructors
Constructor and Description

MediaMetadata(String providerId)
Instantiates a new media metadata for the given provider.

Constructors
Constructor and Description
`MediaMetadata(String providerId)` Instantiates a new media metadata for the given provider.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCastMember(MediaCastMember cm)` Adds the cast member.
`void`	`addCertification(Certification certification)` Adds the certification.
`void`	`addGenre(MediaGenres genre)` Adds the genre.
`void`	`addMediaArt(List<MediaArtwork> art)` Adds the media art.
`void`	`addMediaArt(MediaArtwork ma)` Adds the media art.
`void`	`addSubItem(MediaMetadata item)` Add a sub item
`void`	`addTrailer(MediaTrailer trailer)` Adds the trailer.
`void`	`clearMediaArt()` Clear media art.
`HashMap<String,Object>`	`getAllMetadata()` Gets all metadata
`List<MediaCastMember>`	`getCastMembers()` Gets the cast members.
`List<MediaCastMember>`	`getCastMembers(MediaCastMember.CastType type)` Gets the cast members.
`List<Certification>`	`getCertifications()` Gets the certifications.
`Date`	`getDateValue(String key)` Gets the Date value for a given key.
`Double`	`getDoubleValue(String key)` Gets the Double value for a given key.
`List<MediaArtwork>`	`getFanart()` Gets the fanart.
`Float`	`getFloatValue(String key)` Gets the Float value for a given key.
`List<MediaGenres>`	`getGenres()` Gets the genres.
`Object`	`getId(String key)` Gets an ID.
`HashMap<String,Object>`	`getIds()` Gets all IDs.
`Integer`	`getIntegerValue(String key)` Gets the Integer value for a given key.
`Integer`	`getIntegerValue(String key, Integer defaultValue)` Gets the Integer value for a given key.
`List<MediaArtwork>`	`getMediaArt(MediaArtwork.MediaArtworkType type)` Gets the media art.
`String`	`getProviderId()` Gets the provider id.
`String`	`getStringValue(String key)` Gets the String value for a given key
`List<MediaMetadata>`	`getSubItems()` Get all subitems
`List<MediaTrailer>`	`getTrailers()` Gets the trailers.
`void`	`mergeFrom(MediaMetadata md)` merges all entries from other MD into ours, IF VALUES ARE EMPTY needs testing!
`void`	`setId(String key, Object object)` Sets an ID.
`void`	`storeMetadata(String key, Object value)` Stores a metadata in the internal map.
`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

- Field Detail
  - PROVIDER_ID
```
public static final String PROVIDER_ID
```
    See Also:
    Constant Field Values
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    See Also:
    Constant Field Values
  - TITLE
```
public static final String TITLE
```
    See Also:
    Constant Field Values
  - ORIGINAL_TITLE
```
public static final String ORIGINAL_TITLE
```
    See Also:
    Constant Field Values
  - PLOT
```
public static final String PLOT
```
    See Also:
    Constant Field Values
  - RATING
```
public static final String RATING
```
    See Also:
    Constant Field Values
  - VOTE_COUNT
```
public static final String VOTE_COUNT
```
    See Also:
    Constant Field Values
  - TOP_250
```
public static final String TOP_250
```
    See Also:
    Constant Field Values
  - RUNTIME
```
public static final String RUNTIME
```
    See Also:
    Constant Field Values
  - TAGLINE
```
public static final String TAGLINE
```
    See Also:
    Constant Field Values
  - PRODUCTION_COMPANY
```
public static final String PRODUCTION_COMPANY
```
    See Also:
    Constant Field Values
  - YEAR
```
public static final String YEAR
```
    See Also:
    Constant Field Values
  - RELEASE_DATE
```
public static final String RELEASE_DATE
```
    See Also:
    Constant Field Values
  - SPOKEN_LANGUAGES
```
public static final String SPOKEN_LANGUAGES
```
    See Also:
    Constant Field Values
  - COUNTRY
```
public static final String COUNTRY
```
    See Also:
    Constant Field Values
  - POSTER_URL
```
public static final String POSTER_URL
```
    See Also:
    Constant Field Values
  - BACKGROUND_URL
```
public static final String BACKGROUND_URL
```
    See Also:
    Constant Field Values
  - STATUS
```
public static final String STATUS
```
    See Also:
    Constant Field Values
  - EPISODE_NR
```
public static final String EPISODE_NR
```
    See Also:
    Constant Field Values
  - SEASON_NR
```
public static final String SEASON_NR
```
    See Also:
    Constant Field Values
  - EPISODE_NR_DVD
```
public static final String EPISODE_NR_DVD
```
    See Also:
    Constant Field Values
  - SEASON_NR_DVD
```
public static final String SEASON_NR_DVD
```
    See Also:
    Constant Field Values
  - EPISODE_NR_DISPLAY
```
public static final String EPISODE_NR_DISPLAY
```
    See Also:
    Constant Field Values
  - SEASON_NR_DISPLAY
```
public static final String SEASON_NR_DISPLAY
```
    See Also:
    Constant Field Values
  - EPISODE_NR_COMBINED
```
public static final String EPISODE_NR_COMBINED
```
    See Also:
    Constant Field Values
  - SEASON_NR_COMBINED
```
public static final String SEASON_NR_COMBINED
```
    See Also:
    Constant Field Values
  - ABSOLUTE_NR
```
public static final String ABSOLUTE_NR
```
    See Also:
    Constant Field Values
  - IMDB
```
public static final String IMDB
```
    See Also:
    Constant Field Values
  - TMDB
```
public static final String TMDB
```
    See Also:
    Constant Field Values
  - TVDB
```
public static final String TVDB
```
    See Also:
    Constant Field Values
  - TMDB_SET
```
public static final String TMDB_SET
```
    See Also:
    Constant Field Values
  - INITIAL_DATE
```
public static Date INITIAL_DATE
```
- Constructor Detail
  - MediaMetadata
```
public MediaMetadata(String providerId)
```
    Instantiates a new media metadata for the given provider.
    
    Parameters:
    providerId - the provider id
- Method Detail
  - mergeFrom
```
public void mergeFrom(MediaMetadata md)
```
    merges all entries from other MD into ours, IF VALUES ARE EMPTY
    needs testing!
    
    Parameters:
    md - other MediaMetadata
  - getProviderId
```
public String getProviderId()
```
    Gets the provider id.
    
    Returns:
    the provider id
  - storeMetadata
```
public void storeMetadata(String key,
                 Object value)
```
    Stores a metadata in the internal map. Do not store IDs here. Use the ID map
    
    Parameters:
    key - the key
    value - the metadata
  - getAllMetadata
```
public HashMap<String,Object> getAllMetadata()
```
    Gets all metadata
    
    Returns:
    the metadata obj
  - getStringValue
```
public String getStringValue(String key)
```
    Gets the String value for a given key
    
    Parameters:
    key - the key
    
    Returns:
    value the value
  - getIntegerValue
```
public Integer getIntegerValue(String key)
```
    Gets the Integer value for a given key. Integer are passed right thru, whilst other type are casted to an Integer
    
    Parameters:
    key - the key
    
    Returns:
    value the value
  - getIntegerValue
```
public Integer getIntegerValue(String key,
                      Integer defaultValue)
```
    Gets the Integer value for a given key. Integer are passed right thru, whilst other type are casted to an Integer. If any error occur, the default value will be returned
    
    Parameters:
    key - the key
    defaultValue - the default value to be returned on any error
    
    Returns:
    value the value
  - getFloatValue
```
public Float getFloatValue(String key)
```
    Gets the Float value for a given key. Float are passed right thru, whilst other type are casted to an Float
    
    Parameters:
    key - the key
    
    Returns:
    value the value
  - getDoubleValue
```
public Double getDoubleValue(String key)
```
    Gets the Double value for a given key. Double are passed right thru, whilst other type are casted to an Double
    
    Parameters:
    key - the key
    
    Returns:
    value the value
  - getDateValue
```
public Date getDateValue(String key)
```
    Gets the Date value for a given key. Date are passed right thru, whilst trying to parse String to Date object. Other types are returned with an initial value
    
    Parameters:
    key - the key
    
    Returns:
    value the value
  - getGenres
```
public List<MediaGenres> getGenres()
```
    Gets the genres.
    
    Returns:
    the genres
  - getCastMembers
```
public List<MediaCastMember> getCastMembers(MediaCastMember.CastType type)
```
    Gets the cast members.
    
    Parameters:
    type - the type
    
    Returns:
    the cast members
  - getMediaArt
```
public List<MediaArtwork> getMediaArt(MediaArtwork.MediaArtworkType type)
```
    Gets the media art.
    
    Parameters:
    type - the type
    
    Returns:
    the media art
  - addGenre
```
public void addGenre(MediaGenres genre)
```
    Adds the genre.
    
    Parameters:
    genre - the genre
  - addCastMember
```
public void addCastMember(MediaCastMember cm)
```
    Adds the cast member.
    
    Parameters:
    cm - the cast member
  - addMediaArt
```
public void addMediaArt(MediaArtwork ma)
```
    Adds the media art.
    
    Parameters:
    ma - the ma
  - clearMediaArt
```
public void clearMediaArt()
```
    Clear media art.
  - addMediaArt
```
public void addMediaArt(List<MediaArtwork> art)
```
    Adds the media art.
    
    Parameters:
    art - the art
  - getCastMembers
```
public List<MediaCastMember> getCastMembers()
```
    Gets the cast members.
    
    Returns:
    the cast members
  - getFanart
```
public List<MediaArtwork> getFanart()
```
    Gets the fanart.
    
    Returns:
    the fanart
  - addSubItem
```
public void addSubItem(MediaMetadata item)
```
    Add a sub item
    
    Parameters:
    item - the subitem to be added
  - getSubItems
```
public List<MediaMetadata> getSubItems()
```
    Get all subitems
    
    Returns:
    a list of all sub items
  - addCertification
```
public void addCertification(Certification certification)
```
    Adds the certification.
    
    Parameters:
    certification - the certification
  - getCertifications
```
public List<Certification> getCertifications()
```
    Gets the certifications.
    
    Returns:
    the certifications
  - addTrailer
```
public void addTrailer(MediaTrailer trailer)
```
    Adds the trailer. To use only when scraping the metadata also provides the trailers
    
    Parameters:
    trailer - the trailer
  - getTrailers
```
public List<MediaTrailer> getTrailers()
```
    Gets the trailers.
    
    Returns:
    the trailers
  - setId
```
public void setId(String key,
         Object object)
```
    Sets an ID.
    
    Parameters:
    key - the ID-key
    object - the id
  - getId
```
public Object getId(String key)
```
    Gets an ID.
    
    Parameters:
    key - the ID-key
    
    Returns:
    the id
  - getIds
```
public HashMap<String,Object> getIds()
```
    Gets all IDs.
    
    Returns:
    the IDs
  - 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)

Class MediaMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROVIDER_ID

COLLECTION_NAME

TITLE

ORIGINAL_TITLE

PLOT

RATING

VOTE_COUNT

TOP_250

RUNTIME

TAGLINE

PRODUCTION_COMPANY

YEAR

RELEASE_DATE

SPOKEN_LANGUAGES

COUNTRY

POSTER_URL

BACKGROUND_URL

STATUS

EPISODE_NR

SEASON_NR

EPISODE_NR_DVD

SEASON_NR_DVD

EPISODE_NR_DISPLAY

SEASON_NR_DISPLAY

EPISODE_NR_COMBINED

SEASON_NR_COMBINED

ABSOLUTE_NR

IMDB

TMDB

TVDB

TMDB_SET

INITIAL_DATE

Constructor Detail

MediaMetadata

Method Detail

mergeFrom

getProviderId

storeMetadata

getAllMetadata

getStringValue

getIntegerValue

getIntegerValue

getFloatValue

getDoubleValue

getDateValue

getGenres

getCastMembers

getMediaArt

addGenre

addCastMember

addMediaArt

clearMediaArt

addMediaArt

getCastMembers

getFanart

addSubItem

getSubItems

addCertification

getCertifications

addTrailer

getTrailers

setId

getId

getIds

toString