org.odftoolkit.odfdom.incubator.doc.text

Class OdfTextExtractor

java.lang.Object

org.odftoolkit.odfdom.dom.DefaultElementVisitor

org.odftoolkit.odfdom.incubator.doc.text.OdfTextExtractor

All Implemented Interfaces:

ElementVisitor

Direct Known Subclasses:

OdfEditableTextExtractor

Deprecated.

As of release 0.8.8, replaced by org.odftoolkit.simple.common.TextExtractor in Simple API.

public class OdfTextExtractor
extends DefaultElementVisitor

It's a sub class of DefaultElementVisitor. It provides a method to get the display text of a single element.

If you pass the content root as the parameter, the whole document content will be returned, without any tag information.

It implements part of white space handling fuctions: text:p, text:h, text:s, text:tab, text:linebreak are processed according to ODF specification.

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	mTextBuilder Deprecated.
protected static char	NewLineChar Deprecated.
protected static char	TabChar Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OdfTextExtractor() Deprecated. Default constructor
protected	OdfTextExtractor(OdfElement element) Deprecated. Constructor with an ODF element as paramter

Method Summary

Modifier and Type	Method and Description
protected void	appendElementText(OdfElement ele) Deprecated. Append the text content of this element to string buffer.
String	getText() Deprecated. Return the text content as a string
static OdfTextExtractor	newOdfTextExtractor(OdfElement element) Deprecated. An instance of OdfTextExtractor will be created to extract the text content of an ODF element.
void	visit(OdfElement element) Deprecated. Visit odf element and process some operations
void	visit(TextHElement ele) Deprecated. A method to visit "text:h" elements
void	visit(TextLineBreakElement ele) Deprecated. A method to visit "text:line-break" elements
void	visit(TextPElement ele) Deprecated. A method to visit "text:p" elements
void	visit(TextSElement ele) Deprecated. A method to visit "text:s" elements
void	visit(TextTabElement ele) Deprecated. A method to visit "text:tab" elements

Methods inherited from class org.odftoolkit.odfdom.dom.DefaultElementVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Field Detail

mTextBuilder

protected StringBuilder mTextBuilder

Deprecated.

NewLineChar

protected static final char NewLineChar

Deprecated.

See Also:

Constant Field Values

TabChar

protected static final char TabChar

Deprecated.

See Also:

Constant Field Values

Constructor Detail

OdfTextExtractor

protected OdfTextExtractor()

Deprecated.

Default constructor

OdfTextExtractor

protected OdfTextExtractor(OdfElement element)

Deprecated.

Constructor with an ODF element as paramter

Parameters:

element - the ODF element whose text would be extracted.

Method Detail

appendElementText

protected void appendElementText(OdfElement ele)

Deprecated.

Append the text content of this element to string buffer.

Parameters:

ele - the ODF element whose text will be appended.

newOdfTextExtractor

public static OdfTextExtractor newOdfTextExtractor(OdfElement element)

Deprecated.

An instance of OdfTextExtractor will be created to extract the text content of an ODF element.

Parameters:

element - the ODF element whose text will be extracted.

Returns:

An instance of OdfTextExtractor

visit

public void visit(OdfElement element)

Deprecated.

Description copied from interface: ElementVisitor

Visit odf element and process some operations

Specified by:

visit in interface ElementVisitor

Specified by:

visit in class DefaultElementVisitor

Parameters:

element - ODF element

visit

public void visit(TextPElement ele)

Deprecated.

Description copied from class: DefaultElementVisitor

A method to visit "text:p" elements

Overrides:

visit in class DefaultElementVisitor

Parameters:

ele - - an instance of TextPElement

visit

public void visit(TextHElement ele)

Deprecated.

Description copied from class: DefaultElementVisitor

A method to visit "text:h" elements

Overrides:

visit in class DefaultElementVisitor

Parameters:

ele - - an instance of TextHElement

visit

public void visit(TextSElement ele)

Deprecated.

Description copied from class: DefaultElementVisitor

A method to visit "text:s" elements

Overrides:

visit in class DefaultElementVisitor

Parameters:

ele - - an instance of TextSElement

visit

public void visit(TextTabElement ele)

Deprecated.

Description copied from class: DefaultElementVisitor

A method to visit "text:tab" elements

Overrides:

visit in class DefaultElementVisitor

Parameters:

ele - - an instance of TextTabElement

visit

public void visit(TextLineBreakElement ele)

Deprecated.

Description copied from class: DefaultElementVisitor

A method to visit "text:line-break" elements

Overrides:

visit in class DefaultElementVisitor

Parameters:

ele - - an instance of TextLineBreakElement

getText

public String getText()

Deprecated.

Return the text content as a string

Returns:

the text content as a string