com.canto.cumulus.prefs

Class QueryConditionCategories

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.QueryConditionBase

com.canto.cumulus.prefs.QueryConditionCategories

public class QueryConditionCategories
extends QueryConditionBase

This class represents a query condition for the Categories field.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryConditionCategories.MatchMode The available match modes for the Categories field.

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConfiguration(java.util.Locale locale) Checks the current configuration for its validity.
java.util.List<ItemIdentifier>	getCategories() Returns the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS.
java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>>	getCategoriesForCatalogs() Returns the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS grouped by catalog.
QueryConditionCategories.MatchMode	getMatchMode() Returns the current match mode
void	setCategories(java.util.List<ItemIdentifier> identifiers) Sets the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS.
void	setMatchMode(QueryConditionCategories.MatchMode matchMode) Sets the current match mode
java.lang.String	toDisplayString(java.util.Locale locale, FieldDefinition fieldDefinition, MultiItemCollection multiItemCollection) Converts this configuration into a presentable display string.
java.lang.String	toQueryString(java.util.Locale locale, FieldDefinition fieldDefinition) Returns a query string that represents this configuration.

Methods inherited from class com.canto.cumulus.prefs.QueryConditionBase

getFieldData, isDoesNotMatchMode, isFieldDataMode

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getMatchMode

public QueryConditionCategories.MatchMode getMatchMode()

Returns the current match mode

Returns:

current match mode

setMatchMode

public void setMatchMode(QueryConditionCategories.MatchMode matchMode)

Sets the current match mode

Parameters:

matchMode - new match mode

setCategories

public void setCategories(java.util.List<ItemIdentifier> identifiers)

Sets the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS.

Parameters:

identifiers - wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS

getCategories

public java.util.List<ItemIdentifier> getCategories()

Returns the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS.

Returns:

wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS

getCategoriesForCatalogs

public java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> getCategoriesForCatalogs()

Returns the wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS grouped by catalog.

Returns:

wanted categories for the match mode QueryConditionCategories.MatchMode.CONTAINS grouped by catalog

Since:

9.0

checkConfiguration

public void checkConfiguration(java.util.Locale locale)
                        throws InvalidStateException

Checks the current configuration for its validity.

Parameters:

locale - Locale to use when checking this instance

Throws:

InvalidStateException - if the current state is not valid

toDisplayString

public java.lang.String toDisplayString(java.util.Locale locale,
                               FieldDefinition fieldDefinition,
                               MultiItemCollection multiItemCollection)

Converts this configuration into a presentable display string.

Parameters:

locale - Locale to use for creating the display string

fieldDefinition - FieldDefinition of the field to create the display string for

multiItemCollection - collection required for building the category display names

Returns:

String representing the current configuration

Since:

8.1

toQueryString

public java.lang.String toQueryString(java.util.Locale locale,
                             FieldDefinition fieldDefinition)

Returns a query string that represents this configuration.

Overrides:

toQueryString in class QueryConditionBase

Parameters:

locale - Locale to use for creating the query

fieldDefinition - the field definition of the field to create this query for

Returns:

the created query string

Since:

8.1