org.nuxeo.ecm.platform.url

Class DocumentViewImpl

java.lang.Object

org.nuxeo.ecm.platform.url.DocumentViewImpl

All Implemented Interfaces:

Serializable, DocumentView

public class DocumentViewImpl
extends Object
implements DocumentView, Serializable

TODO: document me.

Author:

tiry

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentViewImpl(DocumentLocation docLoc)
DocumentViewImpl(DocumentLocation documentLocation, String viewId)
DocumentViewImpl(DocumentLocation documentLocation, String viewId, Map<String,String> parameters)
DocumentViewImpl(DocumentLocation documentLocation, String viewId, String subURI, Map<String,String> parameters)
DocumentViewImpl(DocumentLocation docLoc, String viewId, String tabId, String subURI) Deprecated.
DocumentViewImpl(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String name, String value)
DocumentLocation	getDocumentLocation()
String	getParameter(String name)
Map<String,String>	getParameters()
String	getPatternName() Returns the url pattern names used to generate this document view.
String	getSubURI()
String	getTabId()
String	getViewId() Returns the outcome to use for this document view.
void	removeParameter(String name)
void	setDocumentLocation(DocumentLocation documentLocation)
void	setPatternName(String patternName)
void	setSubURI(String subURI)
void	setViewId(String viewId)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentViewImpl

public DocumentViewImpl(DocumentLocation documentLocation,
                String viewId)

DocumentViewImpl

public DocumentViewImpl(DocumentLocation documentLocation,
                String viewId,
                Map<String,String> parameters)

DocumentViewImpl

public DocumentViewImpl(DocumentLocation documentLocation,
                String viewId,
                String subURI,
                Map<String,String> parameters)

DocumentViewImpl

public DocumentViewImpl(DocumentModel doc)

DocumentViewImpl

@Deprecated
public DocumentViewImpl(DocumentLocation docLoc,
                           String viewId,
                           String tabId,
                           String subURI)

Deprecated.

DocumentViewImpl

public DocumentViewImpl(DocumentLocation docLoc)

Method Detail

getDocumentLocation

public DocumentLocation getDocumentLocation()

Specified by:

getDocumentLocation in interface DocumentView

getTabId

public String getTabId()

Specified by:

getTabId in interface DocumentView

getViewId

public String getViewId()

Description copied from interface: DocumentView

Returns the outcome to use for this document view.

XXX AT: Can be considered to be badly named "view id".

Specified by:

getViewId in interface DocumentView

getSubURI

public String getSubURI()

Specified by:

getSubURI in interface DocumentView

getParameters

public Map<String,String> getParameters()

Specified by:

getParameters in interface DocumentView

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface DocumentView

addParameter

public void addParameter(String name,
                String value)

Specified by:

addParameter in interface DocumentView

removeParameter

public void removeParameter(String name)

Specified by:

removeParameter in interface DocumentView

setDocumentLocation

public void setDocumentLocation(DocumentLocation documentLocation)

Specified by:

setDocumentLocation in interface DocumentView

setSubURI

public void setSubURI(String subURI)

Specified by:

setSubURI in interface DocumentView

setViewId

public void setViewId(String viewId)

Specified by:

setViewId in interface DocumentView

getPatternName

public String getPatternName()

Description copied from interface: DocumentView

Returns the url pattern names used to generate this document view.

Specified by:

getPatternName in interface DocumentView

setPatternName

public void setPatternName(String patternName)

Specified by:

setPatternName in interface DocumentView

toString

public String toString()

Overrides:

toString in class Object