com.ibm.commerce.search.rulequery
Class RuleQuery

java.lang.Object
  |
  +--com.ibm.commerce.search.rulequery.RuleQuery

public class RuleQuery
extends java.lang.Object

Search interface that is used to construct queries to search a catalog. The query will return catentry ids that match search criteria. This class provides a set of methods where each method can used to construct a predicate (search criteria specified in WHERE clause of an SQL). The search interface expects the predicates to be in post-fix format. For example post fix equaivalent of A and B and C or D or E is ABC and D or E or where A,B,C,D and E are individual predicates. Note the post-fix format is not strictly binary i.e. there can be more than two operands related to an operator. Due to this flexibility there are some restrictions on how to arrange the predicates and it is the responsibility of the user to arrange the predicates in correct order.


Field Summary
protected  TradingAgreementAccessBean[] agreements
           
static int AND_Operator
           
static int ANY_QueryType
           
static int ASC_Operator
           
static int ATTRIBUTE_ATTRIBUTE_ID_Attr
           
static int ATTRIBUTE_CATENTRY_ID_Attr
           
static int ATTRIBUTE_LANGUAGE_ID_Attr
           
static int ATTRIBUTE_NAME_Attr
           
static int ATTRVALUE_ATTRIBUTE_ID_Attr
           
static int ATTRVALUE_CATENTRY_ID_Attr
           
static int ATTRVALUE_FLOATVALUE_Attr
           
static int ATTRVALUE_INTEGERVALUE_Attr
           
static int ATTRVALUE_LANGUAGE_ID_Attr
           
static int ATTRVALUE_NAME_Attr
           
static int ATTRVALUE_STRINGVALUE_Attr
           
static int AVG_Operator
           
static int BOTH_QueryType
           
static int BUNDLE_CatEntryType
           
static int CATENTDESC_AVAILABILITY_DATE_Attr
           
static int CATENTDESC_CATENTRY_ID_Attr
           
static int CATENTDESC_KEYWORD_Attr
           
static int CATENTDESC_LANGUAGE_ID_Attr
           
static int CATENTDESC_LONGDESCRIPTION_Attr
           
static int CATENTDESC_NAME_Attr
           
static int CATENTDESC_PARTNUMBER_Attr
           
static int CATENTDESC_PUBLISHED_Attr
           
static int CATENTDESC_SHORT_DESC_Attr
           
static int CATENTDESC_SHORTDESCRIPTION_Attr
           
static int CATENTDESC_THUMBNAIL_Attr
           
static int CATENTREL_CATENTRY_ID_CHILD_Attr
           
static int CATENTREL_CATENTRY_ID_PARENT_Attr
           
static int CATENTREL_CATREL_TYPE_ID_Attr
           
static int CATENTRY_BUYABLE_Attr
           
static int CATENTRY_CATENTRY_ID_Attr
           
static int CATENTRY_ID_Attr
           
static int CATENTRY_MARKFORDELETE_Attr
           
static int CATENTRY_MFNAME_Attr
           
static int CATENTRY_MFPARTNUMBER_Attr
           
static int CATENTRY_ONAUCTION_Attr
           
static int CATENTRY_ONSPECIAL_Attr
           
static int CATENTRY_PARTNUMBER_Attr
           
static int CATENTRY_SKU_Attr
           
static int CATENTRY_SKU_QueryType
           
static int CATGPENREL_CATALOG_ID_Attr
           
static int CATGPENREL_CATENTRY_ID_Attr
           
static int CATGPENREL_CATGROUP_ID_Attr
           
static int CATGROUP_CATGROUP_ID_Attr
           
static int CATGRPDESC_LANGUAGE_ID_Attr
           
static int CATGRPDESC_LONGDESCRIPTION_Attr
           
static int CATGRPDESC_NAME_Attr
           
static int CATGRPDESC_SHORTDESCRIPTION_Attr
           
static java.lang.String COPYRIGHT
           
static int COUNT_Operator
           
 boolean defaultResultSelection
           
static int DESC_Operator
           
static int EQ_Operator
           
protected  com.ibm.commerce.search.rulequery.Predicate filterSet
           
protected  java.util.Vector filterSetTmp
           
static int GE_Operator
           
static int GENERIC_QueryType
           
protected  com.ibm.commerce.search.rulequery.Predicate globalPredicate
           
static int GROUP_BY_Operator
           
static int GT_Operator
           
static int IN_Operator
           
static int INVSTVW_QUANTITY_AVAILABLE_Attr
           
static int INVSTVW_QUANTITY_MEASURE_Attr
           
static int IS_NOT_NULL_Operator
           
static int IS_NULL_Operator
           
static int ITEM_CatEntryType
           
static int ITEM_QueryType
           
static int LE_Operator
           
static int LEFT_LIKE_Operator
           
static int LIKE_Operator
           
static int LISTPRICE_Attr
           
static int LISTPRICE_CATENTRY_ID_Attr
           
static int LISTPRICE_CURRENCY_Attr
           
static int LISTPRICE_LISTPRICE_Attr
           
static int LT_Operator
           
static int MAX_Operator
           
protected  com.ibm.commerce.search.rulequery.Query mcQuery
           
static int MIN_Operator
           
static int NE_Operator
           
static int NOT_GT_Operator
           
static int NOT_IN_Operator
           
static int NOT_LEFT_LIKE_Operator
           
static int NOT_LIKE_Operator
           
static int NOT_LT_Operator
           
static int NOT_RIGHT_LIKE_Operator
           
static int OFFER_MAXIMUMQUANTITY_Attr
           
