Class WikiText

java.lang.Object

org.getalp.dbnary.wiki.WikiText

public class WikiText
extends Object

Created by serasset on 24/01/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	WikiText.ExternalLink
final class	WikiText.Heading
final class	WikiText.HTMLComment
final class	WikiText.Indentation	Represents an indentation list item in a MediaWiki content structure (introduced by a ':').
class	WikiText.IndentedItem	Represents an abstract base for list items or elements that are indented, such as numbered or bulleted list items in a MediaWiki content structure.
final class	WikiText.InternalLink
final class	WikiText.Item	Represents a definition list item in a MediaWiki content structure (introduced by a '; term ').
static final class	WikiText.LevelBasedWikiSectionsIterator
class	WikiText.Link
final class	WikiText.ListItem	Represents a bulleted list item in a MediaWiki content structure (introduced by a '*').
final class	WikiText.NoWiki
final class	WikiText.NumberedListItem	Represents a numbered list item in a MediaWiki content structure (introduced by a '#').
class	WikiText.Segment	A segment of text identifies a substring whose first character is at position start and last character is at position end-1;
final class	WikiText.Template
final class	WikiText.Text
class	WikiText.Token
final class	WikiText.WikiContent	Upper element containing text/links/templates and comments interleaved
final class	WikiText.WikiDocument	A wiki content structured as a document, i.e.
final class	WikiText.WikiSection	///////////////////////////////////////////////////////////////////// View wiki text as a document structured in sections and subsections /////////////////////////////////////////////////////////////////////

Field Summary

Fields

Modifier and Type	Field	Description
final String	sourceContent

Constructor Summary

Constructors

Constructor	Description
WikiText(String sourceContent)	///////////////////////////////////////////////////////////////////// WikiText external methods /////////////////////////////////////////////////////////////////////
WikiText(String pagename, String sourceContent)
WikiText(String pagename, String sourceContent, int startOffset, int endOffset)

Method Summary

Modifier and Type	Method	Description
WikiText.WikiDocument	asStructuredDocument()
WikiText.WikiContent	content()
WikiText.Text	endOfContent()
WikiEventsSequence	filteredTokens(WikiEventFilter filter)
int	getEndOffset()
int	getStartOffset()
WikiEventsSequence	headers()
WikiEventsSequence	headers(int level)
WikiEventsSequence	headersMatching(int level, Pattern pattern)
WikiEventsSequence	headersMatching(Pattern pattern)
WikiEventsSequence	links()
WikiSectionsSequence	sections(int level)
WikiEventsSequence	templates()
WikiEventsSequence	templatesOnUpperLevel()
List<WikiText.Token>	tokens()	returns all tokens in the wikiText, that is all special media wiki constructs, along with special Text tokens containing textual content.
List<WikiText.Token>	tokensWithHtmlComments()	returns all tokens in the wikiText, that is all special media wiki constructs, along with special Text tokens containing textual content.
String	toString()
List<WikiText.Token>	wikiTokens()	returns all wikiTokens in the wikiText, that is all special media wiki constructs, excluding html comments.
List<WikiText.Token>	wikiTokensWithHtmlComments()	returns all wikiTokens in the wikiText, that is all special media wiki constructs, including html comments.

Methods inherited from class Object

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

Field Details

sourceContent

public final String sourceContent

Constructor Details

WikiText

public WikiText(String sourceContent)

///////////////////////////////////////////////////////////////////// WikiText external methods /////////////////////////////////////////////////////////////////////

WikiText

public WikiText(String pagename,
 String sourceContent)

WikiText

public WikiText(String pagename,
 String sourceContent,
 int startOffset,
 int endOffset)

Method Details

getStartOffset

public int getStartOffset()

getEndOffset

public int getEndOffset()

content

public WikiText.WikiContent content()

wikiTokens

public List<WikiText.Token> wikiTokens()

returns all wikiTokens in the wikiText, that is all special media wiki constructs, excluding html comments.

Returns:

a sequence of Tokens

wikiTokensWithHtmlComments

public List<WikiText.Token> wikiTokensWithHtmlComments()

returns all wikiTokens in the wikiText, that is all special media wiki constructs, including html comments.

Returns:

a sequence of Tokens

tokens

public List<WikiText.Token> tokens()

returns all tokens in the wikiText, that is all special media wiki constructs, along with special Text tokens containing textual content.

Returns:

a sequence of Tokens (including Text tokens)

tokensWithHtmlComments

public List<WikiText.Token> tokensWithHtmlComments()

returns all tokens in the wikiText, that is all special media wiki constructs, along with special Text tokens containing textual content. The List will include Html Comments

Returns:

a sequence of Tokens (including Text tokens)

endOfContent

public WikiText.Text endOfContent()

filteredTokens

public WikiEventsSequence filteredTokens(WikiEventFilter filter)

links

public WikiEventsSequence links()

templatesOnUpperLevel

public WikiEventsSequence templatesOnUpperLevel()

templates

public WikiEventsSequence templates()

headers

public WikiEventsSequence headers()

headers

public WikiEventsSequence headers(int level)

headersMatching

public WikiEventsSequence headersMatching(Pattern pattern)

headersMatching

public WikiEventsSequence headersMatching(int level,
 Pattern pattern)

sections

public WikiSectionsSequence sections(int level)

asStructuredDocument

public WikiText.WikiDocument asStructuredDocument()

toString

public String toString()

Overrides:

toString in class Object