it.polimi.dima.mediatracker.controllers

Class MediaItemsAbstractController

java.lang.Object

it.polimi.dima.mediatracker.controllers.MediaItemsAbstractController

Direct Known Subclasses:

BooksController, MoviesController, TVShowsController, VideogamesController

public abstract class MediaItemsAbstractController
extends java.lang.Object

Controller for a generic media item. Allows to get several parameters of the media item (e.g. the model class) and to query the database to retrieve media items

Constructor Summary

Constructors

Constructor and Description
MediaItemsAbstractController()

Method Summary

Modifier and Type	Method and Description
void	deleteAllMediaItemsInCategory(Category category) Removes all media items in the given category
void	deleteMediaItem(MediaItem mediaItem) Removes a media item from the database
long	getAllMediaItemsNumberInCategory(Category category) Gets the count of all media items (tracked or completed) in this category
java.util.List<MediaItem>	getCompletedMediaItemsInCategory(int page, Category category) Gets all completed media items in the given category
abstract int	getCompleteOptionName() String for the "I've done this" media item option
abstract int	getDoingOptionName() String for the "I'm doing this now" media item option
protected abstract java.lang.String	getDurationDatabaseFieldName() "Internal" getter (used in getRandomMediaItem(Category, Long, List, List, String, int, int))
MediaItem	getMediaItemById(Category category, java.lang.Long itemId) Gets a media item by its ID in the given category
abstract FormMediaItemAbstractFragment	getMediaItemFormFragment(java.lang.Long categoryId, java.lang.Long mediaItemId, boolean isEmpty) Returns the fragment for the form of this media type
abstract MediaItemService	getMediaItemService(Context context) Getter
java.util.List<MediaItem>	getMediaItemsReleasedToday(Category category) Gets all media items whose release date is today
abstract SuggestionsAbstractFragment	getMediaItemSuggestionsFragment(java.lang.Long categoryId) Returns the fragment for the suggestions page of this media type
Subcategory[]	getMediaTypeSubcategories() The subcategories of this media type (= subcategories of each category of this media type)
abstract java.lang.Class	getModelClass() Getter
MediaItem	getRandomCompletedMediaItem(Category category, java.lang.Long idDifferentFromIfPossible, java.lang.String genresContains, int completedYearsAgo, int minDuration, int maxDuration) Retrieves a random completed media item in the given category that satisfies the given constraints
MediaItem	getRandomTrackedMediaItem(Category category, java.lang.Long idDifferentFromIfPossible, java.lang.String genresContains, java.lang.Boolean owned, int minDuration, int maxDuration) Retrieves a random tracked media item in the given category that satisfies the given constraints
abstract int	getRedoOptionName() String for the "I could redo this" media item option
java.util.List<MediaItem>	getTrackedMediaItemsInCategory(int page, Category category) Gets all tracked media items in the given category
abstract MediaItem	initializeEmptyMediaItem() Initializes and returns a new (empty) object of this media type
void	saveMediaItem(MediaItem mediaItem) Inserts or updates a media item in the database
java.util.List<MediaItem>	searchMediaItemsInCategory(int page, Category category, java.lang.String query, java.lang.Boolean completed) Searches for media items matching the given query
void	setMediaItemAsCompleted(MediaItem mediaItem, java.util.Date completionDate) Sets a media item as completed with the given date
void	setMediaItemAsDoingNow(MediaItem mediaItem, boolean doingNow) Sets a media item as "doing" (watching, reading, etc.) now
void	setMediaItemAsOwned(MediaItem mediaItem, boolean owned) Sets a media item as owned by the user
void	setMediaItemAsToRedo(MediaItem mediaItem) Sets a media item as "possibly to redo" (i.e.
void	setMediaItemOrderInSectionBeforeInserting(Category category, MediaItem newMediaItem) Called BEFORE inserting a new media item to compute its order value in its section
void	setMediaItemOrderInSectionBeforeUpdatingImportanceLevel(Category category, MediaItem updatedMediaItem) Called BEFORE changing a media item importance level NOTE: called e.g.
void	setOrderInSectionAfterMove(Category category, MediaItem movedMediaItem, MediaItem previousMediaItemInSection, MediaItem nextMediaItemInSection) Called to update the order field (for the database) AFTER "movedMediaItem" has been moved in the list
void	undoSetAsCompleted(MediaItem mediaItem) Undoes a previous call to setMediaItemAsCompleted(MediaItem, Date)
void	updateMediaItemCompletionDate(MediaItem mediaItem, java.util.Date completionDate) Updates a media item completion date
java.lang.String	validateMediaItem(Context context, MediaItem mediaItem) Validates a media item, possibly fixing what is wrong or, if impossible, returning an error string
java.lang.String	validateMediaItemDbRow(Context context, java.util.HashMap<java.lang.String,java.lang.Object> values) Like validateMediaItem(Context, MediaItem) but with actual DB values
protected abstract java.lang.String	validateSpecificMediaItem(Context context, MediaItem mediaItem) Validation for media item implementations
protected abstract java.lang.String	validateSpecificMediaItemDbRow(Context context, java.util.HashMap<java.lang.String,java.lang.Object> values) Validation for media item implementations

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaItemsAbstractController

public MediaItemsAbstractController()

Method Detail

getModelClass

public abstract java.lang.Class getModelClass()

Getter

Returns:

the class that represents the model of this media type

initializeEmptyMediaItem

public abstract MediaItem initializeEmptyMediaItem()

Initializes and returns a new (empty) object of this media type

Returns:

the new media item

getMediaItemService

public abstract MediaItemService getMediaItemService(Context context)

Getter

Returns:

the external service that manages this media type

getRedoOptionName

public abstract int getRedoOptionName()

String for the "I could redo this" media item option

Returns:

the resource id of the string

getCompleteOptionName

public abstract int getCompleteOptionName()

String for the "I've done this" media item option

Returns:

the resource id of the string

getDoingOptionName

public abstract int getDoingOptionName()

String for the "I'm doing this now" media item option

Returns:

the resource id of the string

getDurationDatabaseFieldName

protected abstract java.lang.String getDurationDatabaseFieldName()

"Internal" getter (used in getRandomMediaItem(Category, Long, List, List, String, int, int))

Returns:

the database column name for the duration (pages number, runtime, etc.) for this media type

getMediaTypeSubcategories

public Subcategory[] getMediaTypeSubcategories()

The subcategories of this media type (= subcategories of each category of this media type)

Returns:

the array of subcategories

getMediaItemFormFragment

public abstract FormMediaItemAbstractFragment getMediaItemFormFragment(java.lang.Long categoryId,
                                                                       java.lang.Long mediaItemId,
                                                                       boolean isEmpty)

Returns the fragment for the form of this media type

Parameters:

categoryId - the ID of the media item category

mediaItemId - null if adding new media item, the ID of the media item to edit otherwise

isEmpty - true if the form should be empty (= no fields are displayed, only the action bar)

Returns:

the form fragment

getMediaItemSuggestionsFragment

public abstract SuggestionsAbstractFragment getMediaItemSuggestionsFragment(java.lang.Long categoryId)

Returns the fragment for the suggestions page of this media type

Parameters:

categoryId - the ID of the media item category

Returns:

the suggestions fragment

getTrackedMediaItemsInCategory

public java.util.List<MediaItem> getTrackedMediaItemsInCategory(int page,
                                                                Category category)

Gets all tracked media items in the given category

Parameters:

page - the current page for the media items (e.g. 0 retrieves the first "PAGE_LENGTH" elements, 1 the elements from PAGE_LENGTH to 2*PAGE_LENGTH-1, etc.)

category - the media items category

Returns:

all tracked media items

getCompletedMediaItemsInCategory

public java.util.List<MediaItem> getCompletedMediaItemsInCategory(int page,
                                                                  Category category)

Gets all completed media items in the given category

Parameters:

page - the current page for the media items (e.g. 0 retrieves the first "PAGE_LENGTH" elements, 1 the elements from PAGE_LENGTH to 2*PAGE_LENGTH-1, etc.)

category - the media items category

Returns:

all completed media items

searchMediaItemsInCategory

public java.util.List<MediaItem> searchMediaItemsInCategory(int page,
                                                            Category category,
                                                            java.lang.String query,
                                                            java.lang.Boolean completed)

Searches for media items matching the given query

Parameters:

page - the current page for the media items (e.g. 0 retrieves the first "PAGE_LENGTH" elements, 1 the elements from PAGE_LENGTH to 2*PAGE_LENGTH-1, etc.)

category - the media items category

query - the string to search for

completed - true if only completed media items, false if only tracked (= not completed), null if any

Returns:

the media items that match the query

getMediaItemsReleasedToday

public java.util.List<MediaItem> getMediaItemsReleasedToday(Category category)

Gets all media items whose release date is today

Parameters:

category - the media items category

Returns:

all media items released today

getAllMediaItemsNumberInCategory

public long getAllMediaItemsNumberInCategory(Category category)

Gets the count of all media items (tracked or completed) in this category

Parameters:

category - the media items category

Returns:

the number of media items

getMediaItemById

public MediaItem getMediaItemById(Category category,
                                  java.lang.Long itemId)

Gets a media item by its ID in the given category

Parameters:

category - the media item category

itemId - the media item ID

Returns:

the media item if found, null otherwise

getRandomTrackedMediaItem

public MediaItem getRandomTrackedMediaItem(Category category,
                                           java.lang.Long idDifferentFromIfPossible,
                                           java.lang.String genresContains,
                                           java.lang.Boolean owned,
                                           int minDuration,
                                           int maxDuration)

Retrieves a random tracked media item in the given category that satisfies the given constraints

Parameters:

category - the media item category

idDifferentFromIfPossible - if possible, the retrieved media item has a different ID from this one ("if possible" means that if there's only one item that matches in the whole database, it is returned anyway). May be null

genresContains - genres contains this value. May be null

owned - true if the media item is owned by the user, false if it's not owned, null if it doesn't matter (owned or not)

minDuration - min duration (e.g. pages number, runtime,...). May be <= 0 if not interested in this constraint

maxDuration - max duration (e.g. pages number, runtime,...). May be <= 0 if not interested in this constraint

Returns:

a random media item or null if no match

getRandomCompletedMediaItem

public MediaItem getRandomCompletedMediaItem(Category category,
                                             java.lang.Long idDifferentFromIfPossible,
                                             java.lang.String genresContains,
                                             int completedYearsAgo,
                                             int minDuration,
                                             int maxDuration)

Retrieves a random completed media item in the given category that satisfies the given constraints

Parameters:

category - the media item category

idDifferentFromIfPossible - if possible, the retrieved media item has a different ID from this one ("if possible" means that if there's only one item that matches in the whole database, it is returned anyway). May be null

genresContains - genres contains this value. May be null

completedYearsAgo - completion date is at least the given amount of years ago. May be 0

minDuration - min duration (e.g. pages number, runtime,...). May be 0

maxDuration - max duration (e.g. pages number, runtime,...). May be 0

Returns:

a random media item or null if no match

setMediaItemAsCompleted

public void setMediaItemAsCompleted(MediaItem mediaItem,
                                    java.util.Date completionDate)

Sets a media item as completed with the given date

Parameters:

mediaItem - the media item

completionDate - the completion date

updateMediaItemCompletionDate

public void updateMediaItemCompletionDate(MediaItem mediaItem,
                                          java.util.Date completionDate)

Updates a media item completion date

Parameters:

mediaItem - the media item

completionDate - the completion date

setMediaItemAsDoingNow

public void setMediaItemAsDoingNow(MediaItem mediaItem,
                                   boolean doingNow)

Sets a media item as "doing" (watching, reading, etc.) now

Parameters:

mediaItem - the media item

doingNow - true if user is "doing" the media item now

setMediaItemAsOwned

public void setMediaItemAsOwned(MediaItem mediaItem,
                                boolean owned)

Sets a media item as owned by the user

Parameters:

mediaItem - the media item

owned - true if the user owns the media item

undoSetAsCompleted

public void undoSetAsCompleted(MediaItem mediaItem)

Undoes a previous call to setMediaItemAsCompleted(MediaItem, Date)

Parameters:

mediaItem - the media item

setMediaItemAsToRedo

public void setMediaItemAsToRedo(MediaItem mediaItem)

Sets a media item as "possibly to redo" (i.e. moves it from the completed list back to the tracked list)

Parameters:

mediaItem - the media item

saveMediaItem

public void saveMediaItem(MediaItem mediaItem)

Inserts or updates a media item in the database

Parameters:

mediaItem - the media item to update/insert

deleteMediaItem

public void deleteMediaItem(MediaItem mediaItem)

Removes a media item from the database

Parameters:

mediaItem - the media item to remove

deleteAllMediaItemsInCategory

public void deleteAllMediaItemsInCategory(Category category)

Removes all media items in the given category

Parameters:

category - the category

setOrderInSectionAfterMove

public void setOrderInSectionAfterMove(Category category,
                                       MediaItem movedMediaItem,
                                       MediaItem previousMediaItemInSection,
                                       MediaItem nextMediaItemInSection)

Called to update the order field (for the database) AFTER "movedMediaItem" has been moved in the list

Parameters:

category - the media item category

movedMediaItem - the media items that has just moved

previousMediaItemInSection - the media item before the moved one in the section

nextMediaItemInSection - the media item after the moved one in the section

setMediaItemOrderInSectionBeforeInserting

public void setMediaItemOrderInSectionBeforeInserting(Category category,
                                                      MediaItem newMediaItem)

Called BEFORE inserting a new media item to compute its order value in its section

Parameters:

category - the media item category

newMediaItem - the media item to be inserted

setMediaItemOrderInSectionBeforeUpdatingImportanceLevel

public void setMediaItemOrderInSectionBeforeUpdatingImportanceLevel(Category category,
                                                                    MediaItem updatedMediaItem)

Called BEFORE changing a media item importance level NOTE: called e.g. when we submit a form, not when the media item is moved in the list: in that case call setOrderInSectionAfterMove(Category, MediaItem, MediaItem, MediaItem)

Parameters:

category - the media item category

updatedMediaItem - the media item to be updated with a different importance level

validateMediaItem

public java.lang.String validateMediaItem(Context context,
                                          MediaItem mediaItem)

Validates a media item, possibly fixing what is wrong or, if impossible, returning an error string

Parameters:

context - the context

mediaItem - the media item to validate

Returns:

null if no error (or errors were fixed by this method), a string containing the error otherwise

validateSpecificMediaItem

protected abstract java.lang.String validateSpecificMediaItem(Context context,
                                                              MediaItem mediaItem)

Validation for media item implementations

See Also:

validateMediaItem(Context, MediaItem)

validateMediaItemDbRow

public java.lang.String validateMediaItemDbRow(Context context,
                                               java.util.HashMap<java.lang.String,java.lang.Object> values)

Like validateMediaItem(Context, MediaItem) but with actual DB values

Parameters:

context - the context

values - hash column name => value

Returns:

null if no error (or errors were fixed by this method), a string containing the error otherwise

validateSpecificMediaItemDbRow

protected abstract java.lang.String validateSpecificMediaItemDbRow(Context context,
                                                                   java.util.HashMap<java.lang.String,java.lang.Object> values)

Validation for media item implementations

See Also:

validateMediaItemDbRow(Context, HashMap)