org.odftoolkit.odfdom.incubator.doc.text
Class OdfEditableTextExtractor

java.lang.Object
  extended by org.odftoolkit.odfdom.dom.DefaultElementVisitor
      extended by org.odftoolkit.odfdom.incubator.doc.text.OdfTextExtractor
          extended by org.odftoolkit.odfdom.incubator.doc.text.OdfEditableTextExtractor
All Implemented Interfaces:
ElementVisitor

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

public class OdfEditableTextExtractor
extends OdfTextExtractor

It's a sub class of OdfTextExtractor. It provides a method 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.


Field Summary
 
Fields inherited from class org.odftoolkit.odfdom.incubator.doc.text.OdfTextExtractor
mTextBuilder, NewLineChar, TabChar
 
Method Summary
 String getText()
          Deprecated. Return the editable text content as a string
static OdfEditableTextExtractor newOdfEditableTextExtractor(OdfDocument doc)
          Deprecated. An instance of OdfEditableTextExtractor will be created to extract the editable text content of an ODF element.
static OdfEditableTextExtractor newOdfEditableTextExtractor(OdfElement element)
          Deprecated. An instance of OdfEditableTextExtractor will be created to extract the editable text content of an ODF element.
 void visit(DrawObjectElement element)
          Deprecated. A method to visit "draw:object" elements
 void visit(TableTableElement ele)
          Deprecated. A method to visit "table:table" elements
 void visit(TextAElement ele)
          Deprecated. A method to visit "text:a" elements
 void visit(TextTrackedChangesElement ele)
          Deprecated. A method to visit "text:tracked-changes" elements
 
Methods inherited from class org.odftoolkit.odfdom.incubator.doc.text.OdfTextExtractor
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 OdfEditableTextExtractor newOdfEditableTextExtractor(OdfDocument doc)
Deprecated. 
An instance of OdfEditableTextExtractor will be created to extract the editable text content of an ODF element.

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

newOdfEditableTextExtractor

public static OdfEditableTextExtractor newOdfEditableTextExtractor(OdfElement element)
Deprecated. 
An instance of OdfEditableTextExtractor 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 OdfEditableTextExtractor

visit

public void visit(DrawObjectElement element)
Deprecated. 
Description copied from class: DefaultElementVisitor
A method to visit "draw:object" elements

Overrides:
visit in class DefaultElementVisitor
Parameters:
element - - an instance of DrawObjectElement

visit

public void visit(TextTrackedChangesElement ele)
Deprecated. 
Description copied from class: DefaultElementVisitor
A method to visit "text:tracked-changes" elements

Overrides:
visit in class DefaultElementVisitor
Parameters:
ele - - an instance of TextTrackedChangesElement

visit

public void visit(TextAElement ele)
Deprecated. 
Description copied from class: DefaultElementVisitor
A method to visit "text:a" elements

Overrides:
visit in class DefaultElementVisitor
Parameters:
ele - - an instance of TextAElement

visit

public void visit(TableTableElement ele)
Deprecated. 
Description copied from class: DefaultElementVisitor
A method to visit "table:table" elements

Overrides:
visit in class DefaultElementVisitor
Parameters:
ele - - an instance of TableTableElement

getText

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

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


Copyright © 2008-2017 The Apache Software Foundation. All Rights Reserved.