AbstractWikiModel (Bliki (Core) 3.1.1-SNAPSHOT-20170407 API)

java.lang.Object
- info.bliki.wiki.model.AbstractWikiModel

All Implemented Interfaces:

IConfiguration, IContext, IWikiModel

Direct Known Subclasses:

WikiModel
```
public abstract class AbstractWikiModel
extends Object
implements IWikiModel, IContext
```
Standard model implementation for the Wikipedia syntax.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`attributes` Map an attribute name to its value(s).
`protected int`	`fExternalLinksCounter`
`protected Locale`	`fLocale`
`protected INamespace`	`fNamespace`
`protected String`	`fNamespaceName`
`protected boolean`	`fNoToc`
`protected String`	`fPageTitle`
`protected boolean`	`fParameterParsingMode`
`protected int`	`fRecursionLevel`
`protected String`	`fRedirectLink`
`protected Map<String,Integer>`	`fReferenceNames`
`protected ArrayList<Reference>`	`fReferences`
`protected int`	`fSectionCounter`
`protected TagStack`	`fTagStack`
`protected int`	`fTemplateRecursionCount`
`protected Map<String,Counter>`	`fTemplates`
`protected boolean`	`fTemplateTopic`
`protected HashSet<String>`	`fToCSet` Contains all anchor strings to create unique anchors
`protected org.slf4j.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description
`AbstractWikiModel()`
`AbstractWikiModel(Configuration configuration)`
`AbstractWikiModel(Configuration configuration, Locale locale)`
`AbstractWikiModel(Configuration configuration, Locale locale, INamespace namespace)`

Method Summary

All Methods Instance Methods Concrete 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.
`SourceCodeFormatter`	`addCodeFormatter(String key, SourceCodeFormatter value)` Add a new source code formatter to the configuration
`void`	`addInclude(String pageName)` When a document contains a token indicating that the document includes an other Wiki page, i.e.
`String`	`addInterwikiLink(String key, String value)` Add another Interwiki link to the configuration.
`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.
`ITemplateFunction`	`addTemplateFunction(String key, ITemplateFunction value)` Add a new interwiki link to the configuration
`TagToken`	`addTokenTag(String key, TagToken value)` Add a new HTML styled tag to the configuration
`String[]`	`addToReferences(String reference, String nameAttribute)` Add a reference (i.e.
`protected void`	`addToTableOfContent(List<Object> toc, SectionHeader strPair, int headLevel)` Add a section header with the given `headLevel` to the "table of content"
`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,...
`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)` Append a new head 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.
`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.
`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
`IConfiguration.Casing`	`casing()`
`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.
`Object`	`getAttribute(String attribute)` Resolve an attribute reference.
`AttributeRenderer`	`getAttributeRenderer(Class<?> attributeClassType)` What renderer is registered for this attributeClassType for this template.
`Map<String,SourceCodeFormatter>`	`getCodeFormatterMap()` Get the source code formatter map of built-in source code formatters
`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.
`Locale`	`getLocale()` Get the locale of this model.
`MagicWord.MagicWordE`	`getMagicWord(String name)` Gets the magic word object for the given string.
`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 parsedPagename, 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.
`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.
`Map<String,String>`	`getTemplateCallsCache()` Get the currently configured cache implementation for template calls.
`ITemplateFunction`	`getTemplateFunction(String name)` Get a template parser function (i.e.
`Map<String,ITemplateFunction>`	`getTemplateMap()` Get the template parser functions map of built-in template functions
`Map<String,TagToken>`	`getTokenMap()` Get the HTML styled tag map for built-in tags
`Set<String>`	`getUriSchemeSet()` Get the set of all allowed URI scheme shortcuts like http, https, ftp,...
`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.
`protected void`	`initialize()`
`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.
`void`	`parseEvents(IEventListener listener, String rawWikiText)` Parse the raw Wikipedia text and notify the listener
`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
`protected void`	`rawSetAttribute(Map<String,Object> attributes, String name, Object value)` Map a value to a named attribute.
`void`	`reduceTokenStack(TagToken node)` Reduce the current token stack until an allowed parent is at the top of the stack
`void`	`registerRenderer(Class<?> attributeClassType, AttributeRenderer renderer)` Register a renderer for all objects of a particular type.
`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 buf, 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.
`void`	`setAttribute(String name, Object value)` Set an attribute for this template.
`void`	`setAttributeRenderers(Map<Class<?>,Object> renderers)` Specify a complete map of what object classes should map to which renderer objects.
`protected void`	`setDefaultThumbWidth(ImageFormat imageFormat)` Set the default thumb format width.
`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`	`setTemplateCallsCache(Map<String,String> map)` Set a cache map implementation.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.bliki.wiki.model.IWikiModel
getCategories, getLinks, getNamespace, parseInternalImageLink

- Field Detail
  - logger
```
protected org.slf4j.Logger logger
```
  - fReferences
```
protected ArrayList<Reference> fReferences
```
  - fReferenceNames
```
protected Map<String,Integer> fReferenceNames
```
  - fRecursionLevel
```
protected int fRecursionLevel
```
  - fTemplateRecursionCount
```
protected int fTemplateRecursionCount
```
  - fTagStack
```
protected TagStack fTagStack
```
  - fLocale
```
protected Locale fLocale
```
  - fNamespace
```
protected final INamespace fNamespace
```
  - fRedirectLink
```
protected String fRedirectLink
```
  - fPageTitle
```
protected String fPageTitle
```
  - fNamespaceName
```
protected String fNamespaceName
```
  - fSectionCounter
```
protected int fSectionCounter
```
  - fTemplateTopic
```
protected boolean fTemplateTopic
```
  - fParameterParsingMode
```
protected boolean fParameterParsingMode
```
  - fNoToc
```
protected boolean fNoToc
```
  - fExternalLinksCounter
```
protected int fExternalLinksCounter
```
  - fToCSet
```
protected HashSet<String> fToCSet
```
    Contains all anchor strings to create unique anchors
  - attributes
```
protected Map<String,Object> attributes
```
    Map an attribute name to its value(s). These values are set by outside code via st.setAttribute(name, value). StringTemplate is like self in that a template is both the "class def" and "instance". When you create a StringTemplate or setTemplate, the text is broken up into chunks (i.e., compiled down into a series of chunks that can be evaluated later). You can have multiple
  - fTemplates
```
protected Map<String,Counter> fTemplates
```
- Constructor Detail
  - AbstractWikiModel
```
public AbstractWikiModel()
```
  - AbstractWikiModel
```
public AbstractWikiModel(Configuration configuration)
```
  - AbstractWikiModel
```
public AbstractWikiModel(Configuration configuration,
                         Locale locale)
