Class Image

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.DatabaseBlobBean

org.deltava.beans.ImageBean

org.deltava.beans.gallery.Image

All Implemented Interfaces:

Serializable, Comparable<Object>, AuthoredBean, ComboAlias, IDBean, Cacheable

public class Image
extends ImageBean
implements AuthoredBean, ComboAlias

A class to store Image Gallery images.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ImageBean

ImageBean.ImageFormat

Modifier and Type	Class	Description
static enum	ImageBean.ImageFormat	Supported image types.

Field Summary

Fields inherited from class DatabaseBlobBean

_buffer

Modifier and Type	Field	Description
protected byte[]	_buffer	The buffer for the image/file data.

Constructor Summary

Constructors

Constructor	Description
Image(String name, String desc)	Create a new Image with a particular name.

Method Summary

Modifier and Type	Method	Description
void	addLike(int userID)	Adds a like for this image.
int	getAuthorID()	Returns the Author of this bean.
String	getComboAlias()	Returns the alias to use in the HTML <OPTION> element.
String	getComboName()	Returns the visible name to use in the HTML <OPTION> element.
Instant	getCreatedOn()	Returns the date this Image was created.
String	getDescription()	Returns a description of the image.
boolean	getFleet()	Returns if this image is part of the Fleet Gallery.
ImageType	getImageType()	Returns the database image type.
int	getLikeCount()	Returns the number of Votes cast for this Image.
Collection<Integer>	getLikes()	Returns all votes for this image.
String	getName()	Returns the name of the image.
int	getThreadID()	Returns the database ID of the Water Cooler discussion thread associated with this Gallery Image.
boolean	hasLiked(Person p)	Checks if a particular person has cast a vote for this image
void	setAuthorID(int id)	Updates the Author of this Image.
void	setCreatedOn(Instant dt)	Updates the date this Image was created.
void	setDescription(String desc)	Updates the Image's description.
void	setFleet(boolean fleet)	Updates if this image is part of the Fleet Gallery.
void	setLikeCount(int count)	Updates the number of Likes for this Image.
void	setName(String name)	Updates the name of this Image.
void	setThreadID(int id)	Updates the Water Cooler discussion thread associated with this Image.

Methods inherited from class ImageBean

checkParam, getFormat, getHasImage, getHeight, getSize, getWidth, load, load, setFormat, setHeight, setSize, setWidth

Modifier and Type	Method	Description
protected static void	checkParam(int param, String msg)	Helper method to check for negative numeric parameters.
ImageBean.ImageFormat	getFormat()	Returns the type of image.
boolean	getHasImage()	Queries if the bean has an associated Image.
int	getHeight()	Returns the height of the image.
int	getSize()	Returns the size of the image.
int	getWidth()	Returns the width of the image.
final void	load(byte[] buffer)	Updates the image buffer.
final void	load(InputStream is)	Loads an image into the buffer.
void	setFormat(ImageBean.ImageFormat t)	Updates the image format.
void	setHeight(int y)	Updates the height of this image.
void	setSize(int newSize)	Updates the size of this image.
void	setWidth(int x)	Updates the width of this image.

Methods inherited from class DatabaseBlobBean

clear, getInputStream, isLoaded

Modifier and Type	Method	Description
void	clear()	Clears the buffer.
InputStream	getInputStream()	Returns the content of the buffer.
boolean	isLoaded()	Returns whether the buffer has been populated.

Methods inherited from class DatabaseBean

cacheKey, compareTo, equals, getHexID, getID, hashCode, setID, validateID, validateID

Modifier and Type	Method	Description
Object	cacheKey()	Returns the cache key for this object.
int	compareTo(Object o)
boolean	equals(Object o)
String	getHexID()	Returns the hexadecimal database ID of this object.
int	getID()	Returns the database ID of this object.
int	hashCode()
void	setID(int id)	Update the database row ID of this bean.
static void	validateID(int oldID, int newID)	Validates a database ID.
static void	validateID(int oldID, int newID, boolean allowZero)	Validates a database ID.

Methods inherited from class Object

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

