org.richfaces.photoalbum.domain

Class Album

java.lang.Object

org.richfaces.photoalbum.domain.Album

All Implemented Interfaces:

Serializable

@Entity
public class Album
extends Object
implements Serializable

Class for representing Album Entity. EJB3 Entity Bean

Author:

Andrey Markhel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Album()

Method Summary

Methods

Modifier and Type	Method and Description
void	addImage(Image image) This method add image to collection of images of current album
boolean	equals(Object obj)
Image	getCoveringImage() This method determine covering image of this album
Date	getCreated()
String	getDescription()
Long	getId()
List<Image>	getImages() Getter for property images
int	getIndex(Image image) This method determine index of specified image in collection of images, belongs to this album.
String	getName()
User	getOwner() Getter for property owner
String	getPath() Return relative path of this album in file-system(relative to uploadRoot parameter)
Shelf	getShelf() Getter for property shelf
List<Image>	getUnvisitedImages()
int	hashCode()
boolean	isEmpty() This method determine is album empty or not
boolean	isOwner(User user)
boolean	isPreDefined() Getter for property preDefined
boolean	isShowAfterCreate()
void	removeImage(Image image) This method remove image from collection of images of album
void	setCoveringImage(Image coveringImage)
void	setCreated(Date created)
void	setDescription(String description)
void	setName(String name)
void	setShelf(Shelf parent)
void	setShowAfterCreate(boolean showAfterCreate)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Album

public Album()

Method Detail

getShelf

public Shelf getShelf()

Getter for property shelf

Returns:

Shelf object, that contains this album

setShelf

public void setShelf(Shelf parent)

getId

public Long getId()

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getImages

public List<Image> getImages()

Getter for property images

Returns:

List if images, belongs to this album

getCreated

public Date getCreated()

setCreated

public void setCreated(Date created)

getUnvisitedImages

public List<Image> getUnvisitedImages()

Returns:

List of unvisited images

setCoveringImage

public void setCoveringImage(Image coveringImage)

Parameters:

coveringImage - - Image for covering album

addImage

public void addImage(Image image)

This method add image to collection of images of current album

Parameters:

image - - image to add

removeImage

public void removeImage(Image image)

This method remove image from collection of images of album

Parameters:

image - - image to remove

getOwner

public User getOwner()

Getter for property owner

Returns:

User object, owner of this album

isOwner

public boolean isOwner(User user)

getIndex

public int getIndex(Image image)

This method determine index of specified image in collection of images, belongs to this album. Used in slideshow etc...

Returns:

index of specified image

getCoveringImage

public Image getCoveringImage()

This method determine covering image of this album

Returns:

covering image

isEmpty

public boolean isEmpty()

This method determine is album empty or not

isPreDefined

public boolean isPreDefined()

Getter for property preDefined

Returns:

is this shelf is predefined

getPath

public String getPath()

Return relative path of this album in file-system(relative to uploadRoot parameter)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isShowAfterCreate

public boolean isShowAfterCreate()

setShowAfterCreate

public void setShowAfterCreate(boolean showAfterCreate)