```
  - AbstractWikiModel
```
public AbstractWikiModel(Configuration configuration,
                         Locale locale,
                         INamespace namespace)
```
- Method Detail
  - addCategory
```
public void addCategory(String categoryName,
                        String sortKey)
```
    Description copied from interface: IWikiModel
    
    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
    
    Specified by:
    
    addCategory in interface IWikiModel
    
    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".
  - addCodeFormatter
```
public SourceCodeFormatter addCodeFormatter(String key,
                                            SourceCodeFormatter value)
```
    Description copied from interface: IConfiguration
    
    Add a new source code formatter to the configuration
    
    Specified by:
    
    addCodeFormatter in interface IConfiguration
  - addInterwikiLink
```
public String addInterwikiLink(String key,
                               String value)
```
    Description copied from interface: IConfiguration
    
    Add another Interwiki link to the configuration. The value string must contain the $1 placeholder for the used wiki article link.
    
    Specified by:
    
    addInterwikiLink in interface IConfiguration
    
    Parameters:
    
    key - the prefix used in the interwiki link (i.e. [[prefix:...]] )
    
    value - the external link which should be generated from the interwiki link
  - addLink
```
public void addLink(String topicName)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    addLink in interface IWikiModel
    
    Parameters:
    
    topicName - The name of the topic that is linked to.
  - addSemanticAttribute
```
public boolean addSemanticAttribute(String attribute,
                                    String attributeValue)
```
    Description copied from interface: IWikiModel
    
    See Semantic MediaWiki for more information.
    
    Specified by:
    
    addSemanticAttribute in interface IWikiModel
    
    Returns:
  - addSemanticRelation
```
public boolean addSemanticRelation(String relation,
                                   String relationValue)
```
    Description copied from interface: IWikiModel
    
    See Semantic MediaWiki for more information.
    
    Specified by:
    
    addSemanticRelation in interface IWikiModel
    
    Returns:
  - addTemplate
```
public void addTemplate(String template)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    addTemplate in interface IWikiModel
    
    Parameters:
    
    template - The name of the template that is being included (excluding the template namespace).
  - addInclude
```
public void addInclude(String pageName)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    addInclude in interface IWikiModel
    
    Parameters:
    
    pageName - The name of the page that is being included (including its namespace).
    
    See Also:
    
    IWikiModel.addTemplate(String)
  - addTemplateFunction
```
public ITemplateFunction addTemplateFunction(String key,
                                             ITemplateFunction value)
```
    Description copied from interface: IConfiguration
    
    Add a new interwiki link to the configuration
    
    Specified by:
    
    addTemplateFunction in interface IConfiguration
  - addTokenTag
```
public TagToken addTokenTag(String key,
                            TagToken value)
```
    Description copied from interface: IConfiguration
    
    Add a new HTML styled tag to the configuration
    
    Specified by:
    
    addTokenTag in interface IConfiguration
  - addToReferences
```
public String[] addToReferences(String reference,
                                String nameAttribute)
```
    Description copied from interface: IWikiModel
    
    Add a reference (i.e. footnote) to the internal list
    
    Specified by:
    
    addToReferences in interface IWikiModel
    
    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
  - addToTableOfContent
```
protected void addToTableOfContent(List<Object> toc,
                                   SectionHeader strPair,
                                   int headLevel)
```
    Add a section header with the given headLevel to the "table of content"
    
    Parameters:
    
    toc - the "table of content list"
    
    strPair - a new section header
    
    headLevel - the level of the new section header
  - append
```
public void append(BaseToken contentNode)
```
    Description copied from interface: IWikiModel
    
    Append the content as a child on the top node of the internal stack
    
    Specified by:
    
    append in interface IWikiModel
  - appendExternalImageLink
```
public void appendExternalImageLink(String imageSrc,
                                    String imageAltText)
```
    Description copied from interface: IWikiModel
    
    Append an external wiki image link (starting with http, https,... and ending with gif, png, jpg, bmp)
    
    Specified by:
    
    appendExternalImageLink in interface IWikiModel
  - appendExternalLink