static int OFFER_MINIMUMQUANTITY_Attr
           
static int OFFER_OFFER_ID_Attr
           
static int OFFER_TRADEPOSCN_ID_Attr
           
static int OFFERPRICE_CURRENCY_Attr
           
static int OFFERPRICE_OFFER_ID_Attr
           
static int OFFERPRICE_PRICE_Attr
           
static int OR_Operator
           
static int ORDER_BY_Operator
           
static int PACKAGE_CatEntryType
           
static int PRODUCT_CatEntryType
           
protected  java.util.Vector productSetInList
           
protected  java.util.Vector productSetOutList
           
static int PRSETCEREL_CATENTRY_ID_Attr
           
static int PRSETCEREL_PRODUCTSET_ID_Attr
           
protected  java.lang.String queryString
           
static int RIGHT_LIKE_Operator
           
protected  com.ibm.commerce.search.rulequery.Predicate selectSet
           
protected  java.util.Vector selectSetTmp
           
static int STDPRICEVW_CATENTRY_ID_Attr
           
static int STDPRICEVW_CURRENCY_Attr
           
static int STDPRICEVW_PRICE_Attr
           
static int STORECATENTRY_STORE_ID_Attr
           
static int STOREINVENTORY_QUANTITY_Attr
           
static int STOREINVENTORY_QUANTITY_MEASURE_Attr
           
static int SUM_Operator
           
static int TRADEPOSCN_TRADEPOSCN_ID_Attr
           
static int TRADEPOSCN_TYPE_ID_Attr
           
static int UPPER_Function
           
static int USER_ID_Attr
           
 
Constructor Summary
RuleQuery()
          RuleQuery constructor with no arguments.
RuleQuery(int inStoreID, int inUserID)
          Rule query constructor with store and user id as arguments.
RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, java.lang.Long userId)
          RuleQuery constructor with store id, Trading agreement access bean and user id as arguments.
RuleQuery(com.ibm.commerce.search.rulequery.Query q)
          RuleQuery constructor with Query as argument.
RuleQuery(TradingAgreementAccessBean[] agreements, java.lang.Long userId)
          RuleQuery constructor with Trading Agreement Access bean and user id as arguments.
RuleQuery(java.util.Vector inStoreIDs, int inUserID)
          Rule query constructor with multiple store id and single user id as arguments.
RuleQuery(java.util.Vector inStoreIDs, TradingAgreementAccessBean[] agreements, java.lang.Long userId)
          RuleQuery constructor with multiple store id, Trading agreement access bean and user id as arguments.
 
Method Summary
protected  com.ibm.commerce.search.rulequery.Attribute addAttributeFunction(com.ibm.commerce.search.rulequery.Attribute attr, int function)
          Adds function to a table column.
 void addFilterAttribute(int attribute, int operator)
          Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN IS NOT NULL.
 void addFilterAttribute(int attribute, int operator, int function)
          Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) IS NULL.
 void addFilterAttribute(int attribute, int operator, java.lang.String value)
          Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN LIKE '%VALUE%'.
 void addFilterAttribute(int attribute, int operator, java.lang.String value, int function)
          Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'.
 void addFilterOperand(com.ibm.commerce.search.rulequery.Attribute attr)
          Adds a WHERE clause predicate into temporary filter predicate collection.
 void addFilterOperand(com.ibm.commerce.search.rulequery.Predicate predicate)
          Adds a collection of WHERE clause predicates into temporary filter predicate collection.
 void addFilterOperator(int operator)
          Adds an operator that combines a set of filter predicates.
protected  com.ibm.commerce.search.rulequery.Operator addFilterOperatorType(int operType)
          Maps constants that represent an filter operator to actual operator.
 void addGlobalPredicate()
          Method to insert a predicate that will be applied to entire query like BUYABLE/PUBLISHABLE/LANGUAGE_ID.
 void addGroupByAttribute(int attribute)
          To set group by operator Creation date: (6/20/2001 1:53:37 PM)
protected  com.ibm.commerce.search.rulequery.Operator addOperatorType(int operType)
          Maps constants that represent an operator to actual operator.
 void addOrderByAttribute(int attribute, int operator)
          To set order by operator Creation date: (6/20/2001 1:53:37 PM)
 void addResultOperator(int operator)
          To add result set with operators like max, min, count.
 void addRule()
          Adds an set of predicates to a Query.
 void addRule(int aQueryType)
          Adds a set of predicate to Query.
 void addSelectAttribute(int attribute, int operator)
          Adds a predicate to query Where clause, example, TABLE.COLUMN IS NOT NULL.
 void addSelectAttribute(int attribute, int operator, int function)
          Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) IS NULL.
 void addSelectAttribute(int attribute, int operator, java.lang.String value)
          Adds a predicate to query Where clause, example, TABLE.COLUMN LIKE '%VALUE%'.
 void addSelectAttribute(int attribute, int operator, java.lang.String value, int function)
          Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'.
 void addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, int attrValueType, java.lang.String languageId, java.lang.String prodType)
          Adds a Rich attribute predicate.
 void addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, int attrValueType, java.lang.String languageId, java.lang.String prodType, int function)
          Adds a Rich attribute predicate.
 void addSelectOperand(com.ibm.commerce.search.rulequery.Attribute attr)
          Adds a WHERE clause predicate into temporary select set predicate collection.
 void addSelectOperand(com.ibm.commerce.search.rulequery.Predicate predicate)
          Adds a collection of WHERE clause predicates into temporary select set predicate collection.
 void addSelectOperator(int operator)
          Adds an operator that combines a set of filter predicates.
