IWikiModel (Bliki (Core) 3.1.0 API)

All Superinterfaces:

IConfiguration

All Known Implementing Classes:

AbstractWikiModel, WikiModel
```
public interface IWikiModel
extends IConfiguration
```
Interface for rendering a wiki model

Nested Class Summary
- Nested classes/interfaces inherited from interface info.bliki.wiki.model.IConfiguration
  IConfiguration.Casing

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCategory(String categoryName, String sortKey)` When an article contains a token indicating that the article belongs to a specific category this method should be called to add that category to the output metadata.
`void`	`addInclude(String pageName)` When a document contains a token indicating that the document includes an other Wiki page, i.e. transclusion, this method should be called to add that page to the output metadata.
`void`	`addLink(String topicName)` When a document contains a token indicating that the document links to another Wiki topic this method should be called to add that topic link to the output metadata.
`boolean`	`addSemanticAttribute(String attribute, String attributeValue)` See Semantic MediaWiki for more information.
`boolean`	`addSemanticRelation(String relation, String relationValue)` See Semantic MediaWiki for more information.
`void`	`addTemplate(String template)` When a document contains a token indicating that the document includes a Wiki template this method should be called to add that template to the output metadata.
`String[]`	`addToReferences(String reference, String nameAttribute)` Add a reference (i.e. footnote) to the internal list
`void`	`append(BaseToken contentNode)` Append the content as a child on the top node of the internal stack
`void`	`appendExternalImageLink(String imageSrc, String imageAltText)` Append an external wiki image link (starting with http, https,... and ending with gif, png, jpg, bmp)
`void`	`appendExternalLink(String uriSchemeName, String link, String linkName, boolean withoutSquareBrackets)` Append an external link (starting with http, https, ftp,...) as described in Help Links
`ITableOfContent`	`appendHead(String rawHead, int headLevel, boolean noToC, int headCounter, int startPosition, int endPosition)` Add a single wiki head (i.e. ==...==, ===...===, ====...====,...) to the table of content
`void`	`appendInternalImageLink(String hrefImageLink, String srcImageLink, ImageFormat imageFormat)` Append this internal wiki image link.
`void`	`appendInternalLink(String topic, String hashSection, String topicDescription, String cssClass, boolean parseRecursive)` Append an internal wikilink as described in Help Links
`void`	`appendInterWikiLink(String namespace, String title, String linkText)` Append an InterWiki link
`void`	`appendISBNLink(String isbnPureText)` Append an external ISBN link (starting with `ISBN` ) as described in Wikipedia:ISBN Note: The default implementation in the `AbstractWikiModel` class creates a link to Amazon.com.
`void`	`appendMailtoLink(String link, String linkName, boolean withoutSquareBrackets)` Append an external link (starting with mailto:...) as described in Help:Wikitext#Links
`boolean`	`appendRawNamespaceLinks(String rawNamespaceTopic, String viewableLinkDescription, boolean containsNoPipe)` Check if the topic is a special namespace topic.
`boolean`	`appendRawWikipediaLink(String rawLinkText, String suffix)` Main entry method for parsing a raw wiki link (i.e. the text between the [[...]] square brackets).
`boolean`	`appendRedirectLink(String redirectLink)` Append the redirect link to the model
`void`	`appendSignature(Appendable writer, int numberOfTildes)` Append the user signature to the writer (i.e. '~~~', '~~~~' or '~~~~').
`void`	`appendStack(TagStack stack)` Append the given tag stack to the current tag stack of the model.
`void`	`buildEditLinkUrl(int section)` Build the link to edit a section of the wikipedia article
`AbstractWikipediaParser`	`createNewInstance(String rawWikitext)` Create a new parser instance
`ScribuntoEngine`	`createScribuntoEngine()`
`ITableOfContent`	`createTableOfContent(boolean isTOCIdentifier)` Create the "table of content" placeholder
`int`	`decrementRecursionLevel()` Decrement the current recursion level of the parser.
`int`	`decrementTemplateRecursionLevel()` Decrement the current template recursion level of the temlate parser.
`String`	`encodeTitleDotUrl(String wikiTitle, boolean firstCharacterAsUpperCase)` Encode the wiki links title into a URL for HTML hyperlinks (i.e.
`String`	`encodeTitleToUrl(String wikiTitle, boolean firstCharacterAsUpperCase)` Encode the wiki links title into a URL for HTML hyperlinks (i.e.
`Date`	`getCurrentTimeStamp()` Get the current time stamp.
`Frame`	`getFrame()`
`String`	`getImageBaseURL()` Return a URL string which contains a "${image}" variable, which will be replaced by the image name, to create links to images.
`InterWikiMap`	`getInterwikiMap()` Get the interwiki links map for converting interwiki links into external URLs.
`Set<String>`	`getLinks()` Get the set of Wikipedia link names
`Locale`	`getLocale()` Get the locale of this model.
`Object`	`getMagicWord(String name)` Gets the magic word object for the given string.
`INamespace`	`getNamespace()` Get the namespace of this model.
`String`	`getNamespaceName()` Get the namespace name of this model for the current locale.
`int`	`getNextNumber()` Get the next unique number
`TagToken`	`getNode(int offset)` Get the node at the given offset on the internal stack For example `getNode(fWikiModel.stackSize() - 2)` returns the node before the node at top of the stack.
`String`	`getPageName()` Get the title of the current wiki article.
`String`	`getRawWikiContent(ParsedPageName templateName, Map<String,String> templateParameters)` Get the raw wiki text for the given namespace and article name
`int`	`getRecursionLevel()` Get the current recursion level of the parser.
`String`	`getRedirectLink()` Get the redirect link.
`List<Reference>`	`getReferences()` Get the internal list of references (i.e. footnotes)
`ResourceBundle`	`getResourceBundle()` Get the resource bundle associated with this model for I18N support
`List<SemanticAttribute>`	`getSemanticAttributes()` Get the list of SemanticAttributes
`List<SemanticRelation>`	`getSemanticRelations()` Get the list of SemanticRelations.
`SimpleDateFormat`	`getSimpleDateFormat()` Get a simple date formatter.
`ITableOfContent`	`getTableOfContent()` Get the parsed "table of content" data after parsing the Wikipedia text.
`ITemplateFunction`	`getTemplateFunction(String name)` Get a template parser function (i.e.
`String`	`getWikiBaseEditURL()` Return a URL string which contains, a "${title}" variable which will be replaced by the topic title, to create links edit pages of wiki topics.
`String`	`getWikiBaseURL()` Return a URL string which contains, a "${title}" variable which will be replaced by the topic title, to create links to other wiki topics.
`IEventListener`	`getWikiListener()` Get the current defined wiki listener
`int`	`incrementRecursionLevel()` Increment the current recursion level of the parser.
`int`	`incrementTemplateRecursionLevel()` Increment the current recursion level of the template parser.
`boolean`	`isCamelCaseEnabled()` Checks if CamelCase words should also be used as wiki links.
`boolean`	`isEditorMode()` The current model is used to render a wikipage in editor mode
`boolean`	`isInterWiki(String namespace)` Check if the given namespace is an interwiki link prefix.
`boolean`	`isMathtranRenderer()` If the `<math>` tag should be rendered for the www.mathtran.org service, then return `true`.
`boolean`	`isNamespace(String namespace)` Check if the given namespace is a namespace in this model
`boolean`	`isNoToc()` Check if the rendering of the "table of contents" is disabled globally.
`boolean`	`isParameterParsingMode()` The current model currently renders a template parameter value
`boolean`	`isPreviewMode()` The current model is used to render a wikipage in preview mode
`boolean`	`isSemanticWebActive()` Allow the parsing of semantic mediawiki (SMW) links.
`boolean`	`isTemplateTopic()` Determine if the currently parsed wiki text is a template.
`boolean`	`isValidUriScheme(String uriScheme)` Check if the top level URI (Uniform Resource Identifier) scheme name is valid in this model.
`boolean`	`isValidUriSchemeSpecificPart(String uriScheme, String uriSchemeSpecificPart)` Check if the scheme-specific part for a given top level URI (Uniform Resource Identifier) scheme name is valid in this model.
`boolean`	`parseBehaviorSwitch(String identifier)` Parse a behavior switch (i.e. an identifier with two leading and trailing underscores "__" like for example `__NOEDITSECTION__` ).
`void`	`parseEvents(IEventListener listener, String rawWikiText)` Parse the raw Wikipedia text and notify the listener
`void`	`parseInternalImageLink(String imageNamespace, String rawImageLink)` Append the internal wiki image link to this model.
`String`	`parseTemplates(String rawWikiText)` Parse the templates in a raw wikipedia text into a resulting wikipedia text.
`String`	`parseTemplates(String rawWikiText, boolean parseOnlySignature)` Parse the templates in a raw wikipedia text into a resulting wikipedia text.
`TagToken`	`peekNode()` Get the current TagNode on top of the internal stack
`TagToken`	`popNode()` Pop the current TagNode from top of the internal stack
`boolean`	`pushNode(TagToken node)` Push the given TagNode on top of the internal stack
`void`	`reduceTokenStack(TagToken node)` Reduce the current token stack until an allowed parent is at the top of the stack
`String`	`render(ITextConverter converter, String rawWikiText)` Render the raw Wikipedia text into a string for a given converter
`void`	`render(ITextConverter converter, String rawWikiText, Appendable buffer, boolean templateTopic, boolean parseTemplates)` Render the raw Wikipedia text into a string for a given converter
`String`	`render(ITextConverter converter, String rawWikiText, boolean templateTopic)` Render the raw Wikipedia text into a string for a given converter
`String`	`render(String rawWikiText)` Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
`String`	`render(String rawWikiText, boolean templateTopic)` Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
`String`	`renderPDF(String rawWikiText)` Render the raw Wikipedia text into an HTML string and use the default PDFConverter.
`boolean`	`replaceColon()` Replace a colon ':' with a slash '/' in wiki names (i.e. links, categories, templates)
`void`	`setFrame(Frame frame)`
`void`	`setNamespaceName(String namespaceLowercase)` Set the "lower-case" namespace name of the article rendered with this model.
`void`	`setNoToc(boolean disableToc)` Set to `true` if the rendering of the "table of contents" should be disabled globally.
`void`	`setPageName(String pageTitle)` Set the title of the currently rendered page data.
`void`	`setParameterParsingMode(boolean parameterParsingMode)` Activate the mode for rendering a template parameter value
`void`	`setSemanticWebActive(boolean semanticWeb)` Activate the parsing of semantic Mediawiki (SMW) links See Semantic MediaWiki for more information.
`void`	`setUp()` Prepare or initialize the wiki model before rendering the wikipedia text
`boolean`	`showSyntax(String tagName)` Show the syntax highlighting of the source code
`String[]`	`splitNsTitle(String fullTitle)` Splits the given full title into its namespace and page title components and normalises both components using `Encoder#normaliseTitle(String, boolean, char)` keeping underscores.
`int`	`stackSize()` The size of the internal stack
`void`	`substituteTemplateCall(String templateName, Map<String,String> parameterMap, Appendable writer)` Substitute the template name by the template content and parameters and append the new content to the writer.
`TagStack`	`swapStack(TagStack stack)`
`void`	`tearDown()` Clean up (i.e. free internal resources) in the wiki model after rendering the wikipedia text, if necessary

Methods inherited from interface info.bliki.wiki.model.IConfiguration
addCodeFormatter, addInterwikiLink, addTemplateFunction, addTokenTag, casing, getCodeFormatterMap, getTemplateCallsCache, getTemplateMap, getTokenMap, getUriSchemeSet, setTemplateCallsCache

- Method Detail
  - addCategory
```
void addCategory(String categoryName,
                 String sortKey)
```
    When an article contains a token indicating that the article belongs to a specific category this method should be called to add that category to the output metadata. For the sortKey see also Wikipedia:Categorization#Category_sorting
    
    Parameters:
    
    categoryName - The name of the category that the document belongs to.
    
    sortKey - The sort key for the category, or null if no sort key has been specified. The sort key determines what order categories are sorted on category index pages, so a category for "John Doe" might be given a sort key of "Doe, John".
  - addLink
```
void addLink(String topicName)
```
    When a document contains a token indicating that the document links to another Wiki topic this method should be called to add that topic link to the output metadata.
    
    Parameters:
    
    topicName - The name of the topic that is linked to.
  - addSemanticAttribute
```
boolean addSemanticAttribute(String attribute,
                             String attributeValue)
```
    See Semantic MediaWiki for more information.
    
    Parameters:
    
    attribute -
    
    attributeValue -
    
    Returns:
  - addSemanticRelation
```
boolean addSemanticRelation(String relation,
                            String relationValue)
```
    See Semantic MediaWiki for more information.
    
    Parameters:
    
    relation -
    
    relationValue -
    
    Returns:
  - addTemplate
```
void addTemplate(String template)
```
    When a document contains a token indicating that the document includes a Wiki template this method should be called to add that template to the output metadata.
    
    Parameters:
    
    template - The name of the template that is being included (excluding the template namespace).
  - addInclude
```
void addInclude(String pageName)
```
    When a document contains a token indicating that the document includes an other Wiki page, i.e. transclusion, this method should be called to add that page to the output metadata. This excludes transcluded template pages.
    
    Parameters:
    
    pageName - The name of the page that is being included (including its namespace).
    
    See Also:
    
    addTemplate(String)
  - addToReferences
```
String[] addToReferences(String reference,
                         String nameAttribute)
```
    Add a reference (i.e. footnote) to the internal list
    
    Parameters:
    
    reference - the rendered HTML code of the ref-Tag body
    
    nameAttribute - the value of the name attribute or null
    
    Returns:
    
    the current offset (i.e. size()-1) of the element in the list
  - append
```
void append(BaseToken contentNode)
```
    Append the content as a child on the top node of the internal stack
    
    Parameters:
    
    contentNode -
  - appendExternalImageLink
```
void appendExternalImageLink(String imageSrc,
                             String imageAltText)
```
    Append an external wiki image link (starting with http, https,... and ending with gif, png, jpg, bmp)
    
    Parameters:
    
    imageSrc -
    
    hashSection -
    
    imageAltText -
  - appendExternalLink
```
void appendExternalLink(String uriSchemeName,
                        String link,
                        String linkName,
                        boolean withoutSquareBrackets)
```
    Append an external link (starting with http, https, ftp,...) as described in Help Links
    
    Parameters:
    
    uriSchemeName - the top level URI (Uniform Resource Identifier) scheme name (without the following colon character ":"). Example "ftp", "http", "https". See URI scheme
    
    link - the external link with http://, https:// or ftp:// prefix
    
    linkName - the link name which is separated from the URL by a space
    
    withoutSquareBrackets - if true a link with no square brackets around the link was parsed
  - appendHead
```
ITableOfContent appendHead(String rawHead,
                           int headLevel,
                           boolean noToC,
                           int headCounter,
                           int startPosition,
                           int endPosition)
```
    Add a single wiki head (i.e. ==...==, ===...===, ====...====,...) to the table of content
    
    Parameters:
    
    rawHead - the unparsed header string
    
    headLevel - level of header (i.e. h1, h2, h3, h4, 5h,..)
    
    noToc - don't show the "table of content"
    
    headCounter - the total number of headers parsed
    
    startPosition - the start index in the text where the header line of the section begins
    
    endPosition - the start index in the text where the header line of the section ends
    
    Returns:
    
    the "table of content" tag
  - appendInternalImageLink
```
void appendInternalImageLink(String hrefImageLink,
                             String srcImageLink,
                             ImageFormat imageFormat)
```
    Append this internal wiki image link. In the current implementation some parts of the image rendering are moved to the HTMLConverter#imageNodeToText() method.
    
    Parameters:
    
    hrefImageLink -
    
    srcImageLink -
    
    imageFormat -
  - appendInternalLink
```
void appendInternalLink(String topic,
                        String hashSection,
                        String topicDescription,
                        String cssClass,
                        boolean parseRecursive)
```
    Append an internal wikilink as described in Help Links
    
    Parameters:
    
    topic -
    
    hashSection -
    
    topicDescription -
    
    cssClass - the links CSS class style
    
    parseRecursive - TODO
  - appendInterWikiLink
```
void appendInterWikiLink(String namespace,
                         String title,
                         String linkText)
```
    Append an InterWiki link
    
    Parameters:
    
    namespace -
    
    title -
    
    linkText -
  - appendISBNLink
```
void appendISBNLink(String isbnPureText)
```
    Append an external ISBN link (starting with ISBN ) as described in Wikipedia:ISBN
    
    Note: The default implementation in the AbstractWikiModel class creates a link to Amazon.com.
    
    Parameters:
    
    isbnPureText - the pure ISBN string which contains the ISBN prefix and optional dashes in the ISBN number
  - appendMailtoLink
```
void appendMailtoLink(String link,
                      String linkName,
                      boolean withoutSquareBrackets)
```
    Append an external link (starting with mailto:...) as described in Help:Wikitext#Links
    
    Parameters:
    
    link - the external link with mailto: prefix
    
    linkName - the link name which is separated from the URL by a space
    
    withoutSquareBrackets - if true a mailto link with no square brackets around the link was parsed
  - appendRawNamespaceLinks
```
boolean appendRawNamespaceLinks(String rawNamespaceTopic,
                                String viewableLinkDescription,
                                boolean containsNoPipe)
```
    Check if the topic is a special namespace topic. In the AbstractWikiModel defaults implementation this namespace topic is parsed and checks for various namespaces, like Categories and Interwiki links.
    
    Parameters:
    
    rawNamespaceTopic - the text between the [[...]] square brackets of a wiki link before the pipe symbol
    
    viewableLinkDescription -
    
    containsNoPipe - set to true if the rawLinkText contained no pipe symbol.
    
    Returns:
    
    true if the topic is a special namespace topic
  - appendRawWikipediaLink
```
boolean appendRawWikipediaLink(String rawLinkText,
                               String suffix)
```
    Main entry method for parsing a raw wiki link (i.e. the text between the [[...]] square brackets). In the AbstractWikiModel defaults implementation this link is parsed and the various other append... methods of the model are called for the different cases.
    
    Parameters:
    
    rawLinkText - the text between the [[...]] square brackets of a wiki link
    
    suffix - a String of lowercase letters which directly follow the link after the closing ]] brackets. Useful for topic plurals.
    
    Returns:
    
    true if the method used the suffix for rendering the wiki link. If false the parser should append the suffix as normal text after the wiki link (i.e. in the case of an image of file wiki link).
  - appendRedirectLink
```
boolean appendRedirectLink(String redirectLink)
```
    Append the redirect link to the model
    
    Parameters:
    
    redirectLink - the raw string between the wikilink tags [[ ]]
    
    Returns:
    
    true if the the wikitext shouldn't be parsed
  - appendSignature
```
void appendSignature(Appendable writer,
                     int numberOfTildes)
              throws IOException
```
    Append the user signature to the writer (i.e. '~~~', '~~~~' or '~~~~'). This method is used in the first pass of parsing the wiki text (together with template parsing). You can append a [[User:xxxx]] string according to your model.
    
    Parameters:
    
    writer -
    
    numberOfTildes - an int value between 3 and 5
    
    Throws:
    
    IOException
  - appendStack
```
void appendStack(TagStack stack)
```
    Append the given tag stack to the current tag stack of the model.
    
    Parameters:
    
    stack -
  - buildEditLinkUrl
```
void buildEditLinkUrl(int section)
```
    Build the link to edit a section of the wikipedia article
    
    Parameters:
    
    section -
  - createNewInstance
```
AbstractWikipediaParser createNewInstance(String rawWikitext)
```
    Create a new parser instance
    
    Parameters:
    
    rawWikitext -
    
    Returns:
  - createTableOfContent
```
ITableOfContent createTableOfContent(boolean isTOCIdentifier)
```
    Create the "table of content" placeholder
    
    Parameters:
    
    isTOCIdentifier - true if the __TOC__ keyword was parsed
    
    Returns:
    
    the "table of content" tag
  - decrementRecursionLevel
```
int decrementRecursionLevel()
```
    Decrement the current recursion level of the parser. The recursion level is used to prevent infinite nesting of templates, tables, lists and other parser objects.
    
    Returns:
    
    the decremented recursion level
  - decrementTemplateRecursionLevel