```
public void appendExternalLink(String uriSchemeName,
                               String link,
                               String linkName,
                               boolean withoutSquareBrackets)
```
    Append an external link (starting with http, https, ftp,...) as described in Help Links
    
    Specified by:
    
    appendExternalLink in interface IWikiModel
    
    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 https://, 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
```
public ITableOfContent appendHead(String rawHead,
                                  int headLevel,
                                  boolean noToC,
                                  int headCounter,
                                  int startPosition,
                                  int endPosition)
```
    Append a new head to the table of content
    
    Specified by:
    
    appendHead in interface IWikiModel
    
    Parameters:
    
    rawHead - the unparsed header string
    
    headLevel - level of header (i.e. h1, h2, h3, h4, 5h,..)
    
    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
```
public void appendInternalImageLink(String hrefImageLink,
                                    String srcImageLink,
                                    ImageFormat imageFormat)
```
    Description copied from interface: IWikiModel
    
    Append this internal wiki image link. In the current implementation some parts of the image rendering are moved to the HTMLConverter#imageNodeToText() method.
    
    Specified by:
    
    appendInternalImageLink in interface IWikiModel
  - setDefaultThumbWidth
```
protected void setDefaultThumbWidth(ImageFormat imageFormat)
```
    Set the default thumb format width. This method sets a "default width" (220px) for images of type "thumb", if no width is set in the image format string.
  - appendInternalLink
```
public void appendInternalLink(String topic,
                               String hashSection,
                               String topicDescription,
                               String cssClass,
                               boolean parseRecursive)
```
    Description copied from interface: IWikiModel
    
    Append an internal wikilink as described in Help Links
    
    Specified by:
    
    appendInternalLink in interface IWikiModel
    
    cssClass - the links CSS class style
    
    parseRecursive - TODO
  - appendInterWikiLink
```
public void appendInterWikiLink(String namespace,
                                String title,
                                String linkText)
```
    Description copied from interface: IWikiModel
    
    Append an InterWiki link
    
    Specified by:
    
    appendInterWikiLink in interface IWikiModel
  - appendISBNLink
```
public void appendISBNLink(String isbnPureText)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    appendISBNLink in interface IWikiModel
    
    Parameters:
    
    isbnPureText - the pure ISBN string which contains the ISBN prefix and optional dashes in the ISBN number
  - appendMailtoLink
```
public void appendMailtoLink(String link,
                             String linkName,
                             boolean withoutSquareBrackets)
```
    Description copied from interface: IWikiModel
    
    Append an external link (starting with mailto:...) as described in Help:Wikitext#Links
    
    Specified by:
    
    appendMailtoLink in interface IWikiModel
    
    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
```
public boolean appendRawNamespaceLinks(String rawNamespaceTopic,
                                       String viewableLinkDescription,
                                       boolean containsNoPipe)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    appendRawNamespaceLinks in interface IWikiModel
    
    Parameters:
    
    rawNamespaceTopic - the text between the [[...]] square brackets of a wiki link before the pipe symbol
    
    containsNoPipe - set to true if the rawLinkText contained no pipe symbol.
    
    Returns:
    
    true if the topic is a special namespace topic
  - appendRawWikipediaLink
```
public boolean appendRawWikipediaLink(String rawLinkText,
                                      String suffix)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    appendRawWikipediaLink in interface IWikiModel
    
    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
```
public boolean appendRedirectLink(String redirectLink)
```
    Description copied from interface: IWikiModel
    
    Append the redirect link to the model
    
    Specified by:
    
    appendRedirectLink in interface IWikiModel
    
    Parameters:
    
    redirectLink - the raw string between the wikilink tags [[ ]]
    
    Returns:
    
    true if the the wikitext shouldn't be parsed
  - appendSignature
```
public void appendSignature(Appendable writer,
                            int numberOfTildes)
                     throws IOException
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    appendSignature in interface IWikiModel
    
    numberOfTildes - an int value between 3 and 5
    
    Throws:
    
    IOException
  - appendStack
```
public void appendStack(TagStack stack)
```
    Description copied from interface: IWikiModel
    
    Append the given tag stack to the current tag stack of the model.
    
    Specified by:
    
    appendStack in interface IWikiModel
  - buildEditLinkUrl
```
public void buildEditLinkUrl(int section)
```
    Description copied from interface: IWikiModel
    
    Build the link to edit a section of the wikipedia article
    
    Specified by:
    
    buildEditLinkUrl in interface IWikiModel
  - createNewInstance
```
public AbstractWikipediaParser createNewInstance(String rawWikitext)
```
    Description copied from interface: IWikiModel
    
    Create a new parser instance
    
    Specified by:
    
    createNewInstance in interface IWikiModel
    
    Returns:
  - createTableOfContent
```
public ITableOfContent createTableOfContent(boolean isTOCIdentifier)
```
    Description copied from interface: IWikiModel
    
    Create the "table of content" placeholder
    
    Specified by:
    
    createTableOfContent in interface IWikiModel
    
    Parameters:
    
    isTOCIdentifier - true if the __TOC__ keyword was parsed
    
    Returns:
    
    the "table of content" tag
  - decrementRecursionLevel