protected  com.ibm.commerce.search.rulequery.Predicate buildPredicate()
          Assembles the complete WHERE clause.
protected  java.lang.String evaluateSelectivity(com.ibm.commerce.search.catalog.SmartQuery query)
          Evaluates a sub query in WHERE clause.
 java.util.Vector execute()
          Executes catalog search query and retrieves all the catentry ids that satisfy the query.
 java.util.Vector execute(com.ibm.commerce.search.rulequery.Cursor aCursor)
          Executes catalog search query and retrieves a set of catentry id between a start value and end value specified in the cursor object.
protected  boolean findAttribute(com.ibm.commerce.search.rulequery.Predicate p, java.lang.String s)
          This method can be used to find a particular column s in Predicate p.
protected  java.lang.String findAttributeInfoName(int attrId)
          Maps a static integer constant that defines a column name to the singleton class name that describes the column name, its data type, and the table it belong to.
 java.lang.Integer getCatgrpSchemaType()
          Do not modify.
protected  com.ibm.commerce.search.rulequery.Predicate getEntitlementPredicate()
          Constructs the entitlement predicate.
protected  com.ibm.commerce.search.base.Predicate getGlobalPredicate()
          Do not modify.
protected  com.ibm.commerce.search.catalog.AttributeInfo getInstanceOfAttrInfoByClassName(java.lang.String classname)
          Given a class name in com.ibm.commerce.search.catalog package, gets the instance of the class.
 java.lang.Long getLongUserId()
          Do not modify.
 com.ibm.commerce.search.base.Query getMcQuery()
          Do not modify.
 com.ibm.commerce.search.rulequery.Predicate getPredicate()
          Do not modify.
 int getQueryType()
          Do not modify.
 java.lang.Integer getRASchemaType()
          Do not modify.
 java.util.Vector getResultSet()
          Do not modify.
 int getSelectivitySize()
          Do not modify.
 java.util.Vector getSourceTables()
          Do not modify.
 int getStoreID()
          Do not modify.
 java.util.Vector getStoreIDs()
          Do not modify.
 java.lang.Integer getUserID()
          Do not modify.
 boolean isPriceSummary()
          Returns if there is summary table for price or not true if there is summary table false otherwise
 void reset()
          Re-initialize filterSet and selectSet variables Creation date: (10/30/00 5:52:47 AM)
 void setAgreements(TradingAgreementAccessBean[] newAgreements)
          Do not modify.
 void setCatgrpSchemaType(java.lang.Integer newCatgrpSchemaType)
          Do not modify.
 void setDefaultResultSelection()
          To set default result selection variable.
 void setDistinct()
          To set disctict operator Creation date: (6/20/2001 9:33:19 AM)
 void setDistinct(boolean distinctFlag)
          To set disctict operator.
protected  void setGlobalPredicate(com.ibm.commerce.search.rulequery.Predicate globalPredicate)
          Set the globalPredicate variable Creation date: (8/23/2001 4:00:11 PM)
 void setLongUserId(java.lang.Long newLongUserId)
          Do not modify.
 void setRASchemaType(java.lang.Integer newRASchemaType)
          Do not modify.
 void setSelectivitySize(int newSelectivitySize)
          Set selectivity size Creation date: (8/25/2001 7:02:13 PM)
 void setStoreID(int newStoreID)
          Set store id.
 void setStoreIDs(java.util.Vector newStoreIDs)
          Set collection of store ids Creation date: (7/20/2001 2:25:32 PM)
 void setUserID(int newUserID)
          Set user id Creation date: (6/25/2001 2:41:44 PM)
 java.lang.String toString()
          Returns query string Creation date: (11/16/00 3:58:11 PM)
protected  com.ibm.commerce.search.rulequery.Predicate translatePredicate(int key, com.ibm.commerce.search.rulequery.Predicate p)
          This method does predicate translation based on the key passed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

agreements

protected TradingAgreementAccessBean[] agreements

AND_Operator

public static final int AND_Operator

ANY_QueryType

public static final int ANY_QueryType

ASC_Operator

public static final int ASC_Operator

ATTRIBUTE_ATTRIBUTE_ID_Attr

public static final int ATTRIBUTE_ATTRIBUTE_ID_Attr

ATTRIBUTE_CATENTRY_ID_Attr

public static final int ATTRIBUTE_CATENTRY_ID_Attr

ATTRIBUTE_LANGUAGE_ID_Attr

public static final int ATTRIBUTE_LANGUAGE_ID_Attr

ATTRIBUTE_NAME_Attr

public static final int ATTRIBUTE_NAME_Attr

ATTRVALUE_ATTRIBUTE_ID_Attr

public static final int ATTRVALUE_ATTRIBUTE_ID_Attr

ATTRVALUE_CATENTRY_ID_Attr

public static final int ATTRVALUE_CATENTRY_ID_Attr

ATTRVALUE_FLOATVALUE_Attr

public static final int ATTRVALUE_FLOATVALUE_Attr

ATTRVALUE_INTEGERVALUE_Attr

public static final int ATTRVALUE_INTEGERVALUE_Attr

ATTRVALUE_LANGUAGE_ID_Attr

public static final int ATTRVALUE_LANGUAGE_ID_Attr

ATTRVALUE_NAME_Attr

public static final int ATTRVALUE_NAME_Attr

ATTRVALUE_STRINGVALUE_Attr

public static final int ATTRVALUE_STRINGVALUE_Attr

AVG_Operator

public static final int AVG_Operator

BOTH_QueryType

public static final int BOTH_QueryType

BUNDLE_CatEntryType

public static final int BUNDLE_CatEntryType

CATENTDESC_AVAILABILITY_DATE_Attr

public static final int CATENTDESC_AVAILABILITY_DATE_Attr

CATENTDESC_CATENTRY_ID_Attr

public static final int CATENTDESC_CATENTRY_ID_Attr

CATENTDESC_KEYWORD_Attr

public static final int CATENTDESC_KEYWORD_Attr

CATENTDESC_LANGUAGE_ID_Attr

public static final int CATENTDESC_LANGUAGE_ID_Attr

CATENTDESC_LONGDESCRIPTION_Attr

public static final int CATENTDESC_LONGDESCRIPTION_Attr

CATENTDESC_NAME_Attr

public static final int CATENTDESC_NAME_Attr

CATENTDESC_PARTNUMBER_Attr

public static final int CATENTDESC_PARTNUMBER_Attr

CATENTDESC_PUBLISHED_Attr

public static final int CATENTDESC_PUBLISHED_Attr

CATENTDESC_SHORT_DESC_Attr

public static final int CATENTDESC_SHORT_DESC_Attr

CATENTDESC_SHORTDESCRIPTION_Attr

public static final int CATENTDESC_SHORTDESCRIPTION_Attr

CATENTDESC_THUMBNAIL_Attr

public static final int CATENTDESC_THUMBNAIL_Attr

CATENTREL_CATENTRY_ID_CHILD_Attr

public static final int CATENTREL_CATENTRY_ID_CHILD_Attr

CATENTREL_CATENTRY_ID_PARENT_Attr

public static final int CATENTREL_CATENTRY_ID_PARENT_Attr

CATENTREL_CATREL_TYPE_ID_Attr

public static final int CATENTREL_CATREL_TYPE_ID_Attr

CATENTRY_BUYABLE_Attr

public static final int CATENTRY_BUYABLE_Attr

CATENTRY_CATENTRY_ID_Attr

public static final int CATENTRY_CATENTRY_ID_Attr

CATENTRY_ID_Attr

public static final int CATENTRY_ID_Attr

CATENTRY_MARKFORDELETE_Attr

public static final int CATENTRY_MARKFORDELETE_Attr

CATENTRY_MFNAME_Attr

public static final int CATENTRY_MFNAME_Attr

CATENTRY_MFPARTNUMBER_Attr

public static final int CATENTRY_MFPARTNUMBER_Attr

CATENTRY_ONAUCTION_Attr

public static final int CATENTRY_ONAUCTION_Attr

CATENTRY_ONSPECIAL_Attr

public static final int CATENTRY_ONSPECIAL_Attr

CATENTRY_PARTNUMBER_Attr

public static final int CATENTRY_PARTNUMBER_Attr

CATENTRY_SKU_Attr

public static final int CATENTRY_SKU_Attr

CATENTRY_SKU_QueryType

public static final int CATENTRY_SKU_QueryType

CATGPENREL_CATALOG_ID_Attr

public static final int CATGPENREL_CATALOG_ID_Attr

CATGPENREL_CATENTRY_ID_Attr

public static final int CATGPENREL_CATENTRY_ID_Attr

CATGPENREL_CATGROUP_ID_Attr

public static final int CATGPENREL_CATGROUP_ID_Attr

CATGROUP_CATGROUP_ID_Attr

public static final int CATGROUP_CATGROUP_ID_Attr

CATGRPDESC_LANGUAGE_ID_Attr

public static final int CATGRPDESC_LANGUAGE_ID_Attr

CATGRPDESC_LONGDESCRIPTION_Attr

public static final int CATGRPDESC_LONGDESCRIPTION_Attr

CATGRPDESC_NAME_Attr

public static final int CATGRPDESC_NAME_Attr

CATGRPDESC_SHORTDESCRIPTION_Attr

public static final int CATGRPDESC_SHORTDESCRIPTION_Attr

COPYRIGHT

public static final java.lang.String COPYRIGHT

COUNT_Operator

public static final int COUNT_Operator

defaultResultSelection

public boolean defaultResultSelection

DESC_Operator

public static final int DESC_Operator

EQ_Operator

public static final int EQ_Operator

filterSet

protected com.ibm.commerce.search.rulequery.Predicate filterSet

filterSetTmp

protected java.util.Vector filterSetTmp

GE_Operator

public static final int GE_Operator

GENERIC_QueryType

public static final int GENERIC_QueryType

globalPredicate

protected com.ibm.commerce.search.rulequery.Predicate globalPredicate

GROUP_BY_Operator

public static final int GROUP_BY_Operator

GT_Operator

public static final int GT_Operator

IN_Operator

public static final int IN_Operator

INVSTVW_QUANTITY_AVAILABLE_Attr

public static final int INVSTVW_QUANTITY_AVAILABLE_Attr

INVSTVW_QUANTITY_MEASURE_Attr

public static final int INVSTVW_QUANTITY_MEASURE_Attr

IS_NOT_NULL_Operator

public static final int IS_NOT_NULL_Operator

IS_NULL_Operator

public static final int IS_NULL_Operator

ITEM_CatEntryType

public static final int ITEM_CatEntryType

ITEM_QueryType

public static final int ITEM_QueryType

LE_Operator

public static final int LE_Operator

LEFT_LIKE_Operator

public static final int LEFT_LIKE_Operator

LIKE_Operator

public static final int LIKE_Operator

LISTPRICE_Attr

public static final int LISTPRICE_Attr

LISTPRICE_CATENTRY_ID_Attr

public static final int LISTPRICE_CATENTRY_ID_Attr

LISTPRICE_CURRENCY_Attr

