com.konakart.bl

Class ReviewMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.ReviewMgr

All Implemented Interfaces:

ReviewMgrIf

Direct Known Subclasses:

ReviewMgrEE

public class ReviewMgr
extends BaseMgr
implements ReviewMgrIf

Reviews Manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log Log
static int	PRODUCT_REVIEW Product review
static int	VENDOR_REVIEW Vendor review

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
ReviewMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	escapeReview(ReviewIf review) Escape the Strings in the Review object using the rules defined in the properties file by the property konakart.escape.chars .
Reviews	getAllReviews(DataDescriptorIf dataDesc) Calls the getReviewsPerProduct method with a negative productId value so that it is not included in the Where clause of the query
protected int	getCount(KKCriteria c) This method is mainly used for paging.
protected KKCriteria	getCriteria(int revType) Returns a KKCriteria object based on the review type
Review	getReview(int reviewId) Returns a review for the given reviewId
Reviews	getReviews(DataDescriptorIf dataDescIn, ReviewSearchIf searchIn) Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object.
protected Reviews	getReviews(DataDescriptorIf dataDescIn, ReviewSearchIf searchIn, int revType)
Reviews	getReviewsPerProduct(DataDescriptorIf dataDesc, int productId) Returns an array of reviews for the given productId
Reviews	getReviewsPerVendor(DataDescriptorIf dataDesc, int vendorId) Returns an array of reviews for the given vendorId
Review	getVendorReview(int reviewId) Returns a vendor review for the given reviewId
Reviews	getVendorReviews(DataDescriptorIf dataDescIn, ReviewSearchIf searchIn) Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object.
protected void	manageDataDescriptor(DataDescriptorIf dataDesc, KKCriteria c) Provides common code to deal with the management of the DataDescriptor
int	writeReview(java.lang.String sessionId, ReviewIf review) A new customer review is added to the system.

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

PRODUCT_REVIEW

public static final int PRODUCT_REVIEW

Product review

See Also:

Constant Field Values

VENDOR_REVIEW

public static final int VENDOR_REVIEW

Vendor review

See Also:

Constant Field Values

log

protected static org.apache.commons.logging.Log log

Log

Constructor Detail

ReviewMgr

public ReviewMgr(KKEngIf eng)
          throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getAllReviews

public Reviews getAllReviews(DataDescriptorIf dataDesc)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException,
                             com.konakart.app.KKException

Calls the getReviewsPerProduct method with a negative productId value so that it is not included in the Where clause of the query

Specified by:

getAllReviews in interface ReviewMgrIf

Parameters:

dataDesc - the dataDesc

Returns:

Returns all reviews

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getReview

public Review getReview(int reviewId)
                 throws org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException,
                        com.konakart.app.KKException

Returns a review for the given reviewId

Specified by:

getReview in interface ReviewMgrIf

Parameters:

reviewId - the reviewId

Returns:

Returns a Review object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getReviewsPerProduct

public Reviews getReviewsPerProduct(DataDescriptorIf dataDesc,
                                    int productId)
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException,
                                    com.konakart.app.KKException

Returns an array of reviews for the given productId

Specified by:

getReviewsPerProduct in interface ReviewMgrIf

Parameters:

dataDesc - the dataDesc

productId - the productId

Returns:

Returns a Reviews object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getReviews

public Reviews getReviews(DataDescriptorIf dataDescIn,
                          ReviewSearchIf searchIn)
                   throws org.apache.torque.TorqueException,
                          com.workingdogs.village.DataSetException,
                          com.konakart.app.KKException

Description copied from interface: ReviewMgrIf

Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object. It allows you to search for:

• A review for a given reviewId
• All reviews for a product identified by the productId
• All reviews written by a customer identified by the customerId
• All reviews matching, above or below a given rating

The ReviewSearch object also allows you to specify that the return data contains:

• The average rating for all reviews matching the search criteria.
• An array of name / number objects containing facet information for the number of reviews present for each rating. The name identifies the rating and the number identifies the number of reviews for that rating. No object is returned for a rating that has no reviews.

dataDesc controls the following functionality:

• The maximum number of Review objects returned.
• The offset which defaults to zero. This is useful when there are many Review objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only reviews with a matching custom attribute value are returned.
• The Reviews may be sorted by :
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING

Specified by:

getReviews in interface ReviewMgrIf

Parameters:

dataDescIn - the dataDescIn

searchIn - the searchIn

Returns:

Returns a Reviews object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getReviews

protected Reviews getReviews(DataDescriptorIf dataDescIn,
                             ReviewSearchIf searchIn,
                             int revType)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException,
                             com.konakart.app.KKException

Parameters:

dataDescIn - the dataDescIn

searchIn - the searchIn

revType - the revType

Returns:

Returns a Reviews object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

manageDataDescriptor

protected void manageDataDescriptor(DataDescriptorIf dataDesc,
                                    KKCriteria c)

Provides common code to deal with the management of the DataDescriptor

Parameters:

dataDesc - the dataDesc

c - the c

writeReview

public int writeReview(java.lang.String sessionId,
                       ReviewIf review)
                throws java.lang.Exception

A new customer review is added to the system. The process for adding a new review is to :

1. Get the customer's id from the session
2. Get the customer's name from the CustomerMgr
3. Write into the reviews table followed by the reviews description table in one transaction

All of the above actions are performed as a transaction. In the case of MySQL, the transaction doesn't work unless the tables are defined as using the InnoDB or BDB engines. A table can be transformed using the following syntax : Alter table t Engine = InnoDB;. The standard engine seems to be MyIsam which doesn't support transactions.

Specified by:

writeReview in interface ReviewMgrIf

Parameters:

sessionId - the sessionId

review - the review

Returns:

int : Review Primary Key or a negative value for an error

Throws:

java.lang.Exception - an unexpected exception

getCount

protected int getCount(KKCriteria c)
                throws org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

escapeReview

public void escapeReview(ReviewIf review)

Escape the Strings in the Review object using the rules defined in the properties file by the property konakart.escape.chars . This method may be overridden in a custom manager to add exceptions for attributes that don't need to be escaped or to disable the escaping completely.

Specified by:

escapeReview in interface ReviewMgrIf

Parameters:

review - the review

getCriteria

protected KKCriteria getCriteria(int revType)
                          throws com.konakart.app.KKException

Returns a KKCriteria object based on the review type

Parameters:

revType - the revType

Returns:

Returns a KKCriteria object based on the review type

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getVendorReviews

public Reviews getVendorReviews(DataDescriptorIf dataDescIn,
                                ReviewSearchIf searchIn)
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException,
                                com.konakart.app.KKException

Description copied from interface: ReviewMgrIf

Returns an array of Reviews (within a Reviews object) that match the specified search criteria in the ReviewSearch object. It allows you to search for:

• A review for a given reviewId
• All reviews for a vendor identified by the vendorId
• All reviews written by a customer identified by the customerId
• All reviews matching, above or below a given rating

The ReviewSearch object also allows you to specify that the return data contains:

• The average rating for all reviews matching the search criteria.
• An array of name / number objects containing facet information for the number of reviews present for each rating. The name identifies the rating and the number identifies the number of reviews for that rating. No object is returned for a rating that has no reviews.

dataDesc controls the following functionality:

• The maximum number of Review objects returned.
• The offset which defaults to zero. This is useful when there are many Review objects, in order to return them using multiple calls to this method.
• Criteria on the custom attributes. If a custom attribute is set then only reviews with a matching custom attribute value are returned.
• The Reviews may be sorted by :
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_RATING_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
  • com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING

Specified by:

getVendorReviews in interface ReviewMgrIf

Parameters:

dataDescIn - the dataDescIn

searchIn - the searchIn

Returns:

Returns a Reviews object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getVendorReview

public Review getVendorReview(int reviewId)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              com.konakart.app.KKException

Returns a vendor review for the given reviewId

Specified by:

getVendorReview in interface ReviewMgrIf

Parameters:

reviewId - the reviewId

Returns:

Returns a Review object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

getReviewsPerVendor

public Reviews getReviewsPerVendor(DataDescriptorIf dataDesc,
                                   int vendorId)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   com.konakart.app.KKException

Returns an array of reviews for the given vendorId

Specified by:

getReviewsPerVendor in interface ReviewMgrIf

Parameters:

dataDesc - the dataDesc

vendorId - the vendorId

Returns:

Returns a Reviews object

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception