org.nuxeo.ecm.core.storage

Interface FulltextParser

All Known Implementing Classes:

DefaultFulltextParser

public interface FulltextParser

Parser of strings for fulltext indexing.

From the strings extracted from the document, decides how they should be parsed, split and normalized for fulltext indexing by the underlying engine.

Since:

5.9.5

Method Summary

Modifier and Type	Method and Description
String	parse(String s, String path) Parses one property value to normalize the fulltext for the database.
void	parse(String s, String path, List<String> strings) Parses one property value to normalize the fulltext for the database.
String	parse(String s, String path, String mimeType, DocumentLocation documentLocation) Parses one property value to normalize the fulltext for the database.
void	parse(String s, String path, String mimeType, DocumentLocation documentLocation, List<String> strings) Parses one property value to normalize the fulltext for the database.

Method Detail

parse

String parse(String s,
             String path)

Parses one property value to normalize the fulltext for the database.

The passed path may be null if the passed string is not coming from a specific path, for instance when it was extracted from binary data.

Parameters:

s - the string to be parsed and normalized

path - the abstracted path for the property (where all complex indexes have been replaced by *), or null

Returns:

the normalized words as a single space-separated string

parse

void parse(String s,
           String path,
           List<String> strings)

Parses one property value to normalize the fulltext for the database.

Like parse(String, String) but uses the passed list to accumulate words.

Parameters:

s - the string to be parsed and normalized

path - the abstracted path for the property (where all complex indexes have been replaced by *), or null

strings - the list into which normalized words should be accumulated

parse

String parse(String s,
             String path,
             String mimeType,
             DocumentLocation documentLocation)

Parses one property value to normalize the fulltext for the database.

The passed path may be null if the passed string is not coming from a specific path, for instance when it was extracted from binary data.

Parameters:

s - the string to be parsed and normalized

path - the abstracted path for the property (where all complex indexes have been replaced by *), or null

mimeType - the mimeType of the string to be parsed and normalized. This may be null

documentLocation - the documentLocation of the Document from which the property value string was extracted. This may be null

Returns:

the normalized words as a single space-separated string

Since:

8.4

parse

void parse(String s,
           String path,
           String mimeType,
           DocumentLocation documentLocation,
           List<String> strings)

Parses one property value to normalize the fulltext for the database.

Like parse(String, String) but uses the passed list to accumulate words.

Parameters:

s - the string to be parsed and normalized

path - the abstracted path for the property (where all complex indexes have been replaced by *), or null

mimeType - the mimeType of the string to be parsed and normalized. This may be null

documentLocation - the documentLocation of the Document from which the property value string was extracted. This may be null

strings - the list into which normalized words should be accumulated

Since:

8.4