public static final int LISTPRICE_CURRENCY_Attr

LISTPRICE_LISTPRICE_Attr

public static final int LISTPRICE_LISTPRICE_Attr

LT_Operator

public static final int LT_Operator

MAX_Operator

public static final int MAX_Operator

mcQuery

protected com.ibm.commerce.search.rulequery.Query mcQuery

MIN_Operator

public static final int MIN_Operator

NE_Operator

public static final int NE_Operator

NOT_GT_Operator

public static final int NOT_GT_Operator

NOT_IN_Operator

public static final int NOT_IN_Operator

NOT_LEFT_LIKE_Operator

public static final int NOT_LEFT_LIKE_Operator

NOT_LIKE_Operator

public static final int NOT_LIKE_Operator

NOT_LT_Operator

public static final int NOT_LT_Operator

NOT_RIGHT_LIKE_Operator

public static final int NOT_RIGHT_LIKE_Operator

OFFER_MAXIMUMQUANTITY_Attr

public static final int OFFER_MAXIMUMQUANTITY_Attr

OFFER_MINIMUMQUANTITY_Attr

public static final int OFFER_MINIMUMQUANTITY_Attr

OFFER_OFFER_ID_Attr

public static final int OFFER_OFFER_ID_Attr

OFFER_TRADEPOSCN_ID_Attr

public static final int OFFER_TRADEPOSCN_ID_Attr

OFFERPRICE_CURRENCY_Attr

public static final int OFFERPRICE_CURRENCY_Attr

OFFERPRICE_OFFER_ID_Attr

public static final int OFFERPRICE_OFFER_ID_Attr

OFFERPRICE_PRICE_Attr

public static final int OFFERPRICE_PRICE_Attr

OR_Operator

public static final int OR_Operator

ORDER_BY_Operator

public static final int ORDER_BY_Operator

PACKAGE_CatEntryType

public static final int PACKAGE_CatEntryType

PRODUCT_CatEntryType

public static final int PRODUCT_CatEntryType

productSetInList

protected java.util.Vector productSetInList

productSetOutList

protected java.util.Vector productSetOutList

PRSETCEREL_CATENTRY_ID_Attr

public static final int PRSETCEREL_CATENTRY_ID_Attr

PRSETCEREL_PRODUCTSET_ID_Attr

public static final int PRSETCEREL_PRODUCTSET_ID_Attr

queryString

protected java.lang.String queryString

RIGHT_LIKE_Operator

public static final int RIGHT_LIKE_Operator

selectSet

protected com.ibm.commerce.search.rulequery.Predicate selectSet

selectSetTmp

protected java.util.Vector selectSetTmp

STDPRICEVW_CATENTRY_ID_Attr

public static final int STDPRICEVW_CATENTRY_ID_Attr

STDPRICEVW_CURRENCY_Attr

public static final int STDPRICEVW_CURRENCY_Attr

STDPRICEVW_PRICE_Attr

public static final int STDPRICEVW_PRICE_Attr

STORECATENTRY_STORE_ID_Attr

public static final int STORECATENTRY_STORE_ID_Attr

STOREINVENTORY_QUANTITY_Attr

public static final int STOREINVENTORY_QUANTITY_Attr

STOREINVENTORY_QUANTITY_MEASURE_Attr

public static final int STOREINVENTORY_QUANTITY_MEASURE_Attr

SUM_Operator

public static final int SUM_Operator

TRADEPOSCN_TRADEPOSCN_ID_Attr

public static final int TRADEPOSCN_TRADEPOSCN_ID_Attr

TRADEPOSCN_TYPE_ID_Attr

public static final int TRADEPOSCN_TYPE_ID_Attr

UPPER_Function

public static final int UPPER_Function

USER_ID_Attr

public static final int USER_ID_Attr
Constructor Detail

RuleQuery

public RuleQuery()
RuleQuery constructor with no arguments.

RuleQuery

public RuleQuery(int inStoreID,
                 int inUserID)
Rule query constructor with store and user id as arguments. Creation date: (08/22/00 5:05:40 PM)
Parameters:
inStoreID - The store id that will be added to search criteria.
inUserID - The user id.

RuleQuery

