edu.umich.eecs.tac.props
Class AdvertiserInfo

java.lang.Object
  edu.umich.eecs.tac.props.AbstractTransportable
      edu.umich.eecs.tac.props.AdvertiserInfo

All Implemented Interfaces:

java.io.Serializable, se.sics.isl.transport.Transportable

public class AdvertiserInfo
extends AbstractTransportable

AdvertiserInfo contains necessary game information unique to each individual advertiser. AdvertiserInfo contains:

• Manufacturer Specialty - The manufacturer specialization for the advertiser
• Component Specialty - The component specialization for the advertiser
• Manufacturer Specialist Bonus - The bonus given for a product containing the advertiser's manufacturer specialty
• Component Specialist Bonus - The bonus given for a product containing the advertiser's component specialty
• Distribution Capacity - The advertiser's daily distribution capacity threshold.
• Distribution Capacity Discounter - The discount given to the advertiser after exceeding the distribution capacity threshold.
• Publisher Id - The address id of the publisher agent.
• Advertiser Id - The address id for the given advertiser.
• Distribution Window - The Distribution Window is used in calculating whether a given advertiser has exceeded their Distribution Capacity Threshold over the window of days.
• Target Effect - The targeting effect of a correctly targeted ad.
• Focus Effects - The focus effects for the 3 different user states f0, f1, and f2.

AdvertiserInfo is typically sent at the beginning of every game.

Author:

Patrick Jordan, Lee Callender

See Also:

TAC Documentation, Serialized Form

Constructor Summary

AdvertiserInfo()
Creates a new advertiser information object.

Method Summary

boolean	equals(java.lang.Object o) Checks to see if the parameter configuration is the same.
java.lang.String	getAdvertiserId() Returns the advertiser address.
double	getComponentBonus() Returns the component bonus.
java.lang.String	getComponentSpecialty() Returns the component specialty.
int	getDistributionCapacity() Returns the distribution capacity.
double	getDistributionCapacityDiscounter() Returns the decay rate.
int	getDistributionWindow() Returns the distribution window.
double	getFocusEffects(QueryType queryType) Returns the focus effect for the given query type.
double	getManufacturerBonus() Returns the manufacturer bonus.
java.lang.String	getManufacturerSpecialty() Returns the manufacturer specialty.
java.lang.String	getPublisherId() Returns the publisher address.
double	getTargetEffect() Returns the target effect.
int	hashCode() Returns the hash code from the configuration parameters.
protected void	readWithLock(se.sics.isl.transport.TransportReader reader) Reads the advertiser information parameters from the reader.
void	setAdvertiserId(java.lang.String advertiserId) Sets the advertiser address.
void	setComponentBonus(double componentBonus) Sets the component bonus.
void	setComponentSpecialty(java.lang.String componentSpecialty) Sets the component specialty.
void	setDistributionCapacity(int distributionCapacity) Sets the distribution capacity.
void	setDistributionCapacityDiscounter(double distributionCapacityDiscounter) Sets the decay rate.
void	setDistributionWindow(int distributionWindow) Sets the distribution window.
void	setFocusEffects(QueryType queryType, double focusEffect) Sets the focus effect for the given query type.
void	setManufacturerBonus(double manufacturerBonus) Sets the manufacturer bonus.
void	setManufacturerSpecialty(java.lang.String manufacturerSpecialty) Sets the manufacturer specialty.
void	setPublisherId(java.lang.String publisherId) Sets the publisher address.
void	setTargetEffect(double targetEffect) Sets the target effect.
protected void	writeWithLock(se.sics.isl.transport.TransportWriter writer) Writes the advertiser information parameters to the writer.

Methods inherited from class edu.umich.eecs.tac.props.AbstractTransportable

getTransportName, isLocked, lock, lockCheck, read, write

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvertiserInfo

public AdvertiserInfo()

Creates a new advertiser information object.

Method Detail

getFocusEffects

public final double getFocusEffects(QueryType queryType)

Returns the focus effect for the given query type.

Parameters:

queryType - the query type.

Returns:

the focus effect for the given query type.

See Also:

TAC Documentation

setFocusEffects

public final void setFocusEffects(QueryType queryType,
                                  double focusEffect)

Sets the focus effect for the given query type.

Parameters:

queryType - queryType the query type.

focusEffect - the focus effect.

See Also:

