info.bliki.wiki.impl
Class APIWikiModel

java.lang.Object
  extended by info.bliki.wiki.model.AbstractWikiModel
      extended by info.bliki.wiki.model.WikiModel
          extended by info.bliki.wiki.impl.APIWikiModel
All Implemented Interfaces:
info.bliki.wiki.model.IConfiguration, info.bliki.wiki.model.IContext, info.bliki.wiki.model.IWikiModel

public class APIWikiModel
extends info.bliki.wiki.model.WikiModel

Wiki model implementation which uses the info.bliki.api package for downloading templates and images from a defined wiki.


Field Summary
 
Fields inherited from class info.bliki.wiki.model.WikiModel
categories, fExternalImageBaseURL, fExternalWikiBaseURL, links, semanticAttributes, semanticRelations, templates
 
Fields inherited from class info.bliki.wiki.model.AbstractWikiModel
attributeRenderers, attributes, fNamespace, fPageTitle, fParserRecursionCount, fRecursionLevel, fRedirectLink, fReferenceNames, fReferences, fSectionCounter, fTableOfContent, fTableOfContentTag, fTagStack, fTemplateRecursionCount, fToCSet
 
Constructor Summary
APIWikiModel(info.bliki.api.User user, WikiDB wikiDB, java.util.Locale locale, java.lang.String imageBaseURL, java.lang.String linkBaseURL, java.lang.String imageDirectoryName)
          WikiModel which loads the templates and images through the Wikimedia API
APIWikiModel(info.bliki.api.User user, WikiDB wikiDB, java.lang.String imageBaseURL, java.lang.String linkBaseURL, java.lang.String imageDirectoryName)
          WikiModel which loads the templates and images through the Wikimedia API
 
Method Summary
 void appendInternalImageLink(java.lang.String hrefImageLink, java.lang.String srcImageLink, info.bliki.wiki.model.ImageFormat imageFormat)
           
 void appendInternalLink(java.lang.String topic, java.lang.String hashSection, java.lang.String topicDescription, java.lang.String cssClass, boolean parseRecursive)
           
 java.lang.String getRawWikiContent(java.lang.String namespace, java.lang.String articleName, java.util.Map<java.lang.String,java.lang.String> templateParameters)
          Get the raw wiki text for the given namespace and article name.
 java.lang.String getRedirectedWikiContent(java.lang.String rawWikitext, java.util.Map<java.lang.String,java.lang.String> templateParameters)
           
 void parseInternalImageLink(java.lang.String imageNamespace, java.lang.String rawImageLink)
           
 
Methods inherited from class info.bliki.wiki.model.WikiModel
addCategory, addLink, addSemanticAttribute, addSemanticRelation, addTemplate, getCategories, getLinks, getNamespace, getSemanticAttributes, getSemanticRelations, getTemplates, replaceColon, setUp
 
Methods inherited from class info.bliki.wiki.model.AbstractWikiModel
addCodeFormatter, addInterwikiLink, addTemplateFunction, addTokenTag, addToReferences, addToTableOfContent, append, appendExternalImageLink, appendExternalLink, appendExternalLink, appendHead, appendHead, appendInterWikiLink, appendISBNLink, appendMailtoLink, appendRawNamespaceLinks, appendRawWikipediaLink, appendRedirectLink, appendSignature, appendStack, appendToCAnchor, buildEditLinkUrl, createNewInstance, createTableOfContent, decrementRecursionLevel, encodeTitleDotUrl, encodeTitleToUrl, get2ndCategoryNamespace, get2ndImageNamespace, get2ndTemplateNamespace, getAttribute, getAttributeRenderer, getCategoryNamespace, getCodeFormatterMap, getCurrentTimeStamp, getImageNamespace, getInterwikiMap, getLocale, getNextNumber, getNode, getPageName, getRecursionLevel, getRedirectLink, getReferences, getResourceBundle, getTableOfContent, getTemplateCallsCache, getTemplateFunction, getTemplateMap, getTemplateNamespace, getTokenMap, getUriSchemeSet, getWikiListener, incrementParserRecursionCount, incrementRecursionLevel, incrementTemplateRecursionCount, initialize, isCamelCaseEnabled, isCategoryNamespace, isEditorMode, isImageNamespace, isInterWiki, isMathtranRenderer, isNamespace, isPreviewMode, isSemanticWebActive, isTemplateNamespace, isTemplateTopic, isValidUriScheme, isValidUriSchemeSpecificPart, parseBBCodes, parseEvents, parseTemplates, parseTemplates, peekNode, popNode, pushNode, rawSetAttribute, registerRenderer, render, render, renderPDF, setAttribute, setAttributeRenderers, setDefaultThumbWidth, setPageName, setSemanticWebActive, setTemplateCallsCache, showSyntax, stackSize, substituteTemplateCall, swapStack, tearDown, toNodeList
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