public RuleQuery(int inStoreID,
                 TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
RuleQuery constructor with store id, Trading agreement access bean and user id as arguments.
Parameters:
inStoreID - The store id to be added to search criteria.
agreements - The trading agreement access bean array to process entitlement.
userID - The user id to process entitlement.

RuleQuery

public RuleQuery(com.ibm.commerce.search.rulequery.Query q)
RuleQuery constructor with Query as argument. Creation date: (5/2/2001 2:02:10 PM)
Parameters:
q - A query class

RuleQuery

public RuleQuery(TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
RuleQuery constructor with Trading Agreement Access bean and user id as arguments.
Parameters:
agreements - The trading agreement access bean array to process entitlement.
userID - The user id to process entitlement.

RuleQuery

public RuleQuery(java.util.Vector inStoreIDs,
                 int inUserID)
Rule query constructor with multiple store id and single user id as arguments. Creation date: (08/22/00 5:05:40 PM)
Parameters:
inStoreID - Store id collection that will be added to search criteria.
inUserID - The user id.

RuleQuery

public RuleQuery(java.util.Vector inStoreIDs,
                 TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
RuleQuery constructor with multiple store id, Trading agreement access bean and user id as arguments.
Parameters:
inStoreID - The store id to be added to search criteria.
agreements - The trading agreement access bean array to process entitlement.
userID - The user id to process entitlement.
Method Detail

addAttributeFunction

protected com.ibm.commerce.search.rulequery.Attribute addAttributeFunction(com.ibm.commerce.search.rulequery.Attribute attr,
                                                                           int function)
Adds function to a table column. At present only supports UPPER function. Creation date: (9/21/00 5:28:46 PM)
Parameters:
attr - The table column meta data (Attribute object).
function - The function to be associated with the column.
Returns:
The table column meta data (Attribute object).

addFilterAttribute

public void addFilterAttribute(int attribute,
                               int operator)
                        throws java.lang.Exception
Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN IS NOT NULL. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and vice versa. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.

addFilterAttribute

public void addFilterAttribute(int attribute,
                               int operator,
                               int function)
                        throws java.lang.Exception
Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) IS NULL. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and vice versa. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - static integer constant equivalent of a function. At present only UPPER function is supported.

addFilterAttribute

public void addFilterAttribute(int attribute,
                               int operator,
                               java.lang.String value)
                        throws java.lang.Exception
Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and vice versa. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - value to be filtered from the database.

addFilterAttribute

public void addFilterAttribute(int attribute,
                               int operator,
                               java.lang.String value,
                               int function)
                        throws java.lang.Exception
Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and vice versa. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - value to be filtered from the database.
The - static integer constant equivalent of a function. At present only UPPER function is supported.

addFilterOperand

public void addFilterOperand(com.ibm.commerce.search.rulequery.Attribute attr)
                      throws java.lang.Exception
Adds a WHERE clause predicate into temporary filter predicate collection. Creation date: (9/18/00 12:11:02 PM)
Parameters:
A - WHERE clause predicate

addFilterOperand

public void addFilterOperand(com.ibm.commerce.search.rulequery.Predicate predicate)
                      throws java.lang.Exception
Adds a collection of WHERE clause predicates into temporary filter predicate collection. Creation date: (7/7/01 12:11:02 PM)
Parameters:
A - collection of WHERE clause predicates

addFilterOperator

public void addFilterOperator(int operator)
Adds an operator that combines a set of filter predicates. The logic for post-fix resides in this method. Creation date: (08/22/00 6:20:14 PM)
Parameters:
The - static integer constant equivalent of an operator.

addFilterOperatorType

protected com.ibm.commerce.search.rulequery.Operator addFilterOperatorType(int operType)
Maps constants that represent an filter operator to actual operator. Creation date: (9/21/00 5:37:30 PM)
Parameters:
operType - The operator static integer constant.
Returns:
The actual operator.

addGlobalPredicate

public void addGlobalPredicate()
Method to insert a predicate that will be applied to entire query like BUYABLE/PUBLISHABLE/LANGUAGE_ID. The Global predicate will be ANDed with the selectSet/filterSet. Creation date: (8/23/2001 2:53:28 PM)

addGroupByAttribute

public void addGroupByAttribute(int attribute)
                         throws java.lang.Exception
To set group by operator Creation date: (6/20/2001 1:53:37 PM)

addOperatorType

protected com.ibm.commerce.search.rulequery.Operator addOperatorType(int operType)
Maps constants that represent an operator to actual operator. Creation date: (9/21/00 5:37:30 PM)
Parameters:
operType - The operator static integer constant.
Returns:
The actual operator.

addOrderByAttribute

public void addOrderByAttribute(int attribute,
                                int operator)
                         throws java.lang.Exception
To set order by operator Creation date: (6/20/2001 1:53:37 PM)

addResultOperator

public void addResultOperator(int operator)
                       throws java.lang.Exception
To add result set with operators like max, min, count. Creation date: (08/24/00 6:56:54 PM)
Parameters:
operator - The operator to be added to result set.

addRule

public void addRule()
Adds an set of predicates to a Query. Must be specified after all the individual predicates are specified. The search interface can retrieve only Products, only Items or Both. By default the interface will retrieve only Products. Creation date: (08/22/00 6:21:32 PM)

addRule

public void addRule(int aQueryType)
Adds a set of predicate to Query. Must be specified after all the individual predicates are specified. Creation date: (11/12/00 4:12:07 PM)
Parameters:
aQueryType - The type of result to be retrieved by the query. The search interface can retrieve only Products, only Items or Both.

addSelectAttribute

public void addSelectAttribute(int attribute,
                               int operator)
                        throws java.lang.Exception
Adds a predicate to query Where clause, example, TABLE.COLUMN IS NOT NULL. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.

addSelectAttribute

public void addSelectAttribute(int attribute,
                               int operator,
                               int function)
                        throws java.lang.Exception
Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) IS NULL. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - static integer constant equivalent of a function. At present only UPPER function is supported.

addSelectAttribute

public void addSelectAttribute(int attribute,
                               int operator,
                               java.lang.String value)
                        throws java.lang.Exception
Adds a predicate to query Where clause, example, TABLE.COLUMN LIKE '%VALUE%'. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - value to be filtered from the database.

addSelectAttribute

public void addSelectAttribute(int attribute,
                               int operator,
                               java.lang.String value,
                               int function)
                        throws java.lang.Exception
Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and vice versa. Creation date: (08/24/00 6:56:54 PM)
Parameters:
The - static integer constant equivalent of a column name.
The - static integer constant equivalent of an operator.
The - value to be filtered from the database.
The - static integer constant equivalent of a function. At present only UPPER function is supported.

addSelectAttribute

public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               int attrValueType,
                               java.lang.String languageId,
                               java.lang.String prodType)
                        throws java.lang.Exception
