com.hootsuite.nachos.tokenizer

Class BaseChipTokenizer

java.lang.Object

com.hootsuite.nachos.tokenizer.BaseChipTokenizer

All Implemented Interfaces:

ChipTokenizer

public abstract class BaseChipTokenizer
extends java.lang.Object
implements ChipTokenizer

Base implementation of the ChipTokenizer interface that performs no actions and returns default values. This class allows for the easy creation of a ChipTokenizer that only implements some of the methods of the interface.

Constructor Summary

Constructors

Constructor and Description
BaseChipTokenizer()

Method Summary

Modifier and Type	Method and Description
void	applyConfiguration(android.text.Editable text, ChipConfiguration chipConfiguration) Configures this ChipTokenizer to produce chips with the provided attributes.
void	deleteChip(Chip chip, android.text.Editable text) Removes a chip and any text it encompasses from text.
void	deleteChipAndPadding(Chip chip, android.text.Editable text) Removes a chip, any text it encompasses AND any padding text (such as spaces) that may have been inserted when the chip was created in ChipTokenizer.terminateToken(CharSequence, Object) or after.
Chip[]	findAllChips(int start, int end, android.text.Spanned text) Searches through text for any chips
java.util.List<android.util.Pair<java.lang.Integer,java.lang.Integer>>	findAllTokens(java.lang.CharSequence text) Searches through text for any tokens.
int	findChipEnd(Chip chip, android.text.Spanned text) Finds the index of the character after the last character in text that is a part of chip
int	findChipStart(Chip chip, android.text.Spanned text) Finds the index of the first character in text that is a part of chip
int	findTokenEnd(java.lang.CharSequence charSequence, int i) Returns the end of the token (minus trailing punctuation) that begins at offset cursor within text.
int	findTokenStart(java.lang.CharSequence charSequence, int i) Returns the start of the token that ends at offset cursor within text.
void	revertChipToToken(Chip chip, android.text.Editable text) Effectively does the opposite of ChipTokenizer.terminateToken(CharSequence, Object) by reverting the provided chip back into a token.
void	terminateAllTokens(android.text.Editable text) Terminates (converts from token into chip) all unterminated tokens in the provided text.
java.lang.CharSequence	terminateToken(java.lang.CharSequence charSequence, java.lang.Object data) Returns text, modified, if necessary, to ensure that it ends with a token terminator (for example a space or comma).

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseChipTokenizer

public BaseChipTokenizer()

Method Detail

applyConfiguration

public void applyConfiguration(android.text.Editable text,
                               ChipConfiguration chipConfiguration)

Description copied from interface: ChipTokenizer

Configures this ChipTokenizer to produce chips with the provided attributes. For each of these attributes, -1 or null may be passed to indicate that the attribute may be ignored.

This will also apply the provided ChipConfiguration to any existing chips in the provided text.

Specified by:

applyConfiguration in interface ChipTokenizer

Parameters:

text - the text in which to search for existing chips to apply the configuration to

chipConfiguration - a ChipConfiguration containing customizations for the chips produced by this class

findTokenStart

public int findTokenStart(java.lang.CharSequence charSequence,
                          int i)

Description copied from interface: ChipTokenizer

Returns the start of the token that ends at offset cursor within text.

Specified by:

findTokenStart in interface ChipTokenizer

findTokenEnd

public int findTokenEnd(java.lang.CharSequence charSequence,
                        int i)

Description copied from interface: ChipTokenizer

Returns the end of the token (minus trailing punctuation) that begins at offset cursor within text.

Specified by:

findTokenEnd in interface ChipTokenizer

findAllTokens

public java.util.List<android.util.Pair<java.lang.Integer,java.lang.Integer>> findAllTokens(java.lang.CharSequence text)

Description copied from interface: ChipTokenizer

Searches through text for any tokens.

Specified by:

findAllTokens in interface ChipTokenizer

Parameters:

text - the text in which to search for un-terminated tokens

Returns:

a list of Pairs of the form (startIndex, endIndex) containing the locations of all unterminated tokens

terminateToken

public java.lang.CharSequence terminateToken(java.lang.CharSequence charSequence,
                                             java.lang.Object data)

Description copied from interface: ChipTokenizer

Returns text, modified, if necessary, to ensure that it ends with a token terminator (for example a space or comma).

Specified by:

terminateToken in interface ChipTokenizer

terminateAllTokens

public void terminateAllTokens(android.text.Editable text)

Description copied from interface: ChipTokenizer

Terminates (converts from token into chip) all unterminated tokens in the provided text. This method CAN alter the provided text.

Specified by:

terminateAllTokens in interface ChipTokenizer

Parameters:

text - the text in which to terminate all tokens

findChipStart

public int findChipStart(Chip chip,
                         android.text.Spanned text)

Description copied from interface: ChipTokenizer

Finds the index of the first character in text that is a part of chip

Specified by:

findChipStart in interface ChipTokenizer

Parameters:

chip - the chip whose start should be found

text - the text in which to search for the start of chip

Returns:

the start index of the chip

findChipEnd

public int findChipEnd(Chip chip,
                       android.text.Spanned text)

Description copied from interface: ChipTokenizer

Finds the index of the character after the last character in text that is a part of chip

Specified by:

findChipEnd in interface ChipTokenizer

Parameters:

chip - the chip whose end should be found

text - the text in which to search for the end of chip

Returns:

the end index of the chip

findAllChips

public Chip[] findAllChips(int start,
                           int end,
                           android.text.Spanned text)

Description copied from interface: ChipTokenizer

Searches through text for any chips

Specified by:

findAllChips in interface ChipTokenizer

Parameters:

start - index to start looking for terminated tokens (inclusive)

end - index to end looking for terminated tokens (exclusive)

text - the text in which to search for terminated tokens

Returns:

a list of objects implementing the Chip interface to represent the terminated tokens

revertChipToToken

public void revertChipToToken(Chip chip,
                              android.text.Editable text)

Description copied from interface: ChipTokenizer

Effectively does the opposite of ChipTokenizer.terminateToken(CharSequence, Object) by reverting the provided chip back into a token. This method CAN alter the provided text.

Specified by:

revertChipToToken in interface ChipTokenizer

Parameters:

chip - the chip to revert into a token

text - the text in which the chip resides

deleteChip

public void deleteChip(Chip chip,
                       android.text.Editable text)

Description copied from interface: ChipTokenizer

Removes a chip and any text it encompasses from text. This method CAN alter the provided text.

Specified by:

deleteChip in interface ChipTokenizer

Parameters:

chip - the chip to remove

text - the text to remove the chip from

deleteChipAndPadding

public void deleteChipAndPadding(Chip chip,
                                 android.text.Editable text)

Description copied from interface: ChipTokenizer

Removes a chip, any text it encompasses AND any padding text (such as spaces) that may have been inserted when the chip was created in ChipTokenizer.terminateToken(CharSequence, Object) or after. This method CAN alter the provided text.

Specified by:

deleteChipAndPadding in interface ChipTokenizer

Parameters:

chip - the chip to remove

text - the text to remove the chip and padding from