TAC Documentation

getTargetEffect

public final double getTargetEffect()

Returns the target effect.

Returns:

the target effect.

See Also:

TAC Documentation

setTargetEffect

public final void setTargetEffect(double targetEffect)

Sets the target effect.

Parameters:

targetEffect - the target effect.

See Also:

TAC Documentation

getDistributionWindow

public final int getDistributionWindow()

Returns the distribution window.

Returns:

the distribution window.

See Also:

TAC Documentation

setDistributionWindow

public final void setDistributionWindow(int distributionWindow)

Sets the distribution window.

Parameters:

distributionWindow - the distribution window.

See Also:

TAC Documentation

getAdvertiserId

public final java.lang.String getAdvertiserId()

Returns the advertiser address.

Returns:

the advertiser address.

setAdvertiserId

public final void setAdvertiserId(java.lang.String advertiserId)

Sets the advertiser address.

Parameters:

advertiserId - the advertiser address.

getManufacturerSpecialty

public final java.lang.String getManufacturerSpecialty()

Returns the manufacturer specialty.

Returns:

the manufacturer specialty.

See Also:

TAC Documentation

setManufacturerSpecialty

public final void setManufacturerSpecialty(java.lang.String manufacturerSpecialty)

Sets the manufacturer specialty.

Parameters:

manufacturerSpecialty - the manufacturer specialty.

See Also:

TAC Documentation

getComponentSpecialty

public final java.lang.String getComponentSpecialty()

Returns the component specialty.

Returns:

the component specialty.

See Also:

TAC Documentation

setComponentSpecialty

public final void setComponentSpecialty(java.lang.String componentSpecialty)

Sets the component specialty.

Parameters:

componentSpecialty - the component specialty.

See Also:

TAC Documentation

getManufacturerBonus

public final double getManufacturerBonus()

Returns the manufacturer bonus.

Returns:

the manufacturer bonus.

See Also:

TAC Documentation

setManufacturerBonus

public final void setManufacturerBonus(double manufacturerBonus)

Sets the manufacturer bonus.

Parameters:

manufacturerBonus - the manufacturer bonus.

See Also:

TAC Documentation

getComponentBonus

public final double getComponentBonus()

Returns the component bonus.

Returns:

the component bonus.

See Also:

TAC Documentation

setComponentBonus

public final void setComponentBonus(double componentBonus)

Sets the component bonus.

Parameters:

componentBonus - the component bonus.

See Also:

TAC Documentation

getPublisherId

public final java.lang.String getPublisherId()

Returns the publisher address.

Returns:

the publisher address.

setPublisherId

public final void setPublisherId(java.lang.String publisherId)

Sets the publisher address.

Parameters:

publisherId - the publisher address.

getDistributionCapacity

public final int getDistributionCapacity()

Returns the distribution capacity.

Returns:

the distribution capacity.

See Also:

TAC Documentation

setDistributionCapacity

public final void setDistributionCapacity(int distributionCapacity)

Sets the distribution capacity.

Parameters:

distributionCapacity - the distribution capacity.

See Also:

TAC Documentation

getDistributionCapacityDiscounter

public final double getDistributionCapacityDiscounter()

Returns the decay rate.

Returns:

the decay rate.

See Also:

TAC Documentation

setDistributionCapacityDiscounter

public final void setDistributionCapacityDiscounter(double distributionCapacityDiscounter)

Sets the decay rate.

Parameters:

distributionCapacityDiscounter - the decay rate.

See Also:

TAC Documentation

readWithLock

protected final void readWithLock(se.sics.isl.transport.TransportReader reader)
                           throws java.text.ParseException

Reads the advertiser information parameters from the reader.

Specified by:

readWithLock in class AbstractTransportable

Parameters:

reader - the reader to read data from.

Throws:

java.text.ParseException - if an exception occurs when reading the parameters.

writeWithLock

protected final void writeWithLock(se.sics.isl.transport.TransportWriter writer)

Writes the advertiser information parameters to the writer.

Specified by:

writeWithLock in class AbstractTransportable

Parameters:

writer - the writer to write data to.

equals

public final boolean equals(java.lang.Object o)

Checks to see if the parameter configuration is the same.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to check equality

Returns:

whether the object has the same parameter configuration.

hashCode

public final int hashCode()

Returns the hash code from the configuration parameters.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code from the configuration parameters.