Constructor Details

Image

public Image(String name,
 String desc)

Create a new Image with a particular name.

Parameters:

name - the name of the Image

desc - a description of the Image

Throws:

NullPointerException - if name or desc are null

Method Details

getName

public String getName()

Returns the name of the image.

Returns:

the name of the image

See Also:

• getName()

getAuthorID

public int getAuthorID()

Description copied from interface: AuthoredBean

Returns the Author of this bean.

Specified by:

getAuthorID in interface AuthoredBean

Returns:

the author's database ID

See Also:

• AuthoredBean.setAuthorID(int)

getImageType

public ImageType getImageType()

Description copied from class: ImageBean

Returns the database image type.

Specified by:

getImageType in class ImageBean

Returns:

an ImageType

getThreadID

public int getThreadID()

Returns the database ID of the Water Cooler discussion thread associated with this Gallery Image.

Returns:

the Database ID of the Thread linked to this Image

See Also:

• setThreadID(int)

getDescription

public String getDescription()

Returns a description of the image.

Returns:

the image's description

See Also:

• setDescription(String)

getComboName

public String getComboName()

Description copied from interface: ComboAlias

Returns the visible name to use in the HTML <OPTION> element.

Specified by:

getComboName in interface ComboAlias

Returns:

The visible name for this entry

getComboAlias

public String getComboAlias()

Description copied from interface: ComboAlias

Returns the alias to use in the HTML <OPTION> element.

Specified by:

getComboAlias in interface ComboAlias

Returns:

The alias for this entry

getCreatedOn

public Instant getCreatedOn()

Returns the date this Image was created.

Returns:

the date/time this Image was created on

See Also:

• setCreatedOn(Instant)

getFleet

public boolean getFleet()

Returns if this image is part of the Fleet Gallery.

Returns:

TRUE if the image is in the Fleet Gallery, otherwise FALSE

See Also:

• setFleet(boolean)

setCreatedOn

public void setCreatedOn(Instant dt)

Updates the date this Image was created.

Parameters:

dt - the date/time this Image was created on

See Also:

• getCreatedOn()

setAuthorID

public void setAuthorID(int id)

Updates the Author of this Image.

Specified by:

setAuthorID in interface AuthoredBean

Parameters:

id - the Database ID of the author of this Image

Throws:

IllegalArgumentException - if id is zero or negative

See Also:

• getAuthorID()

setThreadID

public void setThreadID(int id)

Updates the Water Cooler discussion thread associated with this Image.

Parameters:

id - the Database ID of the discussion thread

Throws:

IllegalArgumentException - if id is negative

See Also:

• getThreadID()

setName

public void setName(String name)

Updates the name of this Image.

Parameters:

name - the new Image name

Throws:

NullPointerException - if name is null

See Also:

• getName()

setDescription

public void setDescription(String desc)

Updates the Image's description.

Parameters:

desc - the new Image description

Throws:

NullPointerException - if desc is null

See Also:

• getDescription()

setFleet

public void setFleet(boolean fleet)

Updates if this image is part of the Fleet Gallery.

Parameters:

fleet - TRUE if the image is part of the Fleet Gallery, otherwise FALSE

See Also:

• getFleet()

addLike

public void addLike(int userID)

Adds a like for this image.

Parameters:

userID - the database ID of the liking user

setLikeCount

public void setLikeCount(int count)

Updates the number of Likes for this Image.

Parameters:

count - the number of Likes

Throws:

IllegalStateException - if the Votes have already been loaded

See Also:

• getLikeCount()

hasLiked

public boolean hasLiked(Person p)

Checks if a particular person has cast a vote for this image

Parameters:

p - the Person to check for

Returns:

TRUE if the person has voted, otherwise FALSE

See Also:

• Person

getLikes

public Collection<Integer> getLikes()

Returns all votes for this image.

Returns:

a Collection of votes for this image

See Also:

• addLike(int)

getLikeCount

public int getLikeCount()

Returns the number of Votes cast for this Image.

Returns:

the number of Votes

See Also:

• setLikeCount(int)