org.odftoolkit.simple.common
Class EditableTextExtractor

java.lang.Object
  extended by org.odftoolkit.odfdom.dom.DefaultElementVisitor
      extended by org.odftoolkit.simple.common.TextExtractor
          extended by org.odftoolkit.simple.common.EditableTextExtractor
All Implemented Interfaces:
ElementVisitor

public class EditableTextExtractor
extends TextExtractor

It's a sub class of TextExtractor, which provides a method getText() to return all the text that the user can typically edit in a document, including text in cotent.xml, header and footer in styles.xml, meta data in meta.xml.

This function can be used by search engine, and text analytic operations.

See Also:
OdfElement, DefaultElementVisitor

Nested Class Summary
 
Nested classes/interfaces inherited from class org.odftoolkit.simple.common.TextExtractor
TextExtractor.ExtractorStringBuilder
 
Field Summary
 
Fields inherited from class org.odftoolkit.simple.common.TextExtractor
mTextBuilder, NewLineChar, TabChar
 
Method Summary
 String getText()
          Return the editable text content as a string
static String getText(Document doc)
          Return the text content of document as String
static String getText(OdfElement ele)
          Return the text content of a element as String
static EditableTextExtractor newOdfEditableTextExtractor(Document doc)
          An instance of EditableTextExtractor will be created to extract the editable text content in specified document.
static EditableTextExtractor newOdfEditableTextExtractor(OdfElement element)
          An instance of EditableTextExtractor will be created to extract the editable text content of an ODF element.
 void visit(DrawObjectElement element)
          The end users needn't to care of this method, if you don't want to override the text content handling strategy of draw:object.
 void visit(TableTableElement ele)
          The end users needn't to care of this method, if you don't want to override the text content handling strategy of table:table.
 void visit(TextAElement ele)
          The end users needn't to care of this method, if you don't want to override the text content handling strategy of text:a.
 void visit(TextTrackedChangesElement ele)
          The end users needn't to care of this method, if you don't want to override the text content handling strategy of text:tracked-changes.
 
Methods inherited from class org.odftoolkit.simple.common.TextExtractor
appendElementText, newOdfTextExtractor, visit, visit, visit, visit, visit, visit
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

newOdfEditableTextExtractor

public static EditableTextExtractor newOdfEditableTextExtractor(Document doc)
An instance of EditableTextExtractor will be created to extract the editable text content in specified document.

Parameters:
doc - the document whose text will be extracted.
Returns:
An instance of EditableTextExtractor

newOdfEditableTextExtractor

public static EditableTextExtractor newOdfEditableTextExtractor(OdfElement element)
An instance of EditableTextExtractor will be created to extract the editable text content of an ODF element.

Parameters:
element - the ODF element whose text will be extracted.
Returns:
An instance of EditableTextExtractor

getText

public static String getText(OdfElement ele)
Return the text content of a element as String

Parameters:
ele - the ODF element
Returns:
the text content of the element

getText

public static String getText(Document doc)
Return the text content of document as String

Parameters:
doc - the document
Returns:
the text content of the document

getText

public String getText()
Return the editable text content as a string

Overrides:
getText in class TextExtractor
Returns:
the editable text content as a string

visit

public void visit(DrawObjectElement element)
The end users needn't to care of this method, if you don't want to override the text content handling strategy of draw:object.

Overrides:
visit in class DefaultElementVisitor
See Also:
DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.draw.DrawObjectElement)

visit

public void visit(TextTrackedChangesElement ele)
The end users needn't to care of this method, if you don't want to override the text content handling strategy of text:tracked-changes.

Overrides:
visit in class DefaultElementVisitor
See Also:
DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextTrackedChangesElement)

visit

public void visit(TextAElement ele)
The end users needn't to care of this method, if you don't want to override the text content handling strategy of text:a.

Overrides:
visit in class DefaultElementVisitor
See Also:
DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextAElement)

visit

public void visit(TableTableElement ele)
The end users needn't to care of this method, if you don't want to override the text content handling strategy of table:table.

Overrides:
visit in class DefaultElementVisitor
See Also:
DefaultElementVisitor.visit(org.odftoolkit.odfdom.dom.element.text.TextTabElement)


Copyright © 2010-2011 The Apache Software Foundation. All Rights Reserved.