ch.uzh.ifi.attempto.base
Class TextContainer

java.lang.Object
  ch.uzh.ifi.attempto.base.TextContainer

public class TextContainer
extends java.lang.Object

This class represents a text container that stores a sequence of text elements that represent a (partial) text or sentence.

Author:

Tobias Kuhn

Constructor Summary

TextContainer()
Creates a new text container.

TextContainer(TextElement... elements)
Creates a new text container that contains the given text elements.

TextContainer(TextOperator textOperator)
Creates a new text container using the given text operator.

TextContainer(TextOperator textOperator, TextElement... elements)
Creates a new text container that uses the given text operator and that contains the given text elements.

Method Summary

void	addElement(TextElement el) Adds the text element to the end of the sequence.
TextContainer	clone()
int	getIndexOf(TextElement textElement) Returns the position of the given text element within this text container or -1 if the text element is not contained by this text container.
TextContainer	getSubTextContainer(int startPos, int endPos) Returns a new text container containing a subsequence of the elements of this text container.
java.lang.String	getText() Returns the text that is represented by the sequence of text element as a string.
TextElement	getTextElement(int index) Returns the text element with the given index.
java.util.List<TextElement>	getTextElements() Returns the sequence of text elements.
int	getTextElementsCount() Returns the number of text elements of this text container.
TextOperator	getTextOperator() Returns the text operator of this text container.
void	removeAllElements() Removes all text elements.
void	removeLastElement() Removes the last text element of the sequence if it is not empty.
void	setTextElements(java.util.List<TextElement> elements) Sets the text elements.
void	setTextOperator(TextOperator textOperator) Sets the text operator.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextContainer

public TextContainer()

Creates a new text container.

TextContainer

public TextContainer(TextOperator textOperator)

Creates a new text container using the given text operator.

Parameters:

textOperator - The text operator to be used.

TextContainer

public TextContainer(TextElement... elements)

Creates a new text container that contains the given text elements.

Parameters:

elements - The elements to be added to the new text container.

TextContainer

public TextContainer(TextOperator textOperator,
                     TextElement... elements)

Creates a new text container that uses the given text operator and that contains the given text elements.

Parameters:

textOperator - The text operator to be used.

elements - The elements to be added to the new text container.

Method Detail

getTextElementsCount

public int getTextElementsCount()

Returns the number of text elements of this text container.

Returns:

The number of text elements.

getTextElement

public TextElement getTextElement(int index)

Returns the text element with the given index.

Parameters:

index - The index of the text element to be returned.

Returns:

The text element.

getTextElements

public java.util.List<TextElement> getTextElements()

Returns the sequence of text elements.

Returns:

A list containing the text elements.

setTextElements

public void setTextElements(java.util.List<TextElement> elements)

Sets the text elements.

Parameters:

elements - A list of text elements.

addElement

public void addElement(TextElement el)

Adds the text element to the end of the sequence.

Parameters:

el - The text element to be added.

removeAllElements

public void removeAllElements()

Removes all text elements.

removeLastElement

public void removeLastElement()

Removes the last text element of the sequence if it is not empty.

getText

public java.lang.String getText()

Returns the text that is represented by the sequence of text element as a string.

Returns:

The text.

setTextOperator

public void setTextOperator(TextOperator textOperator)

Sets the text operator.

Parameters:

textOperator - The new text operator.

getTextOperator

public TextOperator getTextOperator()

Returns the text operator of this text container.

Returns:

The text operator.

getIndexOf

public int getIndexOf(TextElement textElement)

Returns the position of the given text element within this text container or -1 if the text element is not contained by this text container. Note that the elements are checked for identity, not for equality.

Parameters:

textElement - The text element.

Returns:

The index of the text element.

getSubTextContainer

public TextContainer getSubTextContainer(int startPos,
                                         int endPos)

Returns a new text container containing a subsequence of the elements of this text container.

Parameters:

startPos - The position of the first element.

endPos - The position after the last element.

Returns:

The new text container.

clone

public TextContainer clone()

Overrides:

clone in class java.lang.Object