org.xwiki.rendering.listener.reference
Class DocumentResourceReference

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

All Implemented Interfaces:

java.lang.Cloneable

public class DocumentResourceReference
extends ResourceReference

Represents a reference to a Document.

Since:

2.5RC1

Version:

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

Field Summary

static java.lang.String	ANCHOR The name of the parameter representing the Anchor.
static java.lang.String	QUERY_STRING The name of the parameter representing the Query String.

Constructor Summary

DocumentResourceReference(java.lang.String reference)

Method Summary

java.lang.String	getAnchor()
java.lang.String	getQueryString()
void	setAnchor(java.lang.String anchor)
void	setQueryString(java.lang.String queryString)

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

QUERY_STRING

public static final java.lang.String QUERY_STRING

The name of the parameter representing the Query String.

See Also:

Constant Field Values

ANCHOR

public static final java.lang.String ANCHOR

The name of the parameter representing the Anchor.

See Also:

Constant Field Values

Constructor Detail

DocumentResourceReference

public DocumentResourceReference(java.lang.String reference)

Parameters:

reference - see ResourceReference.getReference()

Method Detail

getQueryString

public java.lang.String getQueryString()

Returns:

the query string for specifying parameters that will be used in the rendered URL or null if no query string has been specified. Example: "mydata1=5&mydata2=Hello"

setQueryString

public void setQueryString(java.lang.String queryString)

Parameters:

queryString - see getQueryString()

getAnchor

public java.lang.String getAnchor()

Returns:

the anchor name pointing to an anchor defined in the referenced document or null if no anchor has been specified (in which case the reference points to the top of the document). Note that in XWiki anchors are automatically created for titles. Example: "TableOfContentAnchor"

setAnchor

public void setAnchor(java.lang.String anchor)

Parameters:

anchor - see getAnchor()