|
OracleAS Personalization Java API Reference 10g Release 2 (10.1.2) B14053-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dmt.op.re.base.FilteringSettings
Encapsulates the settings used to control the way recommendations are computed.
Constructor Summary | |
FilteringSettings() Deprecated. |
|
FilteringSettings(int taxonomy) Creates a new FilteringSettings object using a taxonomy; filtering and category membership are defaulted to off and ALL_ITEMS respectively. |
Method Summary | |
Enum.FilteringType |
getCategoryFiltering() Returns category filtering. |
long[] |
getCategoryList() Returns category list. |
Enum.CategoryMembershipType |
getCategoryMembership() Returns category membership. |
int |
getTaxonomy() Returns taxonomy. |
void |
setCategoryExclusion(int taxonomy, long[] categoryList) Sets FilteringSettings object to exclude categories. |
void |
setCategoryFiltering(int taxonomy) Sets FilteringSettings object to include all categories in the taxonomy. |
void |
setCategoryFiltering(int taxonomy, long[] categoryList) Sets FilteringSettings object to include categories. |
void |
setCategoryLevelFiltering(int taxonomy, long[] categoryList) Sets FilteringSettings object to filter through the level of subtrees specified by categories. |
void |
setCategorySubTreeFiltering(int taxonomy, long[] categoryList) Sets FilteringSettings object to filter through all subtrees of the specified categories. |
static FilteringSettings |
setFilteringSettings(int taxonomy, long[] categoryList, Enum.CategoryMembershipType categoryMembership) |
void |
setItemExclusion(int taxonomy, long[] categoryList) Sets FilteringSettings object to exclude all items in the specified categories. |
void |
setItemFiltering(int taxonomy) Sets FilteringSettings object to include all items in the taxonomy. |
void |
setItemFiltering(int taxonomy, long[] categoryList) Sets FilteringSettings object to include items in the specified categories. |
void |
setItemSubTreeFiltering(int taxonomy, long[] categoryList) Sets FilteringSettings object to filter through all items in the subtree of specifed categories. |
boolean |
validate() Validates FilteringSettings object. |
boolean |
validateForPAR() Validates filtering for those REAPI methods that use Predictive Association Rules (PAR), such as recommendation methods related to cross-selling. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FilteringSettings()
public FilteringSettings(int taxonomy)
FilteringSettings
object using a taxonomy; filtering and category membership are defaulted to off and ALL_ITEMS respectively.taxonomy
- ID of the taxonomyMethod Detail |
public Enum.FilteringType getCategoryFiltering()
public long[] getCategoryList()
public Enum.CategoryMembershipType getCategoryMembership()
public int getTaxonomy()
public boolean validate()
FilteringSettings
object.public boolean validateForPAR()
public void setItemFiltering(int taxonomy)
FilteringSettings
object to include all items in the taxonomy.taxonomy
- ID of the taxonomypublic void setItemExclusion(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to exclude all items in the specified categories.taxonomy
- ID of the taxonomycategoryList
- categories containing items to be excludedArrayTooLargeException
- if category list is too largepublic void setItemFiltering(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to include items in the specified categories.taxonomy
- ID of the taxonomycategoryList
- categories containing items to be includedArrayTooLargeException
- if category list is too largepublic void setItemSubTreeFiltering(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to filter through all items in the subtree of specifed categories.taxonomy
- ID of the taxonomycategoryList
- categories containing the subtreesArrayTooLargeException
- if category list is too largepublic void setCategorySubTreeFiltering(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to filter through all subtrees of the specified categories.taxonomy
- ID of the taxonomycategoryList
- categories containing subcategoriesArrayTooLargeException
- if category list is too largepublic void setCategoryLevelFiltering(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to filter through the level of subtrees specified by categories.taxonomy
- ID of the taxonomycategoryList
- categories that define the tree levelArrayTooLargeException
- if category list is too largepublic void setCategoryFiltering(int taxonomy)
FilteringSettings
object to include all categories in the taxonomy.taxonomy
- ID of the taxonomypublic void setCategoryFiltering(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to include categories.taxonomy
- ID of the taxonomycategoryList
- categories to be includedArrayTooLargeException
- if category list is too largepublic void setCategoryExclusion(int taxonomy, long[] categoryList) throws ArrayTooLargeException
FilteringSettings
object to exclude categories.taxonomy
- ID of the taxonomycategoryList
- categories to be excludedArrayTooLargeException
- if category list is too largepublic static FilteringSettings setFilteringSettings(int taxonomy, long[] categoryList, Enum.CategoryMembershipType categoryMembership) throws ArrayTooLargeException
ArrayTooLargeException
|
OracleAS Personalization Java API Reference 10g Release 2 (10.1.2) B14053-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |