org.wikidata.wdtk.datamodel.implementation

Class SitesImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.SitesImpl

All Implemented Interfaces:

Sites

public class SitesImpl
extends Object
implements Sites

Implementation of the Sites interface that allows sites to be registered. Objects of this type are not immutable, since they are not data objects, but the Sites interface only supports read access.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Constructor and Description
SitesImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFileUrl(String siteKey, String fileName) Returns the URL for the file of the given name, or null if the site is not known.
String	getGroup(String siteKey) Returns the group for the given site, or null if there is no such data for this site key.
String	getLanguageCode(String siteKey) Returns the MediaWiki language code for the given site, or null if there is no such data for this site key.
String	getPageUrl(String siteKey, String pageTitle) Returns the URL for the page of the given name, or null if the site is not known.
String	getSiteLinkUrl(SiteLink siteLink) Returns the URL for the given site link, or null if its site key is not known.
String	getSiteType(String siteKey) Returns the type for the given site, or null if there is no such data for this site key.
void	setSiteInformation(String siteKey, String group, String languageCode, String siteType, String filePath, String pagePath) Sets the stored information for the site of the given key to the given values.

Methods inherited from class java.lang.Object

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

Constructor Detail

SitesImpl

public SitesImpl()

Method Detail

setSiteInformation

public void setSiteInformation(String siteKey,
                      String group,
                      String languageCode,
                      String siteType,
                      String filePath,
                      String pagePath)

Sets the stored information for the site of the given key to the given values.

Parameters:

siteKey - the global site key

group - the site group

languageCode - the site MediaWiki language code

siteType - the site type

filePath - the file path with $1 as a placeholder for the file name

pagePath - the page path with $1 as a placeholder for the page title

getLanguageCode

public String getLanguageCode(String siteKey)

Description copied from interface: Sites

Returns the MediaWiki language code for the given site, or null if there is no such data for this site key.

The language code follows the MediaWiki conventions for language codes, which do not follow any standard. Most codes agree with those in BCP 47 , but there are a number of exceptions.

Specified by:

getLanguageCode in interface Sites

Parameters:

siteKey - the global site key

Returns:

the corresponding MediaWiki language code, or null if not known

getGroup

public String getGroup(String siteKey)

Description copied from interface: Sites

Returns the group for the given site, or null if there is no such data for this site key. The group is a string identifier used for configuration purposes. Typical groups on Wikimedia sites include "wikipedia", "wikisource", "wikivoyage", and "wikiquote", used for most sites of these projects, but also singleton groups like "commons" and "wikimania2013".

Specified by:

getGroup in interface Sites

Parameters:

siteKey - the global site key

Returns:

the corresponding group, or null if not known

getPageUrl

public String getPageUrl(String siteKey,
                String pageTitle)

Description copied from interface: Sites

Returns the URL for the page of the given name, or null if the site is not known. All characters in the page title will be escaped for use in URLs.

Specified by:

getPageUrl in interface Sites

Parameters:

siteKey - the global site key

pageTitle - the title of the page, including namespace prefixes if any

Returns:

the URL to link to this page on the given site, or null if not known

getSiteLinkUrl

public String getSiteLinkUrl(SiteLink siteLink)

Description copied from interface: Sites

Returns the URL for the given site link, or null if its site key is not known.

Specified by:

getSiteLinkUrl in interface Sites

Parameters:

siteLink - the SiteLink object

Returns:

the page URL for this site link, or null if not known

getFileUrl

public String getFileUrl(String siteKey,
                String fileName)

Description copied from interface: Sites

Returns the URL for the file of the given name, or null if the site is not known. The file name is not escaped for use in URLs, so that one can use this method to construct URLs with parameters, e.g., when calling the API of the site. Also note that this method does not construct URLs for files uploaded to a MediaWiki site using the given file name; such files are usually placed in some subdirectory.

Specified by:

getFileUrl in interface Sites

Parameters:

siteKey - the global site key

fileName - the name of the file

Returns:

the URL to link to this page on the given site, or null if not known

getSiteType

public String getSiteType(String siteKey)

Description copied from interface: Sites

Returns the type for the given site, or null if there is no such data for this site key. For MediaWiki sites, this is "mediawiki".

Specified by:

getSiteType in interface Sites

Parameters:

siteKey - the global site key

Returns:

the corresponding type, or null if not known