info.bliki.wiki.namespaces.INamespace Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bliki-core Show documentation
Show all versions of bliki-core Show documentation
This is the core project.
The newest version!
package info.bliki.wiki.namespaces;
import info.bliki.wiki.filter.Encoder;
import info.bliki.wiki.namespaces.Namespace.NamespaceValue;
import java.util.EnumSet;
import java.util.List;
import java.util.ResourceBundle;
/**
* Mediawiki namespace for a specific language.
*
* @see Mediawiki - Manual:Namespace
* @see Extension default namespaces
* @see Defines.php
*
*/
public interface INamespace {
/**
* Enum of all valid namespace codes.
*/
public enum NamespaceCode {
/**
* Alias for direct links to media files.
*/
MEDIA_NAMESPACE_KEY(-2),
/**
* Holds special pages.
*/
SPECIAL_NAMESPACE_KEY(-1),
/**
* "Real" content; articles. Has no prefix.
*/
MAIN_NAMESPACE_KEY(0),
/**
* Talk pages of "Real" content
*/
TALK_NAMESPACE_KEY(1),
/**
*
*/
USER_NAMESPACE_KEY(2),
/**
* Talk pages for User Pages
*/
USER_TALK_NAMESPACE_KEY(3),
/**
* Information about the wiki. Prefix is the same as $wgSitename of the PHP
* installation.
*/
PROJECT_NAMESPACE_KEY(4),
/**
*
*/
PROJECT_TALK_NAMESPACE_KEY(5),
/**
* Media description pages.
*/
FILE_NAMESPACE_KEY(6),
FILE_TALK_NAMESPACE_KEY(7),
/**
* Site interface customisation. Protected.
*/
MEDIAWIKI_NAMESPACE_KEY(8),
/**
*
*/
MEDIAWIKI_TALK_NAMESPACE_KEY(9),
/**
* Template pages.
*/
TEMPLATE_NAMESPACE_KEY(10),
/**
*
*/
TEMPLATE_TALK_NAMESPACE_KEY(11),
/**
* Help pages.
*/
HELP_NAMESPACE_KEY(12),
/**
*
*/
HELP_TALK_NAMESPACE_KEY(13),
/**
* Category description pages.
*/
CATEGORY_NAMESPACE_KEY(14),
/**
*
*/
CATEGORY_TALK_NAMESPACE_KEY(15),
/**
* Portal pages.
*/
PORTAL_NAMESPACE_KEY(100),
/**
* Talk pages for portal pages.
*/
PORTAL_TALK_NAMESPACE_KEY(101),
BOOK_NAMESPACE_KEY(108),
BOOK_TALK_NAMESPACE_KEY(109),
DRAFT_NAMESPACE_KEY(118),
DRAFT_TALK_NAMESPACE_KEY(119),
EP_NAMESPACE_KEY(446), // EP_NS
EP_TALK_NAMESPACE_KEY(447), // EP_NS_TALK
TIMEDTEXT_NAMESPACE_KEY(710), // NS_TIMEDTEXT
TIMEDTEXT_TALK_NAMESPACE_KEY(711), // NS_TIMEDTEXT_TALK
/**
* Scribunto
*/
MODULE_NAMESPACE_KEY(828), // NS_MODULE
MODULE_TALK_NAMESPACE_KEY(829), // NS_MODULE_TALK
/**
* TOPIC
*/
TOPIC_NAMESPACE_KEY(2600);
/**
* The integer number code of this namespace.
*/
public final Integer code;
private NamespaceCode(Integer code) {
this.code = code;
}
/**
* Which namespaces should support subpages?
* See Language.php for a list of namespaces.
* @see $wgNamespacesWithSubpages
*/
private static final EnumSet wgNamespacesWithSubpages = EnumSet.of(
TALK_NAMESPACE_KEY,
USER_NAMESPACE_KEY,
USER_TALK_NAMESPACE_KEY,
PROJECT_NAMESPACE_KEY,
PROJECT_TALK_NAMESPACE_KEY,
FILE_TALK_NAMESPACE_KEY,
MEDIAWIKI_NAMESPACE_KEY,
MEDIAWIKI_TALK_NAMESPACE_KEY,
TEMPLATE_TALK_NAMESPACE_KEY,
HELP_NAMESPACE_KEY,
HELP_TALK_NAMESPACE_KEY,
CATEGORY_TALK_NAMESPACE_KEY
);
public boolean hasSubpages() {
return wgNamespacesWithSubpages.contains(this);
}
}
/**
* Interface for all namespace constants.
*
* @author Nico Kruber, [email protected]
*/
public interface INamespaceValue {
/**
* @return the (internal) integer code of this namespace
*/
NamespaceCode getCode();
/**
* Re-sets the texts used for this namespace. The first will be the
* primary text.
*
* @param aliases
* all aliases for the namespace
*/
void setTexts(String... aliases);
/**
* Adds a single alias to the namespace.
*
* @param alias
* the alias
*/
void addAlias(String alias);
/**
* Provided for convenience.
*
* @return the primary text for the namespace, i.e. the first value of
* {@link #getTexts()}.
*/
String getPrimaryText();
/**
* @return the canonical / english name
*/
String getCanonicalName();
/**
* @return the texts
*/
List getTexts();
/**
* @return the associated talk namespace (may be null)
*/
NamespaceValue getTalkspace();
/**
* @return the associated content namespace
*/
NamespaceValue getContentspace();
/**
* Get the associated namespace.
* For talk namespaces, returns the subject (non-talk) namespace
* For subject (non-talk) namespaces, returns the talk namespace
*
* @return int or null if no associated namespace could be found
*/
NamespaceValue getAssociatedspace();
/**
* Prepends the namespace to the given pagename and returns the full
* name with a separation character between a (non-empty) namespace and
* the page name.
*
* @param pageName
* the page name without a namespace, e.g. "Test"
*
* @return the full page name, e.g. "Template:Test"
*/
String makeFullPagename(String pageName);
/**
* Checks whether the namespace is a namespace of the given type.
*
* @param code
* the code
*
* @return true if the namespace is of the given code,
* false otherwise
*/
boolean isType(NamespaceCode code);
/**
* Does the namespace allow subpages?
*/
boolean hasSubpages();
/**
* Does the namespace (potentially) have different aliases for different
* genders. Not all languages make a distinction here.
*/
boolean hasGenderDistinction();
/**
* Is the namespace first-letter capitalized?
*/
boolean isCapitalized();
/**
* Does this namespace contain content, for the purposes of calculating
* statistics, etc?
*/
boolean isContent();
/**
* It possible to use pages from this namespace as template?
*/
boolean isIncludable();
/**
* Can pages in the given namespace be moved?
*/
boolean isMovable();
/**
* Is the given namespace is a subject (non-talk) namespace?
*/
boolean isSubject();
/**
* Is the given namespace a talk namespace?
*/
boolean isTalk();
}
/**
* Get the "Media" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getMedia();
/**
* Get the "Special" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getSpecial();
/**
* The main namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getMain();
/**
* The "Talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getTalk();
/**
* The "User" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getUser();
/**
* The "User talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getUser_talk();
/**
* The "Meta" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getProject();
/**
* The "Meta talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getProject_talk();
/**
* The "File" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getImage();
/**
* The "File talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getImage_talk();
/**
* The "MediaWiki" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getMediaWiki();
/**
* The "MediaWiki talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getMediaWiki_talk();
/**
* The "Module" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getModule();
/**
* The "Template" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getTemplate();
/**
* The "Template talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getTemplate_talk();
/**
* The "Help" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getHelp();
/**
* The "Help talk" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getHelp_talk();
/**
* The "Category" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getCategory();
/**
* The "Category talk" namespace for the current language.
*/
public INamespaceValue getCategory_talk();
/**
* The "Portal" namespace for the current language.
*
* @return the namespace
*/
public INamespaceValue getPortal();
/**
* The "Portal talk" namespace for the current language.
*/
public INamespaceValue getPortal_talk();
/**
* Checks whether the given string is a valid namespace of the given type.
*
* @param namespace
* the potential namespace string
* @param code
* the code
*
* @return true if the given namespace is of the given code,
* false otherwise
*/
public abstract boolean isNamespace(String namespace, NamespaceCode code);
/**
* Checks whether the given namespace is a namespace of the given type.
*
* @param namespace
* the namespace
* @param code
* the code
*
* @return true if the given namespace is of the given code,
* false otherwise
*/
public abstract boolean isNamespace(INamespaceValue namespace, NamespaceCode code);
public INamespaceValue getNamespace(String namespace);
public INamespaceValue getNamespaceByNumber(NamespaceCode numberCode);
public INamespaceValue getNamespaceByNumber(int numberCode);
public ResourceBundle getResourceBundle();
/**
* Get the Talk namespace.
*
* @param namespace
* the namespace
* @return the talk namespace for the given namespace or null if the
* namespace is invalid or there is no talk namespace
*
* @see #getContentspace(String)
*/
public INamespaceValue getTalkspace(String namespace);
/**
* Gets the content namespace for a given (talk) namespace.
*
* @param talkNamespace
* the namespace, potentially a talkspace
*
* @return the content namespace or null
*
* @see #getTalkspace(String)
*/
public INamespaceValue getContentspace(String talkNamespace);
/**
* Splits the given full title into its namespace and page title components
* and normalises both components using
* {@link Encoder#normaliseTitle(String, boolean, char, boolean)}. Assumes
* underScoreIsWhitespace, uses a space as whiteSpaceChar
* and capitalises the first character.
*
* @param fullTitle
* the (full) title including a namespace (if present)
*
* @return a 2-element array with the raw namespace string (index 0) and the
* page title (index 1)
* @see #splitNsTitle(String, boolean, char, boolean)
*/
public abstract String[] splitNsTitle(String fullTitle);
/**
* Splits the given full title into its namespace and page title components
* and normalises both components using
* {@link Encoder#normaliseTitle(String, boolean, char, boolean)}.
*
* @param fullTitle
* the (full) title including a namespace (if present)
* @param underScoreIsWhitespace
* whether '_' should be seen as whitespace or not
* @param whiteSpaceChar
* the character to replace whitespace with
* @param firstCharacterAsUpperCase
* if true convert the first of the title to upper case
*
* @return a 2-element array with the raw namespace string (index 0) and the
* page title (index 1)
*/
public abstract String[] splitNsTitle(String fullTitle,
boolean underScoreIsWhitespace, char whiteSpaceChar,
boolean firstCharacterAsUpperCase);
}