info.bliki.wiki.model

Class WikiModel

java.lang.Object

info.bliki.wiki.model.AbstractWikiModel

info.bliki.wiki.model.WikiModel

All Implemented Interfaces:

IConfiguration, IContext, IWikiModel

public class WikiModel
extends AbstractWikiModel

Standard model implementation.

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,String>	categories A map for categories and their associated sort keys
protected Set<String>	includes
protected Set<String>	links
protected List<SemanticAttribute>	semanticAttributes
protected List<SemanticRelation>	semanticRelations
protected Set<String>	templates

Fields inherited from class info.bliki.wiki.model.AbstractWikiModel

attributes, fExternalLinksCounter, fLocale, fNamespace, fNamespaceName, fNoToc, fPageTitle, fParameterParsingMode, fRecursionLevel, fRedirectLink, fReferenceNames, fReferences, fSectionCounter, fTagStack, fTemplateRecursionCount, fTemplates, fTemplateTopic, fToCSet, logger

Constructor Summary

Constructors

Constructor and Description
WikiModel(Configuration configuration, Locale locale, INamespace namespace, String imageBaseURL, String linkBaseURL)
WikiModel(Configuration configuration, Locale locale, String imageBaseURL, String linkBaseURL)
WikiModel(Configuration configuration, String imageBaseURL, String linkBaseURL)
WikiModel(String imageBaseURL, String linkBaseURL)

Method Summary

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.
void	appendInternalLink(String topic, String hashSection, String topicDescription, String cssClass, boolean parseRecursive) Append an internal wikilink as described in Help Links
protected void	appendInternalLink(String topic, String hashSection, String topicDescription, String cssClass, boolean parseRecursive, boolean topicExists)
protected String	createImageName(ImageFormat imageFormat)
Map<String,String>	getCategories() Get the set of Wikipedia category names used in this text
String	getImageBaseURL() Return a URL string which contains a "${image}" variable, which will be replaced by the image name, to create links to images.
Set<String>	getIncludes() Gets the names of all included pages outside the template namespace.
Set<String>	getLinks() Get the set of Wikipedia links used in this text
INamespace	getNamespace() Get the namespace of this model.
List<SemanticAttribute>	getSemanticAttributes() Get the list of SemanticAttributes
List<SemanticRelation>	getSemanticRelations() Get the list of SemanticRelations.
Set<String>	getTemplates() Gets the names of all included pages in the template namespace.
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.
void	parseInternalImageLink(String imageNamespace, String rawImageLink) Append the internal wiki image link to this model.
boolean	replaceColon() Replace a colon ':' with a slash '/' in wiki names (i.e. links, categories, templates)
void	setUp() Prepare or initialize the wiki model before rendering the wikipedia text
static String	toHtml(String rawWikiText) Convert a given text in wiki notation into HTML text.
static void	toHtml(String rawWikiText, Appendable resultBuffer) Convert a given text in wiki notation into HTML text.
static void	toHtml(String rawWikiText, Appendable resultBuffer, String imageBaseURL, String linkBaseURL) Convert a given text in wiki notation into HTML text.
static void	toText(IWikiModel model, ITextConverter converter, String rawWikiText, Appendable resultBuffer, boolean templateTopic, boolean parseTemplates) Convert a given text in wiki notation into another format.

Methods inherited from class info.bliki.wiki.model.AbstractWikiModel

addCodeFormatter, addInterwikiLink, addTemplateFunction, addTokenTag, addToReferences, addToTableOfContent, append, appendExternalImageLink, appendExternalLink, appendHead, appendInternalImageLink, appendInterWikiLink, appendISBNLink, appendMailtoLink, appendRawNamespaceLinks, appendRawWikipediaLink, appendRedirectLink, appendSignature, appendStack, buildEditLinkUrl, casing, createNewInstance, createScribuntoEngine, createTableOfContent, decrementRecursionLevel, decrementTemplateRecursionLevel, encodeTitleDotUrl, encodeTitleToUrl, getAttribute, getAttributeRenderer, getCodeFormatterMap, getCurrentTimeStamp, getFrame, getInterwikiMap, getLocale, getMagicWord, getNamespaceName, getNextNumber, getNode, getPageName, getRawWikiContent, getRecursionLevel, getRedirectLink, getReferences, getResourceBundle, getSimpleDateFormat, getTableOfContent, getTemplateCallsCache, getTemplateFunction, getTemplateMap, getTokenMap, getUriSchemeSet, getWikiBaseEditURL, getWikiListener, incrementRecursionLevel, incrementTemplateRecursionLevel, initialize, isCamelCaseEnabled, isEditorMode, isInterWiki, isMathtranRenderer, isNamespace, isNoToc, isParameterParsingMode, isPreviewMode, isSemanticWebActive, isTemplateTopic, isValidUriScheme, isValidUriSchemeSpecificPart, parseBehaviorSwitch, parseEvents, parseTemplates, parseTemplates, peekNode, popNode, pushNode, rawSetAttribute, reduceTokenStack, registerRenderer, render, render, render, render, render, renderPDF, setAttribute, setAttributeRenderers, setDefaultThumbWidth, setFrame, setNamespaceName, setNoToc, setPageName, setParameterParsingMode, setSemanticWebActive, setTemplateCallsCache, showSyntax, splitNsTitle, stackSize, substituteTemplateCall, swapStack, tearDown

Methods inherited from class java.lang.Object

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

Field Detail

categories

protected Map<String,String> categories

A map for categories and their associated sort keys

links

protected Set<String> links

templates