APIWikiModel

public APIWikiModel(info.bliki.api.User user,
                    WikiDB wikiDB,
                    java.lang.String imageBaseURL,
                    java.lang.String linkBaseURL,
                    java.lang.String imageDirectoryName)
WikiModel which loads the templates and images through the Wikimedia API

Parameters:
user - a user for the Wikimedia API
wikiDB - a wiki database to retrieve already downloaded topics and templates
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.
imageDirectoryName - a directory for storing downloaded Wikipedia images. The directory must already exist.

APIWikiModel

public APIWikiModel(info.bliki.api.User user,
                    WikiDB wikiDB,
                    java.util.Locale locale,
                    java.lang.String imageBaseURL,
                    java.lang.String linkBaseURL,
                    java.lang.String imageDirectoryName)
WikiModel which loads the templates and images through the Wikimedia API

Parameters:
user - a user for the Wikimedia API
wikiDB - a wiki database to retrieve already downloaded topics and templates
locale - a locale for loading language specific resources
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.
imageDirectoryName - a directory for storing downloaded Wikipedia images. The directory must already exist.
Method Detail

getRawWikiContent

public java.lang.String getRawWikiContent(java.lang.String namespace,
                                          java.lang.String articleName,
                                          java.util.Map<java.lang.String,java.lang.String> templateParameters)
Get the raw wiki text for the given namespace and article name. This model implementation uses a Derby database to cache downloaded wiki template texts.

Specified by:
getRawWikiContent in interface info.bliki.wiki.model.IWikiModel
Overrides:
getRawWikiContent in class info.bliki.wiki.model.AbstractWikiModel
Parameters:
namespace - the namespace of this article
templateName - the name of the template
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
See Also:
User.queryContent(String[])

getRedirectedWikiContent

public java.lang.String getRedirectedWikiContent(java.lang.String rawWikitext,
                                                 java.util.Map<java.lang.String,java.lang.String> templateParameters)

appendInternalImageLink

public void appendInternalImageLink(java.lang.String hrefImageLink,
                                    java.lang.String srcImageLink,
                                    info.bliki.wiki.model.ImageFormat imageFormat)
Specified by:
appendInternalImageLink in interface info.bliki.wiki.model.IWikiModel
Overrides:
appendInternalImageLink in class info.bliki.wiki.model.AbstractWikiModel

appendInternalLink

public void appendInternalLink(java.lang.String topic,
                               java.lang.String hashSection,
                               java.lang.String topicDescription,
                               java.lang.String cssClass,
                               boolean parseRecursive)
Specified by:
appendInternalLink in interface info.bliki.wiki.model.IWikiModel
Overrides:
appendInternalLink in class info.bliki.wiki.model.WikiModel

parseInternalImageLink

public void parseInternalImageLink(java.lang.String imageNamespace,
                                   java.lang.String rawImageLink)
Specified by:
parseInternalImageLink in interface info.bliki.wiki.model.IWikiModel
Overrides:
parseInternalImageLink in class info.bliki.wiki.model.WikiModel


Copyright © 2012 Java Wikipedia API (Bliki engine). All Rights Reserved.