service.tut.pori.contentanalysis

Class PhotoDAO

java.lang.Object

core.tut.pori.dao.SolrDAO

service.tut.pori.contentanalysis.PhotoDAO

All Implemented Interfaces:

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

public class PhotoDAO
extends SolrDAO

This class can be used to add, remove and modify photo metadata, and also to associate the photos with media objects.

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
PhotoDAO()

Method Summary

Modifier and Type	Method and Description
void	associate(PhotoList photos) create photo-media object associations from the given photo list
void	deassociate(java.lang.String guid, java.lang.String mediaObjectId) Note: this will NOT remove the media object, and it will only remove the association between the given GUID and media object id.
java.util.List<AccessDetails>	getAccessDetails(UserIdentity authenticatedUser, java.util.Collection<java.lang.String> guids)
AccessDetails	getAccessDetails(UserIdentity authenticatedUser, java.lang.String guid)
PhotoList	getPhotos(DataGroups dataGroups, java.util.Collection<java.lang.String> guids, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilter)
boolean	insert(MediaObjectList objects) Inserts the objects and sets all media types to MediaUrlValidator.MediaType.PHOTO for all objects with MediaUrlValidator.MediaType.UNKNOWN or null media type-
boolean	insert(Photo photo)
boolean	insert(PhotoList photos)
void	remove(java.util.Collection<java.lang.String> guids) Note: content added through ContentStorage MUST be removed through ContentStorage, removing the metadata directly using this method may cause undefined behavior.
PhotoList	search(UserIdentity authenticatedUser, DataGroups dataGroups, java.util.Collection<java.lang.String> guids, Limits limits, MediaObjectList objects, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilter)
boolean	setOwners(PhotoList photos) Sets the owner details (userId) to the given photos, requires that GUID has been set to the photo object
boolean	update(MediaObjectList objects) Update the objects and sets all media types to MediaUrlValidator.MediaType.PHOTO for all objects with MediaUrlValidator.MediaType.UNKNOWN or null media type-
boolean	updatePhotos(UserIdentity authenticatedUser, PhotoList photos) Update the photos only the given photos have newer timestamps than the ones in the database Note: media objects, if present on the photos, will be updated/inserted, old objects will never be removed (i.e.
boolean	updatePhotosIfNewer(UserIdentity authenticatedUser, PhotoList photos) Update the photos only the given photos have newer timestamps than the ones in the database Note: media objects, if present on the photos, will be updated/inserted, old objects will never be removed (i.e.

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

PhotoDAO

public PhotoDAO()

Method Detail

insert

public boolean insert(MediaObjectList objects)

Inserts the objects and sets all media types to MediaUrlValidator.MediaType.PHOTO for all objects with MediaUrlValidator.MediaType.UNKNOWN or null media type-

Parameters:

objects -

Returns:

true on success

See Also:

MediaObjectDAO.insert(MediaObjectList)

update

public boolean update(MediaObjectList objects)

Update the objects and sets all media types to MediaUrlValidator.MediaType.PHOTO for all objects with MediaUrlValidator.MediaType.UNKNOWN or null media type-

Parameters:

objects -

Returns:

true on success

See Also:

MediaObjectDAO.update(MediaObjectList)

insert

public boolean insert(Photo photo)

Parameters:

photo -

Returns:

true on success

insert

public boolean insert(PhotoList photos)

Parameters:

photos -

Returns:

true on success

remove

public void remove(java.util.Collection<java.lang.String> guids)

Note: content added through ContentStorage MUST be removed through ContentStorage, removing the metadata directly using this method may cause undefined behavior.

Parameters:

guids -

See Also:

ContentStorageCore

getPhotos

public PhotoList getPhotos(DataGroups dataGroups,
                           java.util.Collection<java.lang.String> guids,
                           Limits limits,
                           java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                           long[] userIdFilter)

Parameters:

dataGroups - optional filter

guids - optional filter

limits - optional filter

serviceTypes - optional filter

userIdFilter - optional filter

Returns:

list of photos or null if none

search

public PhotoList search(UserIdentity authenticatedUser,
                        DataGroups dataGroups,
                        java.util.Collection<java.lang.String> guids,
                        Limits limits,
                        MediaObjectList objects,
                        java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                        long[] userIdFilter)
                 throws java.lang.IllegalArgumentException

Parameters:

authenticatedUser - optional filter

dataGroups - optional filter

guids - optional filter

limits - optional filter

objects - optional filter

serviceTypes - optional filter

userIdFilter - optional filter

Returns:

the results, or null if none.

Throws:

java.lang.IllegalArgumentException - on bad search terms

setOwners

public boolean setOwners(PhotoList photos)

Sets the owner details (userId) to the given photos, requires that GUID has been set to the photo object

Parameters:

photos -

Returns:

true on success, Note: the failed photos will have userId of null, thus, this method can also be used to check the existence of the given photos.

updatePhotosIfNewer

public boolean updatePhotosIfNewer(UserIdentity authenticatedUser,
                                   PhotoList photos)

Update the photos only the given photos have newer timestamps than the ones in the database Note: media objects, if present on the photos, will be updated/inserted, old objects will never be removed (i.e. this will NOT SET object, but only updates the object details). If you want to remove previously existing media objects, use MediaObjectDAO.

Parameters:

authenticatedUser -

photos -

Returns:

true on success, note that nothing updated also equals to true if no other errors occur

updatePhotos

public boolean updatePhotos(UserIdentity authenticatedUser,
                            PhotoList photos)

Update the photos only the given photos have newer timestamps than the ones in the database Note: media objects, if present on the photos, will be updated/inserted, old objects will never be removed (i.e. this will NOT SET object, but only updates the object details). If you want to remove previously existing media objects, use MediaObjectDAO.

Parameters:

authenticatedUser -

photos -

Returns:

true on success

getAccessDetails

public java.util.List<AccessDetails> getAccessDetails(UserIdentity authenticatedUser,
                                                      java.util.Collection<java.lang.String> guids)

Parameters:

authenticatedUser -

guids -

Returns:

access details for the photos, or null if none of the photo exist

getAccessDetails

public AccessDetails getAccessDetails(UserIdentity authenticatedUser,
                                      java.lang.String guid)

Parameters:

authenticatedUser -

guid -

Returns:

access details for the photo, or null if the photo does not exist

deassociate

public void deassociate(java.lang.String guid,
                        java.lang.String mediaObjectId)

Note: this will NOT remove the media object, and it will only remove the association between the given GUID and media object id. Use MediaObjectDAO if you want to remove the media objects.

Parameters:

guid - if null, the given media object will be de-associated from all GUIDs

mediaObjectId - if null, all media objects for the given GUID will be de-associated

associate

public void associate(PhotoList photos)

create photo-media object associations from the given photo list

Parameters:

photos -