```
public int decrementRecursionLevel()
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    decrementRecursionLevel in interface IWikiModel
    
    Returns:
    
    the decremented recursion level
  - decrementTemplateRecursionLevel
```
public int decrementTemplateRecursionLevel()
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    decrementTemplateRecursionLevel in interface IWikiModel
    
    Returns:
    
    the decremented recursion level
  - encodeTitleDotUrl
```
public String encodeTitleDotUrl(String wikiTitle,
                                boolean firstCharacterAsUpperCase)
```
    Description copied from interface: IWikiModel
    
    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)
    
    Specified by:
    
    encodeTitleDotUrl in interface IWikiModel
    
    firstCharacterAsUpperCase - if true convert the first of the title to uppercase
    
    See Also:
    
    Encoder.encodeTitleToUrl(String, boolean)
  - encodeTitleToUrl
```
public String encodeTitleToUrl(String wikiTitle,
                               boolean firstCharacterAsUpperCase)
```
    Description copied from interface: IWikiModel
    
    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)
    
    Specified by:
    
    encodeTitleToUrl in interface IWikiModel
    
    firstCharacterAsUpperCase - if true convert the first of the title to uppercase
    
    See Also:
    
    Encoder.encodeTitleToUrl(String, boolean)
  - getAttribute
```
public Object getAttribute(String attribute)
```
    Resolve an attribute reference. It can be in four possible places: 1. the attribute list for the current template 2. if self is an embedded template, somebody invoked us possibly with arguments--check the argument context 3. if self is an embedded template, the attribute list for the enclosing instance (recursively up the enclosing instance chain) 4. if nothing is found in the enclosing instance chain, then it might be a map defined in the group or the its supergroup etc... Attribute references are checked for validity. If an attribute has a value, its validity was checked before template rendering. If the attribute has no value, then we must check to ensure it is a valid reference. Somebody could reference any random value like $xyz$; formal arg checks before rendering cannot detect this--only the ref can initiate a validity check. So, if no value, walk up the enclosed template tree again, this time checking formal parameters not attributes Map. The formal definition must exist even if no value. To avoid infinite recursion in toString(), we have another condition to check regarding attribute values. If your template has a formal argument, foo, then foo will hide any value available from "above" in order to prevent infinite recursion. This method is not static so people can override functionality.
    
    Specified by:
    
    getAttribute in interface IContext
  - getAttributeRenderer
```
public AttributeRenderer getAttributeRenderer(Class<?> attributeClassType)
```
    What renderer is registered for this attributeClassType for this template. If not found, the template's group is queried.
    
    Specified by:
    
    getAttributeRenderer in interface IContext
  - getCodeFormatterMap
```
public Map<String,SourceCodeFormatter> getCodeFormatterMap()
```
    Description copied from interface: IConfiguration
    
    Get the source code formatter map of built-in source code formatters
    
    Specified by:
    
    getCodeFormatterMap in interface IConfiguration
  - getCurrentTimeStamp
```
public Date getCurrentTimeStamp()
```
    Description copied from interface: IWikiModel
    
    Get the current time stamp. This is the value for the magic word "CURRENTTIMESTAMP". This method typically returns the value new Date(System.currentTimeMillis());.
    
    Specified by:
    
    getCurrentTimeStamp in interface IWikiModel
    
    Returns:
    
    a date value
  - getInterwikiMap
```
public InterWikiMap getInterwikiMap()
```
    Description copied from interface: IWikiModel
    
    Get the interwiki links map for converting interwiki links into external URLs. Example: maps the interwiki shortcut "de" to "https://de.wikipedia.org/wiki/$1"
    
    Specified by:
    
    getInterwikiMap in interface IWikiModel
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: IWikiModel
    
    Get the locale of this model.
    
    Specified by:
    
    getLocale in interface IWikiModel
    
    Returns:
    
    the locale for this model.
  - getNextNumber
```
public int getNextNumber()
```
    Description copied from interface: IWikiModel
    
    Get the next unique number
    
    Specified by:
    
    getNextNumber in interface IWikiModel
    
    Returns:
    
    the next int number.
  - getNode
```
public TagToken getNode(int offset)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    getNode in interface IWikiModel
    
    Returns:
    
    the node at the given offset
  - getPageName
```
public String getPageName()
```
    Description copied from interface: IWikiModel
    
    Get the title of the current wiki article.
    
    Specified by:
    
    getPageName in interface IWikiModel
    
    Returns:
  - getMagicWord
```
public MagicWord.MagicWordE getMagicWord(String name)
```
    Description copied from interface: IWikiModel
    
    Gets the magic word object for the given string.
    
    Specified by:
    
    getMagicWord in interface IWikiModel
    
    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
  - getRawWikiContent
```
public String getRawWikiContent(ParsedPageName parsedPagename,
                                Map<String,String> templateParameters)
                         throws WikiModelContentException
```
    Description copied from interface: IWikiModel
    
    Get the raw wiki text for the given namespace and article name
    
    Specified by:
    
    getRawWikiContent in interface IWikiModel
    
    Parameters:
    
    parsedPagename - 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
```
public int getRecursionLevel()
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    getRecursionLevel in interface IWikiModel
    
    Returns:
    
    the current recursion level counter
  - getRedirectLink
```
public String getRedirectLink()
```
    Description copied from interface: IWikiModel
    
    Get the redirect link.
    
    Specified by:
    
    getRedirectLink in interface IWikiModel
    
    Returns:
    
    the raw string between the wikilink tags [[ ]] or null if no redirect exists
  - getReferences
