uk.ac.cam.caret.sakai.rwiki.component.service.impl

Class BaseEntityHandlerImpl

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.component.service.impl.BaseEntityHandlerImpl

All Implemented Interfaces:

uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

Direct Known Subclasses:

XSLTEntityHandler

public abstract class BaseEntityHandlerImpl
extends Object
implements uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

Provides a regex base entity handler where the matching uses MessageFormats and Regex patterns

Author:

ieb

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.alias.api.AliasService	m_aliasService Dependency: AliasService.
protected boolean	m_siteAlias Configuration: allow use of alias for site id in references.
protected org.sakaiproject.site.api.SiteService	m_siteService Dependency: SiteService.

Constructor Summary

Constructors

Constructor and Description
BaseEntityHandlerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Decoded	decode(String s)
String	getAccessURLStart()
boolean	getExperimental()
String	getFeedFormat()
String	getHTML(org.sakaiproject.entity.api.Entity e)
String	getMinorType()
int	getRevision(org.sakaiproject.entity.api.Reference reference)
boolean	isAvailable()
boolean	matches(String reference)
void	setAccessURLStart(String accessURLStart)
void	setAliasService(org.sakaiproject.alias.api.AliasService service) Dependency: AliasService.
void	setExperimental(boolean experimental)
void	setFeedFormat(String feedFormat)
void	setMinorType(String minorType)
void	setReference(String majorType, org.sakaiproject.entity.api.Reference ref, String reference)
void	setSiteService(org.sakaiproject.site.api.SiteService service) Dependency: SiteService.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

getAuthzGroups, getDescription, getProperties, getUrl, outputContent

Field Detail

m_siteAlias

protected boolean m_siteAlias

Configuration: allow use of alias for site id in references.

m_aliasService

protected org.sakaiproject.alias.api.AliasService m_aliasService

Dependency: AliasService.

m_siteService

protected org.sakaiproject.site.api.SiteService m_siteService

Dependency: SiteService.

Constructor Detail

BaseEntityHandlerImpl

public BaseEntityHandlerImpl()

Method Detail

setAliasService

public void setAliasService(org.sakaiproject.alias.api.AliasService service)

Dependency: AliasService.

Parameters:

service - The AliasService.

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService service)

Dependency: SiteService.

Parameters:

service - The SiteService.

setReference

public void setReference(String majorType,
                org.sakaiproject.entity.api.Reference ref,
                String reference)

Specified by:

setReference in interface uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

matches

public boolean matches(String reference)

Specified by:

matches in interface uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

getRevision

public int getRevision(org.sakaiproject.entity.api.Reference reference)

Specified by:

getRevision in interface uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

getMinorType

public String getMinorType()

Returns:

Returns the minorType.

setMinorType

public void setMinorType(String minorType)

Parameters:

minorType - The minorType to set.

decode

public Decoded decode(String s)

Parameters:

s - the full reference

Returns:

A Decoded object contianing the values, or null if not this handler

getAccessURLStart

public String getAccessURLStart()

Returns:

Returns the accessURLStart.

setAccessURLStart

public void setAccessURLStart(String accessURLStart)

Parameters:

accessURLStart - The accessURLStart to set.

isAvailable

public boolean isAvailable()

getHTML

public String getHTML(org.sakaiproject.entity.api.Entity e)

Specified by:

getHTML in interface uk.ac.cam.caret.sakai.rwiki.service.api.EntityHandler

getFeedFormat

public String getFeedFormat()

Returns:

Returns the feedFormat.

setFeedFormat

public void setFeedFormat(String feedFormat)

Parameters:

feedFormat - The feedFormat to set.

getExperimental

public boolean getExperimental()

Returns:

Returns the experimental.

setExperimental

public void setExperimental(boolean experimental)

Parameters:

experimental - The experimental to set.