Adds a Rich attribute predicate. This method supports NAME, STRINGVALUE, FLOATVALUE and INTEGERVALUE column in AttrValue column. Creation date: (3/30/2001 1:44:27 PM)
Parameters:
attribute - A search attribute, for example Color, Size.
operator - The static integer operator constant.
value - The value of a search attribute, for example Red, Length = 32.
attrValueType - The column in AttrValue table that must be used to search for the value, example Intergervalue, Stringvalue, Floatvalue or Name.
languageId - The language id that must be used for searching the rich attribute.
prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.

addSelectAttribute

public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               int attrValueType,
                               java.lang.String languageId,
                               java.lang.String prodType,
                               int function)
                        throws java.lang.Exception
Adds a Rich attribute predicate. This method only supports NAME, STRINGVALUE, FLOATVALUE and INTEGERVALUE column in AttrValue column. Creation date: (3/30/2001 1:44:27 PM)
Parameters:
attribute - A search attribute, for example Color, Size.
operator - The static integer operator constant.
value - The value of a search attribute, for example Red, Length = 32.
attrValueType - The column in AttrValue table that must be used to search for the value, example Intergervalue, Stringvalue, Floatvalue or Name.
languageId - The language id that must be used for searching the rich attribute.
prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.
function - The static integer operator for UPPER function

addSelectOperand

public void addSelectOperand(com.ibm.commerce.search.rulequery.Attribute attr)
                      throws java.lang.Exception
Adds a WHERE clause predicate into temporary select set predicate collection. Creation date: (9/18/00 12:11:02 PM)
Parameters:
A - WHERE clause predicate

addSelectOperand

public void addSelectOperand(com.ibm.commerce.search.rulequery.Predicate predicate)
                      throws java.lang.Exception
Adds a collection of WHERE clause predicates into temporary select set predicate collection. Before adding to the collection this method may translate the collection of predicates into a sub-query. At present the tanslation is supported for following table columns CATGPENREL.CATGROUP_ID and CATGRPDESC.NAME or SHORTDESC or LONGDESC. Creation date: (07/07/01 12:11:02 PM)
Parameters:
predicate - A collection of predicates.

addSelectOperator

public void addSelectOperator(int operator)
Adds an operator that combines a set of filter predicates. The logic for post-fix resides in this method. Creation date: (08/22/00 6:20:14 PM)
Parameters:
The - static integer constant equivalent of an operator.

buildPredicate

protected com.ibm.commerce.search.rulequery.Predicate buildPredicate()
                                                              throws java.lang.Exception
Assembles the complete WHERE clause. This method ANDs Select Set predicates, Filter Set predicates, Global predicates and Entitlement predicates. Creation date: (9/13/2001 3:15:02 PM)
Returns:
The complete assembled WHERE clause predicate.

evaluateSelectivity

protected java.lang.String evaluateSelectivity(com.ibm.commerce.search.catalog.SmartQuery query)
                                        throws java.lang.Exception
Evaluates a sub query in WHERE clause. If the number of records returned is less than selectivitySize then the evaluated result replaces the sub-query in the main query else the sub-query is retained. Creation date: (8/25/2001 7:07:40 PM)
Parameters:
query - The sub-query in the where clause.
Returns:
The result of the sub-query or the actual sub query.

execute

public java.util.Vector execute()
                         throws java.lang.Exception
Executes catalog search query and retrieves all the catentry ids that satisfy the query. Creation date: (9/18/00 8:14:39 PM)
Returns:
A collection of catentry ids.

execute

public java.util.Vector execute(com.ibm.commerce.search.rulequery.Cursor aCursor)
                         throws java.lang.Exception
Executes catalog search query and retrieves a set of catentry id between a start value and end value specified in the cursor object. Creation date: (9/18/00 8:14:39 PM)
Parameters:
The - cursor object.
Returns:
A collection of catentry ids between a start value and end value specified in the cursor object.

findAttribute

protected boolean findAttribute(com.ibm.commerce.search.rulequery.Predicate p,
                                java.lang.String s)
                         throws java.lang.Exception
This method can be used to find a particular column s in Predicate p. Creation date: (6/25/2001 3:22:15 PM)
Parameters:
p - A collection of where clause predicate.
s - The column name.
Returns:
true if column s is found, false otherwise.

findAttributeInfoName

protected java.lang.String findAttributeInfoName(int attrId)
Maps a static integer constant that defines a column name to the singleton class name that describes the column name, its data type, and the table it belong to. Creation date: (9/21/00 5:33:59 PM)
Parameters:
attrId - The static integer constant that defines a column name.
Returns:
The singleton class name that match the column name integer constant .

getCatgrpSchemaType

public java.lang.Integer getCatgrpSchemaType()
Do not modify. Method generated by VAJ. Creation date: (9/21/2001 6:45:02 PM)
Returns:
The catgroup schema type.

getEntitlementPredicate

protected final com.ibm.commerce.search.rulequery.Predicate getEntitlementPredicate()
                                                                             throws java.lang.Exception
Constructs the entitlement predicate. Creation date: (9/7/2001 3:43:27 PM)
Returns:
The entitlement predicate.

getGlobalPredicate

protected com.ibm.commerce.search.base.Predicate getGlobalPredicate()
Do not modify. Method generated by VAJ. Creation date: (8/23/2001 3:34:26 PM)
Returns:
The global predicate.

getInstanceOfAttrInfoByClassName

protected com.ibm.commerce.search.catalog.AttributeInfo getInstanceOfAttrInfoByClassName(java.lang.String classname)
                                                                                  throws java.lang.Exception
Given a class name in com.ibm.commerce.search.catalog package, gets the instance of the class. Creation date: (08/25/00 2:38:31 PM)
Parameters:
classname - The name of a class in com.ibm.commerce.search.catalog package.
Returns:
The instance of the class in com.ibm.commerce.search.catalog package.

