org.xwiki.rendering.wiki
Interface WikiModel

@ComponentRole
public interface WikiModel

Bridge between the Rendering module and a Wiki Model. Contains wiki APIs required by Rendering classes such as Renderers. For example the XHTML Link Renderer needs to know if a wiki document exists in order to know how to generate the HTML (in order to display a question mark for non existing documents) and it also needs to get the URL pointing the wiki document.

Since:

2.0M1

Version:

$Id: WikiModel.java 31983 2010-10-20 15:42:27Z vmassol $

Method Summary

java.lang.String	getDocumentEditURL(ResourceReference documentReference)
java.lang.String	getDocumentViewURL(ResourceReference documentReference)
java.lang.String	getImageURL(ResourceReference imageReference, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	getLinkURL(ResourceReference linkReference)
boolean	isDocumentAvailable(ResourceReference documentReference)

Method Detail

getLinkURL

java.lang.String getLinkURL(ResourceReference linkReference)

Parameters:

linkReference - the reference to the link resource

Returns:

the URL to the link resource (the resource could be a document, a URL, a path, etc)

Since:

2.5RC1

getImageURL

java.lang.String getImageURL(ResourceReference imageReference,
                             java.util.Map<java.lang.String,java.lang.String> parameters)

Parameters:

imageReference - the reference to the image resource

parameters - the optional parameters passed to the image reference (width, height, etc)

Returns:

the URL to the image resource (the resource could be an attacment in a document, an icon, etc)

Since:

2.5RC1

isDocumentAvailable

boolean isDocumentAvailable(ResourceReference documentReference)

Parameters:

documentReference - the reference to the document

Returns:

true if the document exists and can be viewed or false otherwise

getDocumentViewURL

java.lang.String getDocumentViewURL(ResourceReference documentReference)

Parameters:

documentReference - the reference to the document

Returns:

the URL to view the specified wiki document

getDocumentEditURL

java.lang.String getDocumentEditURL(ResourceReference documentReference)

Parameters:

documentReference - the reference to the document

Returns:

the URL to edit the specified wiki document