oracle.dmt.op.re.base
Class FilteringSettings

java.lang.Object
oracle.dmt.op.re.base.FilteringSettings

public class FilteringSettings

extends java.lang.Object

Encapsulates the settings used to control the way recommendations are computed.

Since:

9.0.0

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

FilteringSettings

public FilteringSettings()

Deprecated.

FilteringSettings

public FilteringSettings(int taxonomy)

Creates a new FilteringSettings object using a taxonomy; filtering and category membership are defaulted to off and ALL_ITEMS respectively.

Parameters:

taxonomy - ID of the taxonomy

Method Detail

getCategoryFiltering

public Enum.FilteringType getCategoryFiltering()

Returns category filtering.

Returns:

Enum.FilteringType

getCategoryList

public long[] getCategoryList()

Returns category list.

Returns:

an array of category IDs

getCategoryMembership

public Enum.CategoryMembershipType getCategoryMembership()

Returns category membership.

Returns:

Enum.CategoryMembershipType

getTaxonomy

public int getTaxonomy()

Returns taxonomy.

Returns:

int the taxonomy ID

validate

public boolean validate()

Validates FilteringSettings object.

Returns:

boolean =true if validated, =false otherwise

validateForPAR

public boolean validateForPAR()

Validates filtering for those REAPI methods that use Predictive Association Rules (PAR), such as recommendation methods related to cross-selling. These methods do not allow category-based filtering.

Returns:

boolean =true if validated, =false otherwise

setItemFiltering

public void setItemFiltering(int taxonomy)

Sets FilteringSettings object to include all items in the taxonomy.

Parameters:

taxonomy - ID of the taxonomy

setItemExclusion

public void setItemExclusion(int taxonomy,
                             long[] categoryList)
                      throws ArrayTooLargeException

Sets FilteringSettings object to exclude all items in the specified categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories containing items to be excluded

Throws:

ArrayTooLargeException - if category list is too large

setItemFiltering

public void setItemFiltering(int taxonomy,
                             long[] categoryList)
                      throws ArrayTooLargeException

Sets FilteringSettings object to include items in the specified categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories containing items to be included

Throws:

ArrayTooLargeException - if category list is too large

setItemSubTreeFiltering

public void setItemSubTreeFiltering(int taxonomy,
                                    long[] categoryList)
                             throws ArrayTooLargeException

Sets FilteringSettings object to filter through all items in the subtree of specifed categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories containing the subtrees

Throws:

ArrayTooLargeException - if category list is too large

setCategorySubTreeFiltering

public void setCategorySubTreeFiltering(int taxonomy,
                                        long[] categoryList)
                                 throws ArrayTooLargeException

Sets FilteringSettings object to filter through all subtrees of the specified categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories containing subcategories

Throws:

ArrayTooLargeException - if category list is too large

setCategoryLevelFiltering

public void setCategoryLevelFiltering(int taxonomy,
                                      long[] categoryList)
                               throws ArrayTooLargeException

Sets FilteringSettings object to filter through the level of subtrees specified by categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories that define the tree level

Throws:

ArrayTooLargeException - if category list is too large

setCategoryFiltering

public void setCategoryFiltering(int taxonomy)

Sets FilteringSettings object to include all categories in the taxonomy.

Parameters:

taxonomy - ID of the taxonomy

setCategoryFiltering

public void setCategoryFiltering(int taxonomy,
                                 long[] categoryList)
                          throws ArrayTooLargeException

Sets FilteringSettings object to include categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories to be included

Throws:

ArrayTooLargeException - if category list is too large

setCategoryExclusion

public void setCategoryExclusion(int taxonomy,
                                 long[] categoryList)
                          throws ArrayTooLargeException

Sets FilteringSettings object to exclude categories.

Parameters:

taxonomy - ID of the taxonomy

categoryList - categories to be excluded

Throws:

ArrayTooLargeException - if category list is too large

setFilteringSettings

public static FilteringSettings setFilteringSettings(int taxonomy,
                                                     long[] categoryList,
                                                     Enum.CategoryMembershipType categoryMembership)
                                              throws ArrayTooLargeException

Throws:

ArrayTooLargeException