```
int decrementTemplateRecursionLevel()
```
    Decrement the current template recursion level of the temlate parser. The recursion level is used to prevent infinite nesting of templates, tables, lists and other parser objects.
    
    Returns:
    
    the decremented recursion level
  - encodeTitleDotUrl
```
String encodeTitleDotUrl(String wikiTitle,
                         boolean firstCharacterAsUpperCase)
```
    Encode the wiki links title into a URL for HTML hyperlinks (i.e. create the href attribute representation for the a tag). This method uses the '.' character to encode special characters. To get the behavior of the MediaWiki software, which is configured to convert the first letter to upper case, the firstCharacterAsUpperCase parameters must be set to true. For an example encoding routine see: Encoder.encodeTitleDotUrl(String, boolean)
    
    Parameters:
    
    firstCharacterAsUpperCase - if true convert the first of the title to uppercase
    
    See Also:
    
    Encoder.encodeTitleToUrl(String, boolean)
  - encodeTitleToUrl
```
String encodeTitleToUrl(String wikiTitle,
                        boolean firstCharacterAsUpperCase)
```
    Encode the wiki links title into a URL for HTML hyperlinks (i.e. create the href attribute representation for the a tag). This method uses the '%' character to encode special characters. To get the behavior of the MediaWiki software, which is configured to convert the first letter to upper case, the firstCharacterAsUpperCase parameters must be set to true. For an example encoding routine see Encoder.encodeTitleToUrl(String, boolean)
    
    Parameters:
    
    firstCharacterAsUpperCase - if true convert the first of the title to uppercase
    
    See Also:
    
    Encoder.encodeTitleToUrl(String, boolean)
  - getCurrentTimeStamp
```
Date getCurrentTimeStamp()
```
    Get the current time stamp. This is the value for the magic word "CURRENTTIMESTAMP". This method typically returns the value new Date(System.currentTimeMillis());.
    
    Returns:
    
    a date value
  - getImageBaseURL
```
String getImageBaseURL()
```
    Return a URL string which contains a "${image}" variable, which will be replaced by the image name, to create links to images.
    
    Returns:
    
    the wiki images URL
    
    See Also:
    
    getWikiBaseURL(), getWikiBaseEditURL()
  - getLinks
```
Set<String> getLinks()
```
    Get the set of Wikipedia link names
    
    Returns:
    
    the Set of link names 8i.e. [[...]] links)
  - getInterwikiMap
```
InterWikiMap getInterwikiMap()
```
    Get the interwiki links map for converting interwiki links into external URLs. Example: maps the interwiki shortcut "de" to "http://de.wikipedia.org/wiki/$1"
  - getLocale
```
Locale getLocale()
```
    Get the locale of this model.
    
    Returns:
    
    the locale for this model.
  - getNamespace
```
INamespace getNamespace()
```
    Get the namespace of this model.
    
    Returns:
    
    the namespace for this model
  - getNamespaceName
```
String getNamespaceName()
```
    Get the namespace name of this model for the current locale.
    
    Returns:
    
    the namespace in the current locale for this model
  - getNextNumber
```
int getNextNumber()
```
    Get the next unique number
    
    Returns:
    
    the next int number.
  - getNode
```
TagToken getNode(int offset)
```
    Get the node at the given offset on the internal stack For example getNode(fWikiModel.stackSize() - 2) returns the node before the node at top of the stack.
    
    Parameters:
    
    offset -
    
    Returns:
    
    the node at the given offset
  - getFrame
```
Frame getFrame()
```
  - setFrame
```
void setFrame(Frame frame)
```
  - createScribuntoEngine
```
ScribuntoEngine createScribuntoEngine()
```
  - getPageName
```
String getPageName()
```
    Get the title of the current wiki article.
    
    Returns:
  - getRawWikiContent
```
@Nullable
String getRawWikiContent(ParsedPageName templateName,
                                   Map<String,String> templateParameters)
                            throws WikiModelContentException
```
    Get the raw wiki text for the given namespace and article name
    
    Parameters:
    
    templateName - the parsed template name
    
    templateParameters - if the namespace is the Template namespace, the current template parameters are stored as Strings in this map
    
    Returns:
    
    null if no content was found
    
    Throws:
    
    WikiModelContentException
    
    See Also:
    
    AbstractParser#parsePageName(IWikiModel, String, INamespaceValue, boolean)
  - getRecursionLevel
```
int getRecursionLevel()
```
    Get the current recursion level of the parser. The recursion level is used to prevent infinite nesting of templates, tables, lists and other parser objects.
    
    Returns:
    
    the current recursion level counter
  - getRedirectLink
```
String getRedirectLink()
```
    Get the redirect link.
    
    Returns:
    
    the raw string between the wikilink tags [[ ]] or null if no redirect exists
  - getReferences
```
List<Reference> getReferences()
```
    Get the internal list of references (i.e. footnotes)
    
    Returns:
    
    the list of references or null if no reference exists
    
    See Also:
    
    Reference
  - getResourceBundle
