com.attivio.sdk.token

Class TokenSink

java.lang.Object

com.attivio.sdk.token.TokenSink

Direct Known Subclasses:

TokenIterator, TokenList

public abstract class TokenSink
extends Object

Abstract class for objects that can have tokens added to them.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_POSITION_INCREMENT Default position increment (1).

Constructor Summary

Constructors

Constructor and Description
TokenSink()

Method Summary

Modifier and Type	Method and Description
void	add(String t) Appends a token using the default position increment.
void	add(String t, int increment) Appends a token.
void	add(Token t) Appends a token using the default position increment.
abstract void	add(Token t, int increment) Appends a token.
void	add(TokenList tokens) Adds all Tokens for the passed in TokenList to this TokenList.
void	add(TokenList tokens, int increment) Adds all Tokens for the passed in TokenList
TokenSink	append(String t) Appends a token to this TokenList using the default position increment.
TokenSink	append(String t, int increment) Appends a token.
TokenSink	append(Token t) Appends a token using the default position increment.
TokenSink	append(Token t, int increment) Appends a token.
void	endScope(String name) Add an TokenAnnotation.SCOPE_END token to the token list.
void	endScope(String name, int endOffset) Add an TokenAnnotation.SCOPE_END token to the token list.
Token	startLanguageRegion(Locale locale) Start a language region for locale.
void	startScope(String name) Add an TokenAnnotation.SCOPE_START token to the token list.
void	startScope(String name, int startOffset) Add a TokenAnnotation.SCOPE_START token to the token list.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POSITION_INCREMENT

protected static final int DEFAULT_POSITION_INCREMENT

Default position increment (1).

See Also:

Constant Field Values

Constructor Detail

TokenSink

public TokenSink()

Method Detail

startScope

public void startScope(String name)

Add an TokenAnnotation.SCOPE_START token to the token list.

startScope

public void startScope(String name,
                       int startOffset)

Add a TokenAnnotation.SCOPE_START token to the token list.

startLanguageRegion

public Token startLanguageRegion(Locale locale)

Start a language region for locale.

A null locale will be encoded as an empty string.

Since:

5.5.0.1

endScope

public void endScope(String name)

Add an TokenAnnotation.SCOPE_END token to the token list.

endScope

public void endScope(String name,
                     int endOffset)

Add an TokenAnnotation.SCOPE_END token to the token list.

add

public final void add(String t)

Appends a token using the default position increment.

Parameters:

t - The string value of a Token to add

add

public final void add(String t,
                      int increment)

Appends a token.

Parameters:

t - The string value of a Token to add

increment - The position increment for the newly added token

add

public final void add(Token t)

Appends a token using the default position increment.

Parameters:

t - The Token to add to this TokenList

add

public abstract void add(Token t,
                         int increment)

Appends a token.

Parameters:

t - The Token to add

increment - The position increment for the newly added token

add

public final void add(TokenList tokens)

Adds all Tokens for the passed in TokenList to this TokenList.

The first Token copied from the passed in TokenList will have the default position increment in this TokenList.

NOTE: The tokens in the passed in TokenList will be cloned prior to adding to this TokenList. Modifications to the passed in TokenList after calling add(TokenList) will not impact this TokenList.

Parameters:

tokens - The TokenList to copy onto the end of this TokenList.

add

public void add(TokenList tokens,
                int increment)

Adds all Tokens for the passed in TokenList

NOTE: The tokens in the passed in TokenList will be cloned prior to being added. Modifications to the passed in TokenList after calling add(TokenList) will not impact this TokenSink.

Parameters:

tokens - The TokenList to add.

increment - The increment for the first Token added from tokens

append

public TokenSink append(String t)

Appends a token to this TokenList using the default position increment.

Parameters:

t - The string value of a Token to add to this TokenList

Returns:

this (supports call chaining)

append

public TokenSink append(String t,
                        int increment)

Appends a token.

Parameters:

t - The string value of a Token to add

increment - The position increment for the Token to add

Returns:

this (supports call chaining)

append

public TokenSink append(Token t)

Appends a token using the default position increment.

Parameters:

t - The Token to add

Returns:

this (supports call chaining)

append

public TokenSink append(Token t,
                        int increment)

Appends a token.

Parameters:

t - The Token to add to this TokenList

increment - The position increment for the Token to add

Returns:

this (supports call chaining)