org.nuxeo.ecm.platform.url.service

Class AbstractDocumentViewCodec

java.lang.Object

org.nuxeo.ecm.platform.url.service.AbstractDocumentViewCodec

All Implemented Interfaces:

DocumentViewCodec

Direct Known Subclasses:

AdminViewCodec, CollaborationCodec, DocumentFileCodec, DocumentIdCodec, DocumentPathCodec, DocumentPreviewCodec, FacetedSearchViewCodec, LayoutDemoURLCodec, RenditionBasedCodec, RestDocumentViewCodec, UserCodec

public abstract class AbstractDocumentViewCodec
extends Object
implements DocumentViewCodec

Abstract implementation for codecs.

Implements methods that are not likely to be customized except for optimization.

Author:

Anahide Tchertchian

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentViewCodec()

Method Summary

Methods

Modifier and Type	Method and Description
String	getPrefix()
boolean	handleDocumentView(DocumentView docView) Returns true if this codec should apply when iterating over codecs to find a matching one.
boolean	handleUrl(String url) Returns true if this codec should apply when iterating over codecs to find a matching one.
void	setPrefix(String prefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.url.codec.api.DocumentViewCodec

getDocumentViewFromUrl, getUrlFromDocumentView

Constructor Detail

AbstractDocumentViewCodec

public AbstractDocumentViewCodec()

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface DocumentViewCodec

setPrefix

public void setPrefix(String prefix)

Specified by:

setPrefix in interface DocumentViewCodec

handleDocumentView

public boolean handleDocumentView(DocumentView docView)

Description copied from interface: DocumentViewCodec

Returns true if this codec should apply when iterating over codecs to find a matching one.

Specified by:

handleDocumentView in interface DocumentViewCodec

See Also:

DocumentViewCodecManager.getUrlFromDocumentView(DocumentView, boolean, String)

handleUrl

public boolean handleUrl(String url)

Description copied from interface: DocumentViewCodec

Returns true if this codec should apply when iterating over codecs to find a matching one.

Specified by:

handleUrl in interface DocumentViewCodec

See Also:

DocumentViewCodecManager.getDocumentViewFromUrl(String, boolean, String)