```
public List<Reference> getReferences()
```
    Description copied from interface: IWikiModel
    
    Get the internal list of references (i.e. footnotes)
    
    Specified by:
    
    getReferences in interface IWikiModel
    
    Returns:
    
    the list of references or null if no reference exists
    
    See Also:
    
    Reference
  - getResourceBundle
```
public ResourceBundle getResourceBundle()
```
    Description copied from interface: IWikiModel
    
    Get the resource bundle associated with this model for I18N support
    
    Specified by:
    
    getResourceBundle in interface IWikiModel
    
    Returns:
    
    the currently used resource bundle for this wiki model
  - getSemanticAttributes
```
public List<SemanticAttribute> getSemanticAttributes()
```
    Description copied from interface: IWikiModel
    
    Get the list of SemanticAttributes
    
    Specified by:
    
    getSemanticAttributes in interface IWikiModel
    
    Returns:
    
    the list of SemanticAttributes or null if no SemanticAttribute exists
  - getSemanticRelations
```
public List<SemanticRelation> getSemanticRelations()
```
    Description copied from interface: IWikiModel
    
    Get the list of SemanticRelations. See Semantic MediaWiki for more information.
    
    Specified by:
    
    getSemanticRelations in interface IWikiModel
    
    Returns:
    
    the list of SemanticRelations or null if no SemanticRelation exists
  - getSimpleDateFormat
```
public SimpleDateFormat getSimpleDateFormat()
```
    Description copied from interface: IWikiModel
    
    Get a simple date formatter.
    
    Specified by:
    
    getSimpleDateFormat in interface IWikiModel
    
    Returns:
    
    a simple date formatter
  - getTableOfContent
```
public ITableOfContent getTableOfContent()
```
    Description copied from interface: IWikiModel
    
    Get the parsed "table of content" data after parsing the Wikipedia text.
    
    Specified by:
    
    getTableOfContent in interface IWikiModel
    
    Returns:
  - getTemplateCallsCache
```
public Map<String,String> getTemplateCallsCache()
```
    Description copied from interface: IConfiguration
    
    Get the currently configured cache implementation for template calls.
    
    Specified by:
    
    getTemplateCallsCache in interface IConfiguration
    
    Returns:
    
    null if no cache implementation is set.
    
    See Also:
    
    IConfiguration.setTemplateCallsCache(Map)
  - getTemplateFunction
