service.tut.pori.contentanalysis

Class MediaObjectDAO

java.lang.Object

core.tut.pori.dao.SolrDAO

service.tut.pori.contentanalysis.MediaObjectDAO

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class MediaObjectDAO
extends SolrDAO

The DAO for storing and retrieving media objects. This class can also be used to retrieve media object suggestions. Note that if you wish to associate media objects with photos you must use PhotoDAO, not this class.

Field Summary

Fields inherited from class core.tut.pori.dao.SolrDAO

MAX_DOCUMENT_COUNT, SOLR_COMMIT_WITHIN, SOLR_FIELD_ID

Constructor Summary

Constructors

Constructor and Description
MediaObjectDAO()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getMediaObjectIds(UserIdentity authenticatedUser, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilter, MediaObjectList mediaObjectTerms)
MediaObjectList	getMediaObjects(DataGroups dataGroups, Limits limits, java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, java.util.Collection<java.lang.String> mediaObjectIds, long[] userIdFilter)
org.apache.solr.client.solrj.response.QueryResponse	getSuggestions(UserIdentity authenticatedUser, DataGroups dataGroups, Limits limits, java.lang.String query) Suggestion/Autocomplete from Solr
boolean	insert(MediaObjectList objects)
boolean	remove(java.util.Collection<java.lang.String> mediaobjectIds) This will also automatically remove any associations between the given media objects and their photos.
void	resolveObjectIds(MediaObjectList mediaObjects) Sets all missing ids for the given media objects if ids are found.
MediaObjectList	search(UserIdentity authenticatedUser, DataGroups dataGroups, Limits limits, java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, SortOptions sortOptions, long[] userIdFilter, MediaObjectList mediaObjectTerms) Note that because of solr limitations, the media object count cannot exceed MAX_FILTER_COUNT.
boolean	update(MediaObjectList objects)
boolean	updateIfNewer(MediaObjectList objects)

Methods inherited from class core.tut.pori.dao.SolrDAO

getSolrTemplate, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaObjectDAO

public MediaObjectDAO()

Method Detail

insert

public boolean insert(MediaObjectList objects)

Parameters:

objects -

Returns:

true on success

resolveObjectIds

public void resolveObjectIds(MediaObjectList mediaObjects)

Sets all missing ids for the given media objects if ids are found. Objects without valid mediaObjectId or backendId+objectId pair are ignored.

Parameters:

mediaObjects -

updateIfNewer

public boolean updateIfNewer(MediaObjectList objects)

Parameters:

objects -

Returns:

true on success. Note that nothing updated equals to success if no other errors are present.

update

public boolean update(MediaObjectList objects)

Parameters:

objects -

Returns:

true on success

remove

public boolean remove(java.util.Collection<java.lang.String> mediaobjectIds)

This will also automatically remove any associations between the given media objects and their photos.

Parameters:

mediaobjectIds -

Returns:

true on success

getMediaObjects

public MediaObjectList getMediaObjects(DataGroups dataGroups,
                                       Limits limits,
                                       java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes,
                                       java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                       java.util.Collection<java.lang.String> mediaObjectIds,
                                       long[] userIdFilter)
                                throws java.lang.IllegalArgumentException

Parameters:

dataGroups -

limits -

mediaTypes - target media types for the retrieval

serviceTypes -

mediaObjectIds -

userIdFilter -

Returns:

list of media objects or null if none was found

Throws:

java.lang.IllegalArgumentException - on bad query terms

getMediaObjectIds

public java.util.List<java.lang.String> getMediaObjectIds(UserIdentity authenticatedUser,
                                                          DataGroups dataGroups,
                                                          Limits limits,
                                                          java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                                          long[] userIdFilter,
                                                          MediaObjectList mediaObjectTerms)

Parameters:

authenticatedUser -

dataGroups -

limits -

serviceTypes -

userIdFilter -

mediaObjectTerms - list of terms to use for search. Note: if the objects have mediaObjectIds set, these will be directly used as filter

Returns:

list of ids or null if none

search

public MediaObjectList search(UserIdentity authenticatedUser,
                              DataGroups dataGroups,
                              Limits limits,
                              java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes,
                              java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                              SortOptions sortOptions,
                              long[] userIdFilter,
                              MediaObjectList mediaObjectTerms)
                       throws java.lang.IllegalArgumentException

Note that because of solr limitations, the media object count cannot exceed MAX_FILTER_COUNT.

Parameters:

authenticatedUser -

dataGroups -

limits -

mediaTypes - list of target media types for the search

serviceTypes -

sortOptions -

userIdFilter -

mediaObjectTerms - list of terms to use for search. Note: if the objects have mediaObjectIds set, these will be directly used as filter

Returns:

list of media objects or null if none was found

Throws:

java.lang.IllegalArgumentException - on bad values

getSuggestions

public org.apache.solr.client.solrj.response.QueryResponse getSuggestions(UserIdentity authenticatedUser,
                                                                          DataGroups dataGroups,
                                                                          Limits limits,
                                                                          java.lang.String query)

Suggestion/Autocomplete from Solr

Parameters:

authenticatedUser -

dataGroups - filters based on MediaObjectType. For applicable values see MediaObject.MediaObjectType.fromDataGroups(DataGroups).

limits -

query - the term to be searched for.

Returns:

response