com.canto.cumulus.constants

Enum FindFlag

java.lang.Object

java.lang.Enum<FindFlag>

com.canto.cumulus.constants.FindFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FindFlag>

public enum FindFlag
extends java.lang.Enum<FindFlag>

This enum specifies the flags available when executing queries.

Since:

8.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIND_MISSING_FIELDS_ARE_ERROR Searching flag added to the type that specifies how to handle fields that are missing in the target catalog.
FIND_MISSING_FIELDS_FIND_NOTHING Searching flag added to the type that specifies how to handle fields that are missing in the target catalog.
FIND_MISSING_FIELDS_REPLACE Searching flag added to the type that specifies how to handle fields that are missing in the target catalog.
FIND_MISSING_STRING_LIST_VALUES_ARE_ERROR Searching flag added to the type that specifies how to handle the case that the query uses string list values that are missing in the target catalog.
FIND_MISSING_STRING_LIST_VALUES_REPLACE Searching flag added to the type that specifies how to handle the case that the query uses string list values that are missing in the target catalog.
QUICK_SEARCH_STRING This flag specifies that the given string is a quick search text and not a query.
SEARCH_CATEGORIES_ABOVE Also include all parent categories of the categories matching the given query.
SEARCH_CATEGORIES_BELOW Also include all sub-categories of the categories matching the given query.
SEARCH_CATEGORIES_EXACT Only find categories that exactly match the given query.
SEARCH_CATEGORIES_MATCH_ONE When searching by multiple categories (by calling RecordItemCollection.find(java.util.Set, java.util.EnumSet, CombineMode) this flag indicates to return records that are assigned to at least one of the categories.
SEARCH_CATEGORIES_RESOLVE_RELATED Resolve all related categories matching the given query and include the originals.
SEARCH_CATEGORIES_USE_USER_SETTINGS This flag is a placeholder to use the user settings when searching categories.

Method Summary

Methods

Modifier and Type	Method and Description
static FindFlag	find(int id) Find the flag for the given id.
static java.util.EnumSet<FindFlag>	findAll(int id) Returns all flags that have been encoded into the given id.
static int	getAll(java.util.EnumSet<FindFlag> flags) Returns all given flags as an encoded int.
int	getID() Returns the id for this flag.
static FindFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FindFlag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEARCH_CATEGORIES_EXACT

public static final FindFlag SEARCH_CATEGORIES_EXACT

Only find categories that exactly match the given query.

SEARCH_CATEGORIES_ABOVE

public static final FindFlag SEARCH_CATEGORIES_ABOVE

Also include all parent categories of the categories matching the given query.

SEARCH_CATEGORIES_BELOW

public static final FindFlag SEARCH_CATEGORIES_BELOW

Also include all sub-categories of the categories matching the given query.

SEARCH_CATEGORIES_RESOLVE_RELATED

public static final FindFlag SEARCH_CATEGORIES_RESOLVE_RELATED

Resolve all related categories matching the given query and include the originals.

SEARCH_CATEGORIES_MATCH_ONE

public static final FindFlag SEARCH_CATEGORIES_MATCH_ONE

When searching by multiple categories (by calling RecordItemCollection.find(java.util.Set, java.util.EnumSet, CombineMode) this flag indicates to return records that are assigned to at least one of the categories. If this flag is not specified then only records assigned to all given categories are returned.

SEARCH_CATEGORIES_USE_USER_SETTINGS

public static final FindFlag SEARCH_CATEGORIES_USE_USER_SETTINGS

This flag is a placeholder to use the user settings when searching categories.

QUICK_SEARCH_STRING

public static final FindFlag QUICK_SEARCH_STRING

This flag specifies that the given string is a quick search text and not a query.

Since:

11.1.5

FIND_MISSING_FIELDS_ARE_ERROR

public static final FindFlag FIND_MISSING_FIELDS_ARE_ERROR

Searching flag added to the type that specifies how to handle fields that are missing in the target catalog. By adding this flag the find method throws an error if a field is missing. This is the default if you do not specify any specific handling.

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

FIND_MISSING_FIELDS_FIND_NOTHING

public static final FindFlag FIND_MISSING_FIELDS_FIND_NOTHING

Searching flag added to the type that specifies how to handle fields that are missing in the target catalog. By adding this flag the find method returns an empty result if a field is missing.

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

FIND_MISSING_FIELDS_REPLACE

public static final FindFlag FIND_MISSING_FIELDS_REPLACE

Searching flag added to the type that specifies how to handle fields that are missing in the target catalog. By adding this flag the find method tries to return "natural" results without any error (e.g. a search for "<missing field> has value" produces an empty result).

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

FIND_MISSING_STRING_LIST_VALUES_ARE_ERROR

public static final FindFlag FIND_MISSING_STRING_LIST_VALUES_ARE_ERROR

Searching flag added to the type that specifies how to handle the case that the query uses string list values that are missing in the target catalog. By adding this flag the find method throws an error if a value is missing. This is the default if you do not specify any specific handling.

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

FIND_MISSING_STRING_LIST_VALUES_REPLACE

public static final FindFlag FIND_MISSING_STRING_LIST_VALUES_REPLACE

Searching flag added to the type that specifies how to handle the case that the query uses string list values that are missing in the target catalog. By adding this flag the find method tries to return "natural" results without any error (e.g. a search for "<),some_field>), is <),missing_value>)," produces an empty result).

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

Method Detail

values

public static FindFlag[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FindFlag c : FindFlag.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FindFlag valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getID

public int getID()

Returns the id for this flag.

Returns:

id

find

public static FindFlag find(int id)

Find the flag for the given id.

Parameters:

id - wanted id

Returns:

the found flag or throws an EnumConstantNotPresentException if the id cannot be found

findAll

public static java.util.EnumSet<FindFlag> findAll(int id)

Returns all flags that have been encoded into the given id.

Parameters:

id - encoded id

Returns:

set of all found flags for the id

See Also:

getAll(java.util.EnumSet)

getAll

public static int getAll(java.util.EnumSet<FindFlag> flags)

Returns all given flags as an encoded int.

Parameters:

flags - flags to encode

Returns:

encoded flags as int

See Also:

findAll(int)