getLongUserId

public java.lang.Long getLongUserId()
Do not modify. Method generated by VAJ. Creation date: (10/1/2001 4:15:55 PM)
Returns:
The user id of type Long.

getMcQuery

public com.ibm.commerce.search.base.Query getMcQuery()
Do not modify. Method generated by VAJ. Creation date: (7/27/2001 10:58:12 AM)
Returns:
The query object.

getPredicate

public com.ibm.commerce.search.rulequery.Predicate getPredicate()
                                                         throws java.lang.Exception
Do not modify. Method generated by VAJ. Creation date: (7/6/2001 10:13:36 AM)
Returns:
The selectSet and filterSet predicate.

getQueryType

public int getQueryType()
Do not modify. Method generated by VAJ. Creation date: (11/12/00 4:09:01 PM)
Returns:
The query type.

getRASchemaType

public java.lang.Integer getRASchemaType()
Do not modify. Method generated by VAJ. Creation date: (9/21/2001 6:45:18 PM)
Returns:
java.lang.Integer

getResultSet

public java.util.Vector getResultSet()
Do not modify. Method generated by VAJ. Creation date: (5/2/2001 8:56:40 PM)
Returns:
The query result set.

getSelectivitySize

public int getSelectivitySize()
Do not modify. Method generated by VAJ. Creation date: (8/25/2001 7:02:13 PM)
Returns:
The selectivity size.

getSourceTables

public java.util.Vector getSourceTables()
Do not modify. Method generated by VAJ. Creation date: (5/2/2001 8:57:14 PM)
Returns:
The tables used in the query from clause.

getStoreID

public int getStoreID()
Do not modify. Method generated by VAJ. Creation date: (6/25/2001 2:41:44 PM)
Returns:
The store id.

getStoreIDs

public java.util.Vector getStoreIDs()
Do not modify. Method generated by VAJ. Creation date: (7/20/2001 2:25:32 PM)
Returns:
The collection of store id.

getUserID

public java.lang.Integer getUserID()
Do not modify. Method generated by VAJ. Creation date: (10/30/00 6:09:27 AM)
Returns:
The user id of type integer.

isPriceSummary

public boolean isPriceSummary()
Returns if there is summary table for price or not true if there is summary table false otherwise

reset

public void reset()
Re-initialize filterSet and selectSet variables Creation date: (10/30/00 5:52:47 AM)

setAgreements

public void setAgreements(TradingAgreementAccessBean[] newAgreements)
Do not modify. Method generated by VAJ. Creation date: (8/10/2001 2:39:57 PM)
Parameters:
newAgreements - com.ibm.commerce.contract.objects.TradingAgreementAccessBean[]

setCatgrpSchemaType

public void setCatgrpSchemaType(java.lang.Integer newCatgrpSchemaType)
Do not modify. Method generated by VAJ. Creation date: (9/21/2001 6:45:02 PM)
Parameters:
newCatgrpSchemaType - java.lang.Integer

setDefaultResultSelection

public void setDefaultResultSelection()
To set default result selection variable. Creation date: (9/8/2001 1:43:53 PM)

setDistinct

public void setDistinct()
To set disctict operator Creation date: (6/20/2001 9:33:19 AM)

setDistinct

public void setDistinct(boolean distinctFlag)
To set disctict operator. Creation date: (6/20/2001 9:33:19 AM)
Parameters:
true - to set distinct, false otherwise.

setGlobalPredicate

protected void setGlobalPredicate(com.ibm.commerce.search.rulequery.Predicate globalPredicate)
Set the globalPredicate variable Creation date: (8/23/2001 4:00:11 PM)
Parameters:
globalPredicate - The global predicate.

setLongUserId

public void setLongUserId(java.lang.Long newLongUserId)
Do not modify. Method generated by VAJ. Creation date: (10/1/2001 4:15:55 PM)
Parameters:
newLongUserId - java.lang.Long

setRASchemaType

public void setRASchemaType(java.lang.Integer newRASchemaType)
Do not modify. Method generated by VAJ. Creation date: (9/21/2001 6:45:18 PM)
Parameters:
newRASchemaType - java.lang.Integer

setSelectivitySize

public void setSelectivitySize(int newSelectivitySize)
Set selectivity size Creation date: (8/25/2001 7:02:13 PM)
Parameters:
newSelectivitySize - The new selectivity size.

setStoreID

public void setStoreID(int newStoreID)
Set store id. Creation date: (6/25/2001 2:41:44 PM)
Parameters:
newStoreID - The new store id.

setStoreIDs

public void setStoreIDs(java.util.Vector newStoreIDs)
Set collection of store ids Creation date: (7/20/2001 2:25:32 PM)
Parameters:
newStoreIDs - The new store ids.

setUserID

public void setUserID(int newUserID)
Set user id Creation date: (6/25/2001 2:41:44 PM)
Parameters:
newUserID - The new user id.

toString

public java.lang.String toString()
Returns query string Creation date: (11/16/00 3:58:11 PM)
Overrides:
toString in class java.lang.Object
Returns:
The query as string.

translatePredicate

protected com.ibm.commerce.search.rulequery.Predicate translatePredicate(int key,
                                                                         com.ibm.commerce.search.rulequery.Predicate p)
                                                                  throws java.lang.Exception
This method does predicate translation based on the key passed. Creation date: (6/25/2001 4:47:20 PM)
Parameters:
k - The key for translation
p - The predicate to be translated.
Returns:
The translated predicate.