com.buckosoft.PicMan.domain

Class ContactParams

java.lang.Object

com.buckosoft.PicMan.domain.ContactParams

Direct Known Subclasses:

PosterParams

public class ContactParams
extends java.lang.Object

Define the rules to make one contact sheet.

Since:

2005/08/07

Author:

Dick Balaska

See Also:

ContactParams.java

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
ContactParams()
ContactParams(int cid, java.lang.String setName, int size, int item)
ContactParams(SetSize setSize)

Method Summary

Modifier and Type	Method and Description
boolean	equals(ContactParams other) Compare two ContactParams for equality. Compare chain, setName, size, and contactNumber. either size = -1 is a wildcard and will match (contactNumber is ignored in this case). either contactNumber = -1 is a wildcard and will match.
boolean	equalsPics(ContactParams other) Compare two ContactParams for equality. Compare setName, size, min/max. Basically, we are checking if these two ContactParams will select the same set of Pics.
int	getCid()
int	getContactNumber()
java.lang.String	getEngineName() Get the name of the engine that is to build these contacts
java.lang.String	getOutputDirectory()
int	getRankMax()
int	getRankMin()
java.lang.String	getSetName()
int	getSize() Get the thumbnail size we should draw in
java.lang.String	getUid() Return a String which is the Uuid of a set/size combo.
java.lang.String	getUuid() Return a String which is the Uuid of a set/size/item combo
void	setCid(int cid)
void	setContactNumber(int contactNumber)
void	setEngineName(java.lang.String engineName) Set the name of the engine that is to build these contacts
void	setOutputDirectory(java.lang.String outputDirectory)
void	setRankMax(int rankMax)
void	setRankMin(int rankMin)
void	setRankMinMax(int min, int max) Convienence method to set the min and max ratings in one call.
void	setSetName(java.lang.String setName)
void	setSetSize(SetSize setSize)
void	setSize(int size) Set the thumbnail size we should draw in

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

ContactParams

public ContactParams()

ContactParams

public ContactParams(int cid,
                     java.lang.String setName,
                     int size,
                     int item)

ContactParams

public ContactParams(SetSize setSize)

Method Detail

equals

public boolean equals(ContactParams other)

Compare two ContactParams for equality.
Compare chain, setName, size, and contactNumber.
either size = -1 is a wildcard and will match (contactNumber is ignored in this case).
either contactNumber = -1 is a wildcard and will match.

Parameters:

other - The other ContactParams to compare to.

Returns:

equality

equalsPics

public boolean equalsPics(ContactParams other)

Compare two ContactParams for equality.
Compare setName, size, min/max.
Basically, we are checking if these two ContactParams will select the same set of Pics.

Parameters:

other - The other ContactParams to compare to.

Returns:

equality

getCid

public int getCid()

Returns:

Returns the cid.

setCid

public void setCid(int cid)

Parameters:

cid - The cid to set.

setSetSize

public void setSetSize(SetSize setSize)

getSetName

public java.lang.String getSetName()

setSetName

public void setSetName(java.lang.String setName)

getSize

public int getSize()

Get the thumbnail size we should draw in

Returns:

most likely 75,100,150,200 or 300

setSize

public void setSize(int size)

Set the thumbnail size we should draw in

Parameters:

size - most likely 75,100,150,200 or 300

getOutputDirectory

public java.lang.String getOutputDirectory()

setOutputDirectory

public void setOutputDirectory(java.lang.String outputDirectory)

getContactNumber

public int getContactNumber()

setContactNumber

public void setContactNumber(int contactNumber)

getUuid

public java.lang.String getUuid()

Return a String which is the Uuid of a set/size/item combo

Returns:

Something that looks like: mlb-075-001

getUid

public java.lang.String getUid()

Return a String which is the Uuid of a set/size combo. Not so much a Uuid, per se. because the item is unknown, so we call it a uid.

getRankMax

public int getRankMax()

Returns:

Returns the rankMax.

setRankMax

public void setRankMax(int rankMax)

Parameters:

rankMax - The rankMax to set.

getRankMin

public int getRankMin()

Returns:

Returns the rankMin.

setRankMin

public void setRankMin(int rankMin)

Parameters:

rankMin - The rankMin to set.

setRankMinMax

public void setRankMinMax(int min,
                          int max)

Convienence method to set the min and max ratings in one call.

Parameters:

min -

max -

getEngineName

public java.lang.String getEngineName()

Get the name of the engine that is to build these contacts

Returns:

the engineName

setEngineName

public void setEngineName(java.lang.String engineName)

Set the name of the engine that is to build these contacts

Parameters:

engineName - the engineName to set