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

Class SpaceKeyAndNameExtractor

java.lang.Object

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

All Implemented Interfaces:

Extractor2

public class SpaceKeyAndNameExtractor
extends Object
implements Extractor2

Extracts and indexes the space key and name for searchables that belong to a space. Also Adds a field called SearchFieldMappings.IN_SPACE to allow PersonalInformation objects to be retrieved in searches.

Since:

7.14

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IN_SPACE_FIELD	Deprecated. since 7.20 use SearchFieldMappings.IN_SPACE instead.

Constructor Summary

Constructors

Constructor	Description
SpaceKeyAndNameExtractor()

Method Summary

Modifier and Type	Method	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 Details

IN_SPACE_FIELD

@Deprecated
public static final String IN_SPACE_FIELD

Deprecated.

since 7.20 use SearchFieldMappings.IN_SPACE instead.

Constructor Details

SpaceKeyAndNameExtractor

public SpaceKeyAndNameExtractor()

Method Details

extractText

public StringBuilder extractText(Object searchable)

Description copied from interface: Extractor2

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 that will be appended onto the end of a larger buffer of text that will eventually become the searchable body text.

extractFields

public Collection<FieldDescriptor> extractFields(Object searchable)

Description copied from interface: Extractor2

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