```
public ITemplateFunction getTemplateFunction(String name)
```
    Description copied from interface: IWikiModel
    
    Get a template parser function (i.e. {{ #if: ... }} ) implementation.
    
    Specified by:
    
    getTemplateFunction in interface IWikiModel
    
    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
  - getTemplateMap
```
public Map<String,ITemplateFunction> getTemplateMap()
```
    Description copied from interface: IConfiguration
    
    Get the template parser functions map of built-in template functions
    
    Specified by:
    
    getTemplateMap in interface IConfiguration
  - getTokenMap
```
public Map<String,TagToken> getTokenMap()
```
    Description copied from interface: IConfiguration
    
    Get the HTML styled tag map for built-in tags
    
    Specified by:
    
    getTokenMap in interface IConfiguration
  - getUriSchemeSet
```
public Set<String> getUriSchemeSet()
```
    Description copied from interface: IConfiguration
    
    Get the set of all allowed URI scheme shortcuts like http, https, ftp,... See URI scheme
    
    Specified by:
    
    getUriSchemeSet in interface IConfiguration
  - casing
```
public IConfiguration.Casing casing()
```
    Specified by:
    
    casing in interface IConfiguration
    
    Returns:
    
    the default casing, defaults to IConfiguration.Casing.FirstLetter.
  - getWikiListener
```
public IEventListener getWikiListener()
```
    Description copied from interface: IWikiModel
    
    Get the current defined wiki listener
    
    Specified by:
    
    getWikiListener in interface IWikiModel
    
    Returns:
    
    the wiki listener or null if no listener is defined
  - incrementRecursionLevel
```
public int incrementRecursionLevel()
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    incrementRecursionLevel in interface IWikiModel
    
    Returns:
    
    the current recursion level counter
  - incrementTemplateRecursionLevel
```
public int incrementTemplateRecursionLevel()
```
    Description copied from interface: IWikiModel
    
    Increment the current recursion level of the template parser. The recursion level is used to prevent infinite nesting of templates.
    
    Specified by:
    
    incrementTemplateRecursionLevel in interface IWikiModel
    
    Returns:
    
    the current recursion level counter
  - initialize
```
protected void initialize()
```
  - isCamelCaseEnabled
```
public boolean isCamelCaseEnabled()
```
    Description copied from interface: IWikiModel
    
    Checks if CamelCase words should also be used as wiki links.
    
    Specified by:
    
    isCamelCaseEnabled in interface IWikiModel
    
    Returns:
    
    true if CamelCase words should also be used as wiki links
  - isEditorMode
```
public boolean isEditorMode()
```
    Description copied from interface: IWikiModel
    
    The current model is used to render a wikipage in editor mode
    
    Specified by:
    
    isEditorMode in interface IWikiModel
    
    Returns:
    
    true if your model is used in an editor mode
  - isInterWiki
```
public boolean isInterWiki(String namespace)
```
    Description copied from interface: IWikiModel
    
    Check if the given namespace is an interwiki link prefix.
    
    Specified by:
    
    isInterWiki in interface IWikiModel
    
    Returns:
    
    true if the namespace is a interwiki namespace (i.e. prefix).
  - isMathtranRenderer
```
public boolean isMathtranRenderer()
```
    Description copied from interface: IWikiModel
    
    If the <math> tag should be rendered for the www.mathtran.org service, then return true.
    
    Specified by:
    
    isMathtranRenderer in interface IWikiModel
    
    Returns:
    
    true the <math> tag should be rendered fro mathtran.org.
  - isNamespace
```
public boolean isNamespace(String namespace)
```
    Description copied from interface: IWikiModel
    
    Check if the given namespace is a namespace in this model
    
    Specified by:
    
    isNamespace in interface IWikiModel
    
    Returns:
    
    true if the namespace is a namespace in this model
  - isNoToc
```
public boolean isNoToc()
```
    Description copied from interface: IWikiModel
    
    Check if the rendering of the "table of contents" is disabled globally.
    
    Specified by:
    
    isNoToc in interface IWikiModel
    
    Returns:
    
    true if the rendering of the "table of contents" is disabled globally.
  - isParameterParsingMode
```
public boolean isParameterParsingMode()
```
    Description copied from interface: IWikiModel
    
    The current model currently renders a template parameter value
    
    Specified by:
    
    isParameterParsingMode in interface IWikiModel
    
    Returns:
    
    true if your model renders a template parameter value
  - isPreviewMode
```
public boolean isPreviewMode()
```
    Description copied from interface: IWikiModel
    
    The current model is used to render a wikipage in preview mode
    
    Specified by:
    
    isPreviewMode in interface IWikiModel
    
    Returns:
    
    true if your model is used in a preview mode
  - isSemanticWebActive
```
public boolean isSemanticWebActive()
```
    Description copied from interface: IWikiModel
    
    Allow the parsing of semantic mediawiki (SMW) links. See Semantic MediaWiki for more information.
    
    Specified by:
    
    isSemanticWebActive in interface IWikiModel
    
    Returns:
    
    true if parsing of semantic mediawiki (SMW) links is enabled
  - isTemplateTopic
```
public boolean isTemplateTopic()
```
    Description copied from interface: IWikiModel
    
    Determine if the currently parsed wiki text is a template.
    
    Specified by:
    
    isTemplateTopic in interface IWikiModel
    
    Returns:
    
    true if the currently parsed wiki text is a template.
  - isValidUriScheme
```
public boolean isValidUriScheme(String uriScheme)
```
    Description copied from interface: IWikiModel
    
    Check if the top level URI (Uniform Resource Identifier) scheme name is valid in this model. See URI scheme
    
    Specified by:
    
    isValidUriScheme in interface IWikiModel
    
    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:
    
    IWikiModel.isValidUriSchemeSpecificPart(String, String)
  - isValidUriSchemeSpecificPart
```
public boolean isValidUriSchemeSpecificPart(String uriScheme,
                                            String uriSchemeSpecificPart)
```
    Description copied from interface: IWikiModel
    
    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
    
    Specified by:
    
    isValidUriSchemeSpecificPart in interface IWikiModel
    
    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:
    
    IWikiModel.isValidUriScheme(String)
  - parseBehaviorSwitch
```
public boolean parseBehaviorSwitch(String identifier)
```
    Description copied from interface: IWikiModel
    
    Parse a behavior switch (i.e. an identifier with two leading and trailing underscores "__" like for example __NOEDITSECTION__ ). See Help :Magic_words#Behavior_switches.
    
    Specified by:
    
    parseBehaviorSwitch in interface IWikiModel
    
    Parameters:
    
    identifier - the identifier without the leading and trailing underscores ("__")
    
    Returns:
    
    true if the switch was parsed
  - parseEvents
```
public void parseEvents(IEventListener listener,
                        String rawWikiText)
```
    Description copied from interface: IWikiModel
    
    Parse the raw Wikipedia text and notify the listener
    
    Specified by:
    
    parseEvents in interface IWikiModel
    
    Parameters:
    
    listener - an event listener
    
    rawWikiText - the raw wiki text
  - parseTemplates
```
public String parseTemplates(String rawWikiText)
```
    Description copied from interface: IWikiModel
    
    Parse the templates in a raw wikipedia text into a resulting wikipedia text.
    
    Specified by:
    
    parseTemplates in interface IWikiModel
    
    Returns:
  - parseTemplates
```
public String parseTemplates(String rawWikiText,
                             boolean parseOnlySignature)
```
    Description copied from interface: IWikiModel
    
    Parse the templates in a raw wikipedia text into a resulting wikipedia text.
    
    Specified by:
    
    parseTemplates in interface IWikiModel
    
    parseOnlySignature - if true parse only the signature wiki texts, no templates and wiki comment parsing
    
    Returns:
  - peekNode
```
public TagToken peekNode()
```
    Description copied from interface: IWikiModel
    
    Get the current TagNode on top of the internal stack
    
    Specified by:
    
    peekNode in interface IWikiModel
    
    Returns:
    
    the current node
  - popNode
```
public TagToken popNode()
```
    Description copied from interface: IWikiModel
    
    Pop the current TagNode from top of the internal stack
    
    Specified by:
    
    popNode in interface IWikiModel
  - pushNode
```
public boolean pushNode(TagToken node)
```
    Description copied from interface: IWikiModel
    
    Push the given TagNode on top of the internal stack
    
    Specified by:
    
    pushNode in interface IWikiModel
    
    Returns:
    
    true if the push on the internal stack was successful
  - rawSetAttribute
```
protected void rawSetAttribute(Map<String,Object> attributes,
                               String name,
                               Object value)
```
    Map a value to a named attribute. Throw NoSuchElementException if the named attribute is not formally defined in self's specific template and a formal argument list exists.
  - registerRenderer
```
public void registerRenderer(Class<?> attributeClassType,
                             AttributeRenderer renderer)
```
    Register a renderer for all objects of a particular type. This overrides any renderer set in the group for this class type.
    
    Specified by:
    
    registerRenderer in interface IContext
  - render
```
public String render(ITextConverter converter,
                     String rawWikiText)
              throws IOException
```
    Description copied from interface: IWikiModel
    
    Render the raw Wikipedia text into a string for a given converter
    
    Specified by:
    
    render in interface IWikiModel
    
    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
```
public String render(ITextConverter converter,
                     String rawWikiText,
                     boolean templateTopic)
              throws IOException
```
    Description copied from interface: IWikiModel
    
    Render the raw Wikipedia text into a string for a given converter
    
    Specified by:
    
    render in interface IWikiModel
    
    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
```
public void render(ITextConverter converter,
                   String rawWikiText,
                   Appendable buf,
                   boolean templateTopic,
                   boolean parseTemplates)
            throws IOException
```
    Description copied from interface: IWikiModel
    
    Render the raw Wikipedia text into a string for a given converter
    
    Specified by:
    
    render in interface IWikiModel
    
    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
    
    buf - 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
```
public String render(String rawWikiText)
              throws IOException
```
    Description copied from interface: IWikiModel
    
    Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
    
    Specified by:
    
    render in interface IWikiModel
    
    Throws:
    
    IOException
  - render
```
public String render(String rawWikiText,
                     boolean templateTopic)
              throws IOException
```
    Description copied from interface: IWikiModel
    
    Render the raw Wikipedia text into an HTML string and use the default HTMLConverter
    
    Specified by:
    
    render in interface IWikiModel
    
    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
```
public String renderPDF(String rawWikiText)
                 throws IOException
```
    Description copied from interface: IWikiModel
    
    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
    
    Specified by:
    
    renderPDF in interface IWikiModel
    
    Returns:
    
    null if an IOException occurs
    
    Throws:
    
    IOException
  - replaceColon
```
public boolean replaceColon()
```
    Description copied from interface: IWikiModel
    
    Replace a colon ':' with a slash '/' in wiki names (i.e. links, categories, templates)
    
    Specified by:
    
    replaceColon in interface IWikiModel
    
    Returns:
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    Set an attribute for this template. If you set the same attribute more than once, you get a multi-valued attribute. If you send in a StringTemplate object as a value, it's enclosing instance (where it will inherit values from) is set to 'this'. This would be the normal case, though you can set it back to null after this call if you want. If you send in a List plus other values to the same attribute, they all get flattened into one List of values. This will be a new list object so that incoming objects are not altered. If you send in an array, it is converted to an ArrayIterator.
    
    Specified by:
    
    setAttribute in interface IContext
  - setAttributeRenderers
```
public void setAttributeRenderers(Map<Class<?>,Object> renderers)
```
    Specify a complete map of what object classes should map to which renderer objects.
  - setPageName
```
public void setPageName(String pageTitle)
```
    Description copied from interface: IWikiModel
    
    Set the title of the currently rendered page data.
    
    Specified by:
    
    setPageName in interface IWikiModel
  - setParameterParsingMode
```
public void setParameterParsingMode(boolean parameterParsingMode)
```
    Description copied from interface: IWikiModel
    
    Activate the mode for rendering a template parameter value
    
    Specified by:
    
    setParameterParsingMode in interface IWikiModel
  - setSemanticWebActive
```
public void setSemanticWebActive(boolean semanticWeb)
```
    Description copied from interface: IWikiModel
    
    Activate the parsing of semantic Mediawiki (SMW) links See Semantic MediaWiki for more information.
    
    Specified by:
    
    setSemanticWebActive in interface IWikiModel
  - setTemplateCallsCache
```
public void setTemplateCallsCache(Map<String,String> map)
```
    Description copied from interface: IConfiguration
    
    Set a cache map implementation. For example based on JSR 107. Template calls which use the same parameters over and over again do lookup this cache and use the preparsed result if available. Note: don't use a simple java.util.HashMap implementation because it's not thread-safe an grows infinitly.
    
    Specified by:
    
    setTemplateCallsCache in interface IConfiguration
    
    Parameters:
    
    map - the cache implementation
  - setUp
```
public void setUp()
```
    Description copied from interface: IWikiModel
    
    Prepare or initialize the wiki model before rendering the wikipedia text
    
    Specified by:
    
    setUp in interface IWikiModel
  - showSyntax
```
public boolean showSyntax(String tagName)
```
    Description copied from interface: IWikiModel
    
    Show the syntax highlighting of the source code
    
    Specified by:
    
    showSyntax in interface IWikiModel
    
    Returns:
  - stackSize
```
public int stackSize()
```
    Description copied from interface: IWikiModel
    
    The size of the internal stack
    
    Specified by:
    
    stackSize in interface IWikiModel
    
    Returns:
  - substituteTemplateCall
```
public 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.
    
    Specified by:
    
    substituteTemplateCall in interface IWikiModel
    
    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
```
public TagStack swapStack(TagStack stack)
```
    Specified by:
    
    swapStack in interface IWikiModel
  - tearDown
```
public void tearDown()
```
    Description copied from interface: IWikiModel
    
    Clean up (i.e. free internal resources) in the wiki model after rendering the wikipedia text, if necessary
    
    Specified by:
    
    tearDown in interface IWikiModel
  - reduceTokenStack
```
public void reduceTokenStack(TagToken node)
```
    Reduce the current token stack until an allowed parent is at the top of the stack
    
    Specified by:
    
    reduceTokenStack in interface IWikiModel
  - getNamespaceName
```
public String getNamespaceName()
```
    Description copied from interface: IWikiModel
    
    Get the namespace name of this model for the current locale.
    
    Specified by:
    
    getNamespaceName in interface IWikiModel
    
    Returns:
    
    the namespace in the current locale for this model
  - setNamespaceName
```
public void setNamespaceName(String namespaceLowercase)
```
    Description copied from interface: IWikiModel
    
    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.
    
    Specified by:
    
    setNamespaceName in interface IWikiModel
    
    Parameters:
    
    namespaceLowercase - the lowercase key for the namespace.
    
    See Also:
    
    Locale, Namespace.getNamespace(String)
  - setNoToc
```
public void setNoToc(boolean disableToc)
```
    Description copied from interface: IWikiModel
    
    Set to true if the rendering of the "table of contents" should be disabled globally.
    
    Specified by:
    
    setNoToc in interface IWikiModel
    
    Parameters:
    
    disableToc - set to true if the rendering of the "table of contents" should be disabled globally.
  - getImageBaseURL
```
public String getImageBaseURL()
```
    Description copied from interface: IWikiModel
    
    Return a URL string which contains a "${image}" variable, which will be replaced by the image name, to create links to images.
    
    Specified by:
    
    getImageBaseURL in interface IWikiModel
    
    Returns:
    
    the wiki images URL
    
    See Also:
    
    IWikiModel.getWikiBaseURL(), IWikiModel.getWikiBaseEditURL()
  - getWikiBaseURL
```
public String getWikiBaseURL()
```
    Description copied from interface: IWikiModel
    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:
```
 https://en.wikipedia.org/wiki/${title}
 
```
    Specified by:
    
    getWikiBaseURL in interface IWikiModel
    
    Returns:
    
    the wiki articles URL
    
    See Also:
    
    IWikiModel.getImageBaseURL(), IWikiModel.getWikiBaseEditURL()
  - getWikiBaseEditURL
```
public String getWikiBaseEditURL()
```
    Description copied from interface: IWikiModel
    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:
```
 https://en.wikipedia.org/w/index.php?title=${title}
 
```
    Specified by:
    
    getWikiBaseEditURL in interface IWikiModel
    
    Returns:
    
    the wiki articles edit action URL
    
    See Also:
    
    IWikiModel.getWikiBaseURL(), IWikiModel.getImageBaseURL()
  - splitNsTitle
```
public String[] splitNsTitle(String fullTitle)
```
    Description copied from interface: IWikiModel
    
    Splits the given full title into its namespace and page title components and normalises both components using Encoder#normaliseTitle(String, boolean, char) keeping underscores.
    
    Specified by:
    
    splitNsTitle in interface IWikiModel
    
    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)
  - getFrame
```
public Frame getFrame()
```
    Specified by:
    
    getFrame in interface IWikiModel
  - setFrame
```
public void setFrame(Frame frame)
```
    Specified by:
    
    setFrame in interface IWikiModel
  - createScribuntoEngine
```
public ScribuntoEngine createScribuntoEngine()
```
    Specified by:
    
    createScribuntoEngine in interface IWikiModel

Class AbstractWikiModel

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

logger

fReferences

fReferenceNames

fRecursionLevel

fTemplateRecursionCount

fTagStack

fLocale

fNamespace

fRedirectLink

fPageTitle

fNamespaceName

fSectionCounter

fTemplateTopic

fParameterParsingMode

fNoToc

fExternalLinksCounter

fToCSet

attributes

fTemplates

Constructor Detail

AbstractWikiModel

AbstractWikiModel

AbstractWikiModel

AbstractWikiModel

Method Detail

addCategory

addCodeFormatter

addInterwikiLink

addLink

addSemanticAttribute

addSemanticRelation

addTemplate

addInclude

addTemplateFunction

addTokenTag

addToReferences

addToTableOfContent

append

appendExternalImageLink

appendExternalLink

appendHead

appendInternalImageLink

setDefaultThumbWidth

appendInternalLink

appendInterWikiLink

appendISBNLink

appendMailtoLink

appendRawNamespaceLinks

appendRawWikipediaLink

appendRedirectLink

appendSignature

appendStack

buildEditLinkUrl

createNewInstance

createTableOfContent

decrementRecursionLevel

decrementTemplateRecursionLevel

encodeTitleDotUrl

encodeTitleToUrl

getAttribute

getAttributeRenderer

getCodeFormatterMap

getCurrentTimeStamp

getInterwikiMap

getLocale

getNextNumber

getNode

getPageName

getMagicWord

getRawWikiContent

getRecursionLevel