info.bliki.wiki.namespaces

Interface INamespace.INamespaceValue

All Known Implementing Classes:

Namespace.NamespaceValue

Enclosing interface:

INamespace

public static interface INamespace.INamespaceValue

Interface for all namespace constants.

Author:

Nico Kruber, kruber@zib.de

Method Summary

Modifier and Type	Method and Description
void	addAlias(String alias) Adds a single alias to the namespace.
Namespace.NamespaceValue	getAssociatedspace() Get the associated namespace.
String	getCanonicalName()
INamespace.NamespaceCode	getCode()
Namespace.NamespaceValue	getContentspace()
String	getPrimaryText() Provided for convenience.
Namespace.NamespaceValue	getTalkspace()
List<String>	getTexts()
boolean	hasGenderDistinction() Does the namespace (potentially) have different aliases for different genders.
boolean	hasSubpages() Does the namespace allow subpages?
boolean	isCapitalized() Is the namespace first-letter capitalized?
boolean	isContent() Does this namespace contain content, for the purposes of calculating statistics, etc?
boolean	isIncludable() It possible to use pages from this namespace as template?
boolean	isMovable() Can pages in the given namespace be moved?
boolean	isSubject() Is the given namespace is a subject (non-talk) namespace?
boolean	isTalk() Is the given namespace a talk namespace?
boolean	isType(INamespace.NamespaceCode code) Checks whether the namespace is a namespace of the given type.
String	makeFullPagename(String pageName) 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.
void	setTexts(String... aliases) Re-sets the texts used for this namespace.

Method Detail

getCode

INamespace.NamespaceCode getCode()

Returns:

the (internal) integer code of this namespace

setTexts

void setTexts(String... aliases)

Re-sets the texts used for this namespace. The first will be the primary text.

Parameters:

aliases - all aliases for the namespace

addAlias

void addAlias(String alias)

Adds a single alias to the namespace.

Parameters:

alias - the alias

getPrimaryText

String getPrimaryText()

Provided for convenience.

Returns:

the primary text for the namespace, i.e. the first value of getTexts().

getCanonicalName

String getCanonicalName()

Returns:

the canonical / english name

getTexts

List<String> getTexts()

Returns:

the texts

getTalkspace

Namespace.NamespaceValue getTalkspace()

Returns:

the associated talk namespace (may be null)

getContentspace

Namespace.NamespaceValue getContentspace()

Returns:

the associated content namespace

getAssociatedspace

Namespace.NamespaceValue getAssociatedspace()

Get the associated namespace. For talk namespaces, returns the subject (non-talk) namespace For subject (non-talk) namespaces, returns the talk namespace

Returns:

int or null if no associated namespace could be found

makeFullPagename

String makeFullPagename(String pageName)

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.

Parameters:

pageName - the page name without a namespace, e.g. "Test"

Returns:

the full page name, e.g. "Template:Test"

isType

boolean isType(INamespace.NamespaceCode code)

Checks whether the namespace is a namespace of the given type.

Parameters:

code - the code

Returns:

true if the namespace is of the given code, false otherwise

hasSubpages

boolean hasSubpages()

Does the namespace allow subpages?

hasGenderDistinction

boolean hasGenderDistinction()

Does the namespace (potentially) have different aliases for different genders. Not all languages make a distinction here.

isCapitalized

boolean isCapitalized()

Is the namespace first-letter capitalized?

isContent

boolean isContent()

Does this namespace contain content, for the purposes of calculating statistics, etc?

isIncludable

boolean isIncludable()

It possible to use pages from this namespace as template?

isMovable

boolean isMovable()

Can pages in the given namespace be moved?

isSubject

boolean isSubject()

Is the given namespace is a subject (non-talk) namespace?

isTalk

boolean isTalk()

Is the given namespace a talk namespace?