de.tudarmstadt.ukp.jwktl.api
Interface IWiktionaryPage

All Known Implementing Classes:
WiktionaryPage

public interface IWiktionaryPage

A IWiktionaryPage corresponds to a unique URL of Wiktionary. That is, a distinct web page, such as http://en.wiktionary.org/wiki/plant. The notion is mostly equivalent to the lexicographic definition of a lexical item. Since non-linguistically pages are filtered out, an IWiktionaryPage encodes linguistic information on a certain word form (e.g., plant) using multiple IWiktionaryEntrys (distinguishing the English noun, the English verb, the Dutch noun, etc. Each IWiktionaryPage belongs to exactly one IWiktionaryEdition.

Author:
Christian M. Meyer

Method Summary
 String getAuthor()
          Returns the author of this revision - i.e., the name of the user that made the last change to the page.
 List<String> getCategories()
          Returns all categories of the Wiktionary page that are manually defined.
 List<IWiktionaryEntry> getEntries()
          Returns the list of all IWiktionaryEntrys.
 IWiktionaryEntry getEntry(int index)
          Returns the IWiktionaryEntry with the given index.
 int getEntryCount()
          Returns the number of IWiktionaryEntrys encoded on this page.
 ILanguage getEntryLanguage()
          Returns the language that this page is written in.
 long getId()
          Returns the unique ID for this page.
 Set<String> getInterWikiLinks()
          Returns a list of inter-wiki links of this Wiktionary page.
 String getKey()
          Returns a unique ID for this page.
 String getRedirectTarget()
          Returns the page title that a redirect page targets at.
 long getRevision()
          Returns the ID of this revision - i.e., a unique number of the last change made to the page.
 Date getTimestamp()
          Returns the timestamp of this revision - i.e., the date of the last change of the page.
 String getTitle()
          Returns the title of this Wiktionary page which usually corresponds to the lemma of all lexical entries described on this page.
 

Method Detail

getKey

String getKey()
Returns a unique ID for this page. The ID is unique for all IWiktionaryPages of the IWiktionaryEdition and remains persistent regardless of the JWKTL software version or the date of the XML data dump of Wiktionary.


getId

long getId()
Returns the unique ID for this page. This method is equivalent to getKey(), but returns the ID as a numerical value.


getTitle

String getTitle()
Returns the title of this Wiktionary page which usually corresponds to the lemma of all lexical entries described on this page.


getTimestamp

Date getTimestamp()
Returns the timestamp of this revision - i.e., the date of the last change of the page.


getRevision

long getRevision()
Returns the ID of this revision - i.e., a unique number of the last change made to the page.


getAuthor

String getAuthor()
Returns the author of this revision - i.e., the name of the user that made the last change to the page.


getEntryLanguage

ILanguage getEntryLanguage()
Returns the language that this page is written in. This is always the language of the whole Wiktionary language edition - i.e. equivalent to IWiktionaryEdition.getLanguage(). As opposed to that, the language of a word can be retrieved by IWiktionaryEntry.getWordLanguage(). There is, for example, a Wiktionary page "plant" in the German Wiktionary language edition that encodes a lexical entry on the word "plant" of the English language. The entry language would be German and the word language would be English in this case.


getCategories

List<String> getCategories()
Returns all categories of the Wiktionary page that are manually defined. Categories being derived automatically by using templates are not returned. The returned list is never null.


getInterWikiLinks

Set<String> getInterWikiLinks()
Returns a list of inter-wiki links of this Wiktionary page. Inter-wiki links are links to other language editions of Wiktionary - e.g., from the English page "plant" to the German page "plant". Note that this is not a translation, but always the same word form. Use IWiktionarySense.getTranslations() for word translations. The returned list is never null.


getRedirectTarget

String getRedirectTarget()
Returns the page title that a redirect page targets at. The method returns null if the page is not a redirection page.


getEntry

IWiktionaryEntry getEntry(int index)
Returns the IWiktionaryEntry with the given index. The index is a running number starting at zero.

Throws:
ArrayIndexOutOfBoundsException - if there is no entry with the given index.

getEntryCount

int getEntryCount()
Returns the number of IWiktionaryEntrys encoded on this page.


getEntries

List<IWiktionaryEntry> getEntries()
Returns the list of all IWiktionaryEntrys. The list is never null and yields equivalent results to using getEntry(int) for all indices from zero to getEntryCount().



Copyright © 2011-2013 Ubiquitous Knowledge Processing (UKP) Lab. All Rights Reserved.