de.tudarmstadt.ukp.jwktl.api
Interface IWikiString

All Known Implementing Classes:
WikiString

public interface IWikiString

Represents a text that contains wiki markup. In addition to the original text containing the wiki markup, the interface allows extracting a list of wiki-internal and external links as well as a plain text representation (i.e., a text without markup).

Author:
Christian M. Meyer, Christof Müller, Lizhen Qu

Method Summary
 String getPlainText()
          Parses the original text to filter out all wiki markup and thus returns a human-readable version of the text.
 String getText()
          Returns the original text including all wiki markup.
 List<String> getWikiLinks()
          Returns a list of wiki-internal links.
 

Method Detail

getText

String getText()
Returns the original text including all wiki markup.


getPlainText

String getPlainText()
Parses the original text to filter out all wiki markup and thus returns a human-readable version of the text. Note that the parsing might be done on demand, so avoid invoking this method repeatedly for the same text.


getWikiLinks

List<String> getWikiLinks()
Returns a list of wiki-internal links. That is, all substrings enclosed by two square brackets. Link captions will be removed. If no wiki links are found, an empty list will be returned. Note that the parsing might be done on demand, so avoid invoking this method repeatedly for the same text.



Copyright © 2011-2013 Ubiquitous Knowledge Processing (UKP) Lab. All Rights Reserved.