org.xwiki.rendering.listener.reference
Class InterWikiResourceReference

java.lang.Object
  org.xwiki.rendering.listener.reference.ResourceReference
      org.xwiki.rendering.listener.reference.InterWikiResourceReference

All Implemented Interfaces:

java.lang.Cloneable

public class InterWikiResourceReference
extends ResourceReference

Represents a reference to an external wiki(Inter Wiki). An InterWiki reference is a shorthand notation to reference a set of external URL, all having a common prefix (eg http://server/some/common/prefix/a1, http://server/some/common/prefix/a2). An InterWiki reference is made of an InterWiki Alias which is a name corresponding to the common URL and an InterWiki Path which is the suffix to append to the common URL part to make the full URL.

Since:

2.5RC1

Version:

$Id: InterWikiResourceReference.java 31687 2010-10-08 19:37:36Z vmassol $

Field Summary

static java.lang.String

INTERWIKI_ALIAS The name of the parameter representing the InterWiki Alias.

Constructor Summary

InterWikiResourceReference(java.lang.String reference)

Method Summary

java.lang.String	getInterWikiAlias()
void	setInterWikiAlias(java.lang.String interWikiAlias)

Methods inherited from class org.xwiki.rendering.listener.reference.ResourceReference

addBaseReference, addBaseReferences, clone, equals, getBaseReferences, getParameter, getParameters, getReference, getType, hashCode, isTyped, removeParameter, setParameter, setParameters, setReference, setType, setTyped, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INTERWIKI_ALIAS

public static final java.lang.String INTERWIKI_ALIAS

The name of the parameter representing the InterWiki Alias.

See Also:

Constant Field Values

Constructor Detail

InterWikiResourceReference

public InterWikiResourceReference(java.lang.String reference)

Parameters:

reference - see ResourceReference.getReference()

Method Detail

setInterWikiAlias

public void setInterWikiAlias(java.lang.String interWikiAlias)

Parameters:

interWikiAlias - see getInterWikiAlias()

getInterWikiAlias

public java.lang.String getInterWikiAlias()

Returns:

the Inter Wiki alias to which the resource is pointing to or null if not defined. Mappings between Inter Wiki aliases and actual locations are defined in the Inter Wiki Map. Example: "wikipedia"