Annotation Interface FsIndex

@Retention(RUNTIME)
@Target(TYPE)
public @interface FsIndex

See Also:

• FsIndexDescription
• FsIndexFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FsIndex.NoClassSet	Indicates that no type has been set.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KIND_BAG
static final String	KIND_SET
static final String	KIND_SORTED
static final String	NO_NAME_TYPE_SET	Indicated that no type name has been set.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	label

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
FsIndexKey[]	keys
String	kind
Class<? extends TOP>	type	The type of the index as class.
String	typeName	The type of the index as name.
boolean	typePriorities

Field Details

KIND_SORTED

static final String KIND_SORTED

See Also:

• FsIndexDescription.KIND_SORTED
• Constant Field Values

KIND_SET

static final String KIND_SET

See Also:

• FsIndexDescription.KIND_SET
• Constant Field Values

KIND_BAG

static final String KIND_BAG

See Also:

• FsIndexDescription.KIND_BAG
• Constant Field Values

NO_NAME_TYPE_SET

static final String NO_NAME_TYPE_SET

Indicated that no type name has been set.

See Also:

• Constant Field Values

Element Details

label

String label

Returns:

the label of this index

See Also:

• FsIndexDescription.getLabel()

typeName

String typeName

The type of the index as name. As an alternative, the index can be defined using a class with type(). One method or the other must be used to set the index type.

Returns:

the type name for this index

See Also:

• FsIndexDescription.getTypeName()

Default:

"org.apache.uima.fit.descriptor.FsIndex.NO_NAME_TYPE_SET"

type

Class<? extends TOP> type

The type of the index as class. As an alternative, the index can be defined using a type name with typeName(). One method or the other must be used to set the index type.

Returns:

the type for this index

See Also:

• FsIndexDescription.getTypeName()

Default:

org.apache.uima.fit.descriptor.FsIndex.NoClassSet.class

kind

String kind

Returns:

the kind of index

See Also:

• FsIndexDescription.getKind()

Default:

"bag"

keys

FsIndexKey[] keys

Returns:

the keys for this index

See Also:

• FsIndexDescription.getKeys()

Default:

{}

typePriorities

boolean typePriorities

Returns:

true if and only if this is a type priority key

See Also:

• FsIndexKeyDescription.isTypePriority()

Default:

true