```
ResourceBundle getResourceBundle()
```
    Get the resource bundle associated with this model for I18N support
    
    Returns:
    
    the currently used resource bundle for this wiki model
  - getSemanticAttributes
```
List<SemanticAttribute> getSemanticAttributes()
```
    Get the list of SemanticAttributes
    
    Returns:
    
    the list of SemanticAttributes or null if no SemanticAttribute exists
  - getSemanticRelations
```
List<SemanticRelation> getSemanticRelations()
```
    Get the list of SemanticRelations. See Semantic MediaWiki for more information.
    
    Returns:
    
    the list of SemanticRelations or null if no SemanticRelation exists
  - getSimpleDateFormat
```
SimpleDateFormat getSimpleDateFormat()
```
    Get a simple date formatter.
    
    Returns:
    
    a simple date formatter
  - getTableOfContent
```
ITableOfContent getTableOfContent()
```
    Get the parsed "table of content" data after parsing the Wikipedia text.
    
    Returns:
  - getTemplateFunction
```
ITemplateFunction getTemplateFunction(String name)
```
    Get a template parser function (i.e. {{ #if: ... }} ) implementation.
    
    Parameters:
    
    name - the name of the function without the "#" and ":" delimiters
    
    Returns:
    
    the parser function or null if no function is available for the given name
  - getWikiBaseEditURL
```
String getWikiBaseEditURL()
```
    Return a URL string which contains, a "${title}" variable which will be replaced by the topic title, to create links edit pages of wiki topics. For the english Wikipedia this URL would look like:
```
 http://en.wikipedia.org/w/index.php?title=${title}
 
```
    Returns:
    
    the wiki articles edit action URL
    
    See Also:
    
    getWikiBaseURL(), getImageBaseURL()
  - getWikiBaseURL
```
String getWikiBaseURL()
```
    Return a URL string which contains, a "${title}" variable which will be replaced by the topic title, to create links to other wiki topics. For the english Wikipedia this URL would look like:
```
 http://en.wikipedia.org/wiki/${title}
 
```
    Returns:
    
    the wiki articles URL
    
    See Also:
    
    getImageBaseURL(), getWikiBaseEditURL()
  - getWikiListener
```
IEventListener getWikiListener()
```
    Get the current defined wiki listener
    
    Returns:
    
    the wiki listener or null if no listener is defined
  - incrementRecursionLevel
```
int incrementRecursionLevel()
```
    Increment the current recursion level of the parser. The recursion level is used to prevent infinite nesting of templates, tables, lists and other parser objects.
    
    Returns:
    
    the current recursion level counter
  - incrementTemplateRecursionLevel
```
int incrementTemplateRecursionLevel()
```
    Increment the current recursion level of the template parser. The recursion level is used to prevent infinite nesting of templates.
    
    Returns:
    
    the current recursion level counter
  - isCamelCaseEnabled
```
boolean isCamelCaseEnabled()
```
    Checks if CamelCase words should also be used as wiki links.
    
    Returns:
    
    true if CamelCase words should also be used as wiki links
  - isEditorMode
```
boolean isEditorMode()
```
    The current model is used to render a wikipage in editor mode
    
    Returns:
    
    true if your model is used in an editor mode
  - isNoToc
```
boolean isNoToc()
```
    Check if the rendering of the "table of contents" is disabled globally.
    
    Returns:
    
    true if the rendering of the "table of contents" is disabled globally.
  - isInterWiki
```
boolean isInterWiki(String namespace)
```
    Check if the given namespace is an interwiki link prefix.
    
    Parameters:
    
    namespace -
    
    Returns:
    
    true if the namespace is a interwiki namespace (i.e. prefix).
  - isMathtranRenderer
```
boolean isMathtranRenderer()
```
    If the <math> tag should be rendered for the www.mathtran.org service, then return true.
    
    Returns:
    
    true the <math> tag should be rendered fro mathtran.org.
  - isNamespace
```
boolean isNamespace(String namespace)
```
    Check if the given namespace is a namespace in this model
    
    Parameters:
    
    namespace -
    
    Returns:
    
    true if the namespace is a namespace in this model
  - isParameterParsingMode
```
boolean isParameterParsingMode()
```
    The current model currently renders a template parameter value
    
    Returns:
    
    true if your model renders a template parameter value
  - isPreviewMode
```
boolean isPreviewMode()
```
    The current model is used to render a wikipage in preview mode
    
    Returns:
    
    true if your model is used in a preview mode
  - isSemanticWebActive
```
boolean isSemanticWebActive()
```
    Allow the parsing of semantic mediawiki (SMW) links. See Semantic MediaWiki for more information.
    
    Parameters:
    
    namespace -
    
    Returns:
    
    true if parsing of semantic mediawiki (SMW) links is enabled
  - isTemplateTopic
```
boolean isTemplateTopic()
```
    Determine if the currently parsed wiki text is a template.
    
    Returns:
    
    true if the currently parsed wiki text is a template.
  - isValidUriScheme
```
boolean isValidUriScheme(String uriScheme)
```
    Check if the top level URI (Uniform Resource Identifier) scheme name is valid in this model. See URI scheme
    
    Parameters:
    
    uriScheme - the top level URI (Uniform Resource Identifier) scheme name (without the following colon character ":")
    
    Returns:
    
    true if the specified URI scheme is valid.
    
    See Also:
    
    isValidUriSchemeSpecificPart(String, String)
  - isValidUriSchemeSpecificPart
```
boolean isValidUriSchemeSpecificPart(String uriScheme,
                                     String uriSchemeSpecificPart)
```
    Check if the scheme-specific part for a given top level URI (Uniform Resource Identifier) scheme name is valid in this model. See URI scheme
    
    Parameters:
    
    uriScheme - the top level URI (Uniform Resource Identifier) scheme name (without the following colon character ":")
    
    uriSchemeSpecificPart - the URI (Uniform Resource Identifier) scheme part following the top level scheme name and the colon character ":"
    
    Returns:
    
    true if the specified URI scheme is valid.
    
    See Also:
    
    isValidUriScheme(String)
  - parseBehaviorSwitch
```
boolean parseBehaviorSwitch(String identifier)
```
    Parse a behavior switch (i.e. an identifier with two leading and trailing underscores "__" like for example __NOEDITSECTION__ ). See Help :Magic_words#Behavior_switches.
    
    Parameters:
    
    identifier - the identifier without the leading and trailing underscores ("__")
    
    Returns:
    
    true if the switch was parsed
  - parseEvents
```
void parseEvents(IEventListener listener,
                 String rawWikiText)
```
    Parse the raw Wikipedia text and notify the listener
    
    Parameters:
    
    listener - an event listener
    
    rawWikiText - the raw wiki text
  - parseInternalImageLink
```
void parseInternalImageLink(String imageNamespace,
                            String rawImageLink)
```
    Append the internal wiki image link to this model.
    
    See Image markup and see Help:Images.
    
    Parameters:
    
    imageNamespace - the image namespace
    
    rawImageLink - the raw image link text without the surrounding [[...]]
  - parseTemplates
```
String parseTemplates(String rawWikiText)
```
    Parse the templates in a raw wikipedia text into a resulting wikipedia text.
    
    Parameters:
    
    rawWikiText -
    
    Returns:
  - parseTemplates
```
String parseTemplates(String rawWikiText,
                      boolean parseOnlySignature)
```
    Parse the templates in a raw wikipedia text into a resulting wikipedia text.
    
    Parameters:
    
    rawWikiText -
    
    parseOnlySignature - if true parse only the signature wiki texts, no templates and wiki comment parsing
    
    Returns:
  - peekNode
```
TagToken peekNode()
```
    Get the current TagNode on top of the internal stack
    
    Returns:
    
    the current node
  - popNode
```
TagToken popNode()
```
    Pop the current TagNode from top of the internal stack
  - pushNode
```
boolean pushNode(TagToken node)
```
    Push the given TagNode on top of the internal stack
    
    Returns:
    
    true if the push on the internal stack was successful
  - reduceTokenStack
```
void reduceTokenStack(TagToken node)
```
    Reduce the current token stack until an allowed parent is at the top of the stack
  - render
```
String render(ITextConverter converter,
              String rawWikiText)
       throws IOException
```
    Render the raw Wikipedia text into a string for a given converter
    
    Parameters:
    
    converter - a text converter. Note the converter may be null, if you only would like to analyze the raw wiki text and don't need to convert. This speeds up the parsing process.
    
    rawWikiText - a raw wiki text
    
    Throws:
    
    IOException
  - render
```
void render(ITextConverter converter,
            String rawWikiText,
            Appendable buffer,
            boolean templateTopic,
            boolean parseTemplates)
     throws IOException
```
    Render the raw Wikipedia text into a string for a given converter
    
    Parameters:
    
    converter - a text converter. Note the converter may be null, if you only would like to analyze the raw wiki text and don't need to convert. This speeds up the parsing process.
    
    rawWikiText - a raw wiki text
    
    buffer - write to this buffer
    
    templateTopic - if true, render the wiki text as if a template topic will be displayed directly, otherwise render the text as if a common wiki topic will be displayed.
    
    parseTemplates - parses the template expansion step (parses include, onlyinclude, includeonly etc)
    
    Throws:
    
    IOException
  - render
```
String render(ITextConverter converter,
              String rawWikiText,
              boolean templateTopic)
       throws IOException
```
    Render the raw Wikipedia text into a string for a given converter
    
    Parameters:
    
    converter - a text converter. Note the converter may be null, if you only would like to analyze the raw wiki text and don't need to convert. This speeds up the parsing process.
    
    rawWikiText - a raw wiki text
    
    templateTopic - if true, render the wiki text as if a template topic will be displayed directly, otherwise render the text as if a common wiki topic will be displayed.
    
    Returns:
    
    null if an IOException occurs or converter==null
    
    Throws:
    
    IOException
  - render
```
String render(String rawWikiText)
       throws IOException
```
    Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
    
    Throws:
    
    IOException
  - render
```
String render(String rawWikiText,
              boolean templateTopic)
       throws IOException
```
    Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
    
    Parameters:
    
    rawWikiText -
    
    templateTopic - if true, render the wiki text as if a template topic will be displayed directly, otherwise render the text as if a common wiki topic will be displayed.
    
    Throws:
    
    IOException
  - renderPDF
```
String renderPDF(String rawWikiText)
          throws IOException
```
    Render the raw Wikipedia text into an HTML string and use the default PDFConverter. The resulting XHTML could be used as input for the Flying Saucer PDF renderer
    
    Parameters:
    
    rawWikiText -
    
    Returns:
    
    null if an IOException occurs
    
    Throws:
    
    IOException
  - replaceColon
```
boolean replaceColon()
```
    Replace a colon ':' with a slash '/' in wiki names (i.e. links, categories, templates)
    
    Returns:
  - setNamespaceName
```
void setNamespaceName(String namespaceLowercase)
```
    Set the "lower-case" namespace name of the article rendered with this model. This name will be converted with the Namespace#getNamespace() method to a string in the current Locale.
    
    Parameters:
    
    namespaceLowercase - the lowercase key for the namespace.
    
    See Also:
    
    Locale, Namespace.getNamespace(String)
  - setNoToc
```
void setNoToc(boolean disableToc)
```
    Set to true if the rendering of the "table of contents" should be disabled globally.
    
    Parameters:
    
    disableToc - set to true if the rendering of the "table of contents" should be disabled globally.
  - setPageName
```
void setPageName(String pageTitle)
```
    Set the title of the currently rendered page data.
    
    Parameters:
    
    pageTitle -
  - setParameterParsingMode
```
void setParameterParsingMode(boolean parameterParsingMode)
```
    Activate the mode for rendering a template parameter value
  - setSemanticWebActive
```
void setSemanticWebActive(boolean semanticWeb)
```
    Activate the parsing of semantic Mediawiki (SMW) links See Semantic MediaWiki for more information.
  - setUp
```
void setUp()
```
    Prepare or initialize the wiki model before rendering the wikipedia text
  - showSyntax
```
boolean showSyntax(String tagName)
```
    Show the syntax highlighting of the source code
    
    Returns:
  - stackSize
```
int stackSize()
```
    The size of the internal stack
    
    Returns:
  - substituteTemplateCall
```
void substituteTemplateCall(String templateName,
                            Map<String,String> parameterMap,
                            Appendable writer)
                     throws IOException
```
    Substitute the template name by the template content and parameters and append the new content to the writer.
    
    Parameters:
    
    templateName - the name of the template
    
    parameterMap - the templates parameter java.util.SortedMap
    
    writer - the buffer to append the substituted template content
    
    Throws:
    
    IOException
  - swapStack
```
TagStack swapStack(TagStack stack)
```
  - tearDown
```
void tearDown()
```
    Clean up (i.e. free internal resources) in the wiki model after rendering the wikipedia text, if necessary
  - getMagicWord
```
@Nullable
Object getMagicWord(String name)
```
    Gets the magic word object for the given string.
    
    Parameters:
    
    name - the (potential) magic word
    
    Returns:
    
    a magic word object (e.g. MagicWord.MagicWordE in case MagicWord is used) or null if this is no valid magic word
  - splitNsTitle
```
String[] splitNsTitle(String fullTitle)
```
    Splits the given full title into its namespace and page title components and normalises both components using Encoder#normaliseTitle(String, boolean, char) keeping underscores.
    
    Parameters:
    
    fullTitle - the (full) title including a namespace (if present)
    
    Returns:
    
    a 2-element array with the namespace (index 0) and the page title (index 1)

Interface IWikiModel

Nested Class Summary

Nested classes/interfaces inherited from interface info.bliki.wiki.model.IConfiguration

Method Summary

Methods inherited from interface info.bliki.wiki.model.IConfiguration

Method Detail

addCategory

addLink

addSemanticAttribute

addSemanticRelation

addTemplate

addInclude

addToReferences

append

appendExternalImageLink

appendExternalLink

appendHead

appendInternalImageLink

appendInternalLink

appendInterWikiLink

appendISBNLink

appendMailtoLink

appendRawNamespaceLinks

appendRawWikipediaLink

appendRedirectLink

appendSignature

appendStack

buildEditLinkUrl

createNewInstance

createTableOfContent

decrementRecursionLevel

decrementTemplateRecursionLevel

encodeTitleDotUrl

encodeTitleToUrl

getCurrentTimeStamp

getImageBaseURL

getLinks

getInterwikiMap

getLocale

getNamespace

getNamespaceName

getNextNumber

getNode

getFrame

setFrame

createScribuntoEngine

getPageName

getRawWikiContent

getRecursionLevel

getRedirectLink

getReferences

getResourceBundle

getSemanticAttributes

getSemanticRelations

getSimpleDateFormat

getTableOfContent

getTemplateFunction

getWikiBaseEditURL

getWikiBaseURL

getWikiListener

incrementRecursionLevel

incrementTemplateRecursionLevel

isCamelCaseEnabled

isEditorMode

isNoToc

isInterWiki

isMathtranRenderer

isNamespace

isParameterParsingMode

isPreviewMode

isSemanticWebActive

isTemplateTopic

isValidUriScheme

isValidUriSchemeSpecificPart

parseBehaviorSwitch

parseEvents

parseInternalImageLink

parseTemplates

parseTemplates

peekNode