com.atlassian.confluence.impl.search.v2.extractor

Class LabelExtractor

java.lang.Object

com.atlassian.confluence.impl.search.v2.extractor.LabelExtractor

All Implemented Interfaces:

Extractor2

public class LabelExtractor
extends Object
implements Extractor2

Extract label data from content entity objects.

Since:

7.20

Field Summary

Fields

Modifier and Type	Field and Description
static String	INHERITED_LABEL_FIELD Deprecated. since 7.20 use SearchFieldNames.INHERITED_LABEL instead.
static String	INHERITED_LABEL_TEXT_FIELD Deprecated. since 7.20 use SearchFieldNames.INHERITED_LABEL_TEXT instead.
static String	LABEL_FIELD Deprecated. since 7.20 use SearchFieldNames.LABEL instead.
static String	LABEL_TEXT_FIELD Deprecated. since 7.20 use SearchFieldNames.LABEL_TEXT instead.

Constructor Summary

Constructors

Constructor and Description
LabelExtractor()

Method Summary

Modifier and Type	Method and Description
Collection<FieldDescriptor>	extractFields(Object searchable) Extract fields from the searchable object.
StringBuilder	extractText(Object searchable) Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LABEL_FIELD

@Deprecated
public static final String LABEL_FIELD

Deprecated. since 7.20 use SearchFieldNames.LABEL instead.

Assigned multiple fields of namespaced labels

See Also:

Constant Field Values

LABEL_TEXT_FIELD

@Deprecated
public static final String LABEL_TEXT_FIELD

Deprecated. since 7.20 use SearchFieldNames.LABEL_TEXT instead.

This field is assigned a value consisting of a space delimited list of all the publicly visible labels on a piece of content.

See Also:

Constant Field Values

INHERITED_LABEL_FIELD

@Deprecated
public static final String INHERITED_LABEL_FIELD

Deprecated. since 7.20 use SearchFieldNames.INHERITED_LABEL instead.

The same as LABEL_FIELD, but for labels inherited from a containing object (i.e. comments will get the labels of the object they are commenting on).

See Also:

Constant Field Values

INHERITED_LABEL_TEXT_FIELD

@Deprecated
public static final String INHERITED_LABEL_TEXT_FIELD

Deprecated. since 7.20 use SearchFieldNames.INHERITED_LABEL_TEXT instead.

The same as LABEL_TEXT_FIELD, but for labels inherited from a containing object (i.e. comments will get the labels of the object they are commenting on).

See Also:

Constant Field Values

Constructor Detail

LabelExtractor

public LabelExtractor()

Method Detail

extractText

public StringBuilder extractText(Object searchable)

Returns a buffer of text that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

Specified by:

extractText in interface Extractor2

Parameters:

searchable - a searchable object

Returns:

Returns a buffer of text.

extractFields

public Collection<FieldDescriptor> extractFields(Object searchable)

Extract fields from the searchable object.

Specified by:

extractFields in interface Extractor2

Parameters:

searchable - a searchable object

Returns:

list of fields extracted from the searchable object