protected Set<String> templates

includes

protected Set<String> includes

semanticRelations

protected List<SemanticRelation> semanticRelations

semanticAttributes

protected List<SemanticAttribute> semanticAttributes

Constructor Detail

WikiModel

public WikiModel(String imageBaseURL,
                 String linkBaseURL)

Parameters:

imageBaseURL - a url string which must contains a "${image}" variable which will be replaced by the image name, to create links to images.

linkBaseURL - a url string which must contains a "${title}" variable which will be replaced by the topic title, to create links to other wiki topics.

WikiModel

public WikiModel(Configuration configuration,
                 String imageBaseURL,
                 String linkBaseURL)

WikiModel

public WikiModel(Configuration configuration,
                 Locale locale,
                 String imageBaseURL,
                 String linkBaseURL)

WikiModel

public WikiModel(Configuration configuration,
                 Locale locale,
                 INamespace namespace,
                 String imageBaseURL,
                 String linkBaseURL)

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

Overrides:

addCategory in class AbstractWikiModel

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

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

Overrides:

addLink in class AbstractWikiModel

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

Overrides:

addSemanticAttribute in class AbstractWikiModel

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

Overrides:

addSemanticRelation in class AbstractWikiModel

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

Overrides:

addTemplate in class AbstractWikiModel

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

Overrides:

addInclude in class AbstractWikiModel

Parameters:

pageName - The name of the page that is being included (including its namespace).

See Also:

IWikiModel.addTemplate(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

Overrides:

appendInternalLink in class AbstractWikiModel

cssClass - the links CSS class style

parseRecursive - TODO

appendInternalLink

protected void appendInternalLink(String topic,
                                  String hashSection,
                                  String topicDescription,
                                  String cssClass,
                                  boolean parseRecursive,
                                  boolean topicExists)

getCategories

public Map<String,String> getCategories()

Get the set of Wikipedia category names used in this text

Returns:

the set of category strings

getLinks

public Set<String> getLinks()

Get the set of Wikipedia links used in this text

Returns:

the set of category strings

getSemanticAttributes

public List<SemanticAttribute> getSemanticAttributes()

Description copied from interface: IWikiModel

Get the list of SemanticAttributes

Specified by:

getSemanticAttributes in interface IWikiModel

Overrides:

getSemanticAttributes in class AbstractWikiModel

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

Overrides:

getSemanticRelations in class AbstractWikiModel

Returns:

the list of SemanticRelations or null if no SemanticRelation exists

getTemplates

public Set<String> getTemplates()

Gets the names of all included pages in the template namespace.

Returns:

page names without the template namespace prefix

getIncludes

public Set<String> getIncludes()

Gets the names of all included pages outside the template namespace.

Returns:

page names including their namespace prefix

parseInternalImageLink

public void parseInternalImageLink(String imageNamespace,
                                   String rawImageLink)

Append the internal wiki image link to this model.

Note: the pipe symbol (i.e. "|") splits the rawImageLink into different segments. The first segment is used as the <image-name> and typically ends with extensions like .png, .gif, .jpg or .jpeg.

Note: if the image link contains a "width" attribute, the filename is constructed as <size>px-<image-name>, otherwise it's only the <image-name>.

See Image markup and see Help:Images

Parameters:

imageNamespace - the image namespace

rawImageLink - the raw image link text without the surrounding [[...]]

createImageName

protected String createImageName(ImageFormat imageFormat)

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

Overrides:

replaceColon in class AbstractWikiModel

Returns:

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

Overrides:

setUp in class AbstractWikiModel

getNamespace

public INamespace getNamespace()

Description copied from interface: IWikiModel

Get the namespace of this model.

Returns:

the namespace for this model

toText

public static void toText(IWikiModel model,
                          ITextConverter converter,
                          String rawWikiText,
                          Appendable resultBuffer,
                          boolean templateTopic,
                          boolean parseTemplates)
                   throws IOException

Convert a given text in wiki notation into another format.

Parameters:

model - a wiki model

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

resultBuffer - the buffer to which to append the resulting HTML code.

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

toHtml

public static void toHtml(String rawWikiText,
                          Appendable resultBuffer,
                          String imageBaseURL,
                          String linkBaseURL)
                   throws IOException

Convert a given text in wiki notation into HTML text.

Parameters:

rawWikiText - a raw wiki text

resultBuffer - the buffer to which to append the resulting HTML code.

imageBaseURL - a url string which must contains a "${image}" variable which will be replaced by the image name, to create links to images.

linkBaseURL - a url string which must contains a "${title}" variable which will be replaced by the topic title, to create links to other wiki topics.

Throws:

IOException

toHtml

public static void toHtml(String rawWikiText,
                          Appendable resultBuffer)
                   throws IOException

Convert a given text in wiki notation into HTML text.

Parameters:

rawWikiText - a raw wiki text

resultBuffer - the buffer to which to append the resulting HTML code.

Throws:

IOException

toHtml

public static String toHtml(String rawWikiText)

Convert a given text in wiki notation into HTML text.

Parameters:

rawWikiText - a raw wiki text

Returns:

the resulting HTML text; nay returns null, if an IOException occured.

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

Overrides:

getImageBaseURL in class AbstractWikiModel

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:

 http://en.wikipedia.org/wiki/${title}
 

Specified by:

getWikiBaseURL in interface IWikiModel

Overrides:

getWikiBaseURL in class AbstractWikiModel

Returns:

the wiki articles URL

See Also:

IWikiModel.getImageBaseURL(), IWikiModel.getWikiBaseEditURL()