org.carrot2.util.attribute

Enum BindableDescriptor.GroupingMethod

java.lang.Object

java.lang.Enum<BindableDescriptor.GroupingMethod>

org.carrot2.util.attribute.BindableDescriptor.GroupingMethod

All Implemented Interfaces:

Serializable, Comparable<BindableDescriptor.GroupingMethod>

Enclosing class:

BindableDescriptor

public static enum BindableDescriptor.GroupingMethod
extends Enum<BindableDescriptor.GroupingMethod>

The supported AttributeDescriptor grouping methods.

See Also:

BindableDescriptor.group(GroupingMethod)

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUP Grouping by the "semantic" group assigned to the attribute.
LEVEL Grouping by the AttributeLevel.
NONE No grouping, all attributes will be put in BindableDescriptor.attributeDescriptors.
STRUCTURE Grouping by the Class in which the attribute is declared.

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()
static BindableDescriptor.GroupingMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static BindableDescriptor.GroupingMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRUCTURE

public static final BindableDescriptor.GroupingMethod STRUCTURE

Grouping by the Class in which the attribute is declared. Attributes defined directly in the top-level BindableDescriptor will be put in BindableDescriptor.attributeDescriptors.

Group key type: Class.

LEVEL

public static final BindableDescriptor.GroupingMethod LEVEL

Grouping by the AttributeLevel. Attributes without AttributeLevel will be put in BindableDescriptor.attributeDescriptors.

Group key type: AttributeLevel

GROUP

public static final BindableDescriptor.GroupingMethod GROUP

Grouping by the "semantic" group assigned to the attribute. Attributes with undefined semantic group will be put in BindableDescriptor.attributeDescriptors.

Group key type: String.

See Also:

AttributeMetadata.getGroup()

NONE

public static final BindableDescriptor.GroupingMethod NONE

No grouping, all attributes will be put in BindableDescriptor.attributeDescriptors.

See Also:

BindableDescriptor.flatten()

Method Detail

values

public static BindableDescriptor.GroupingMethod[] 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 (BindableDescriptor.GroupingMethod c : BindableDescriptor.GroupingMethod.values())
    System.out.println(c);

Returns:

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

valueOf

public static BindableDescriptor.GroupingMethod valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<BindableDescriptor.GroupingMethod>