org.alfresco.module.org_alfresco_module_wcmquickstart.util.contextparser

Class ContextParser

java.lang.Object

org.alfresco.module.org_alfresco_module_wcmquickstart.util.contextparser.ContextParser

All Implemented Interfaces:

WebSiteModel

Direct Known Subclasses:

PdfRenditionPathContextParser, SectionIdContextParser, SectionPathContextParser, SiteIdContextParser, WebsiteOwnerContextParser

public abstract class ContextParser
extends Object
implements WebSiteModel

Context parser abstract base implementation.

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name Query parser name
protected org.alfresco.service.cmr.repository.NodeService	nodeService Node service
protected SiteHelper	siteHelper Site helper

Fields inherited from interface org.alfresco.module.org_alfresco_module_wcmquickstart.model.WebSiteModel

ASPECT_HAS_ANCESTORS, ASPECT_TEMPORARY_MULTILINGUAL, ASPECT_WEBASSET, ASSOC_PRIMARY_IMAGE, ASSOC_PUBLISH_TARGET, ASSOC_PUBLISHING_QUEUE, ASSOC_RELEVANT_ASSET, ASSOC_SECONDARY_IMAGE, ASSOC_SUMMARISED_ASSET, ASSOC_WEBASSETS, NAMESPACE, PREFIX, PROCESS_READ_CONTACT, PROP_ANCESTOR_SECTIONS, PROP_AVAILABLE, PROP_AVAILABLE_FROM_DATE, PROP_AVAILABLE_TO_DATE, PROP_AVERAGE_RATING, PROP_COMMENT, PROP_COMMENT_COUNT, PROP_COMMENT_FLAGGED, PROP_CONTAINED_ASSETS, PROP_DERIVED_AVERAGE_RATING, PROP_DERIVED_COMMENT_COUNT, PROP_EXCLUDE_FROM_NAV, PROP_FAILED_ATTEMPTS_COUNT, PROP_FEEDBACK_CONFIG, PROP_FEEDBACK_TYPE, PROP_HOST_NAME, PROP_HOST_PORT, PROP_INHERIT_RENDITION_CONFIG, PROP_INITIALLY_ORPHANED, PROP_IS_DYNAMIC, PROP_LANGUAGE, PROP_MINS_TO_QUERY_REFRESH, PROP_ORDER_INDEX, PROP_PARENT_SECTIONS, PROP_PROCESSED_RATINGS, PROP_PUBLISHED_TIME, PROP_QUERY, PROP_QUERY_LANGUAGE, PROP_QUERY_RESULTS_MAX_SIZE, PROP_QUEUED_NODE, PROP_QUEUED_NODE_FOR_REMOVAL, PROP_RATING, PROP_RATING_PROCESSED, PROP_REFRESH_AT, PROP_RELEVANT_ASSET, PROP_RENDITION_CONFIG, PROP_SECTION_CONFIG, PROP_SITE_LOCALES, PROP_SUMMARISED_ASSET, PROP_TAGS, PROP_TRANSLATION_OF, PROP_VISITOR_EMAIL, PROP_VISITOR_NAME, PROP_WEB_APP_CONTEXT, PROP_WEBSITE_CONFIG, TYPE_ARTICLE, TYPE_IMAGE, TYPE_INDEX_PAGE, TYPE_PUBLISH_QUEUE_ENTRY, TYPE_SECTION, TYPE_VISITOR_FEEDBACK, TYPE_VISITOR_FEEDBACK_SUMMARY, TYPE_WEB_ROOT, TYPE_WEB_SITE, TYPE_WEBASSET_COLLECTION, TYPE_WEBASSET_COLLECTION_FOLDER, TYPE_WEBSITE_CONTAINER

Constructor Summary

Constructors

Constructor and Description
ContextParser()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandle(String invocation)
abstract String	execute(org.alfresco.service.cmr.repository.NodeRef context) Executes the context parser, returning the parsed string value.
String	execute(org.alfresco.service.cmr.repository.NodeRef context, String invocation)
String	getName() Get name of the context parser.
void	init() Initialisation method
void	setName(String name) Set the name of the context parser
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Sets the node service
void	setRegistry(ContextParserService registry) Set context parser registry
void	setSiteHelper(SiteHelper siteHelper) Sets the site helper.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Query parser name

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

Node service

siteHelper

protected SiteHelper siteHelper

Site helper

Constructor Detail

ContextParser

public ContextParser()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Sets the node service

Parameters:

nodeService - node service

setSiteHelper

public void setSiteHelper(SiteHelper siteHelper)

Sets the site helper.

Parameters:

siteHelper - site helper

getName

public String getName()

Get name of the context parser.

Returns:

String context parser name

setName

public void setName(String name)

Set the name of the context parser

Parameters:

name - context parser name

setRegistry

public void setRegistry(ContextParserService registry)

Set context parser registry

Parameters:

registry - context parser registry

init

public void init()

Initialisation method

execute

public abstract String execute(org.alfresco.service.cmr.repository.NodeRef context)

Executes the context parser, returning the parsed string value.

Parameters:

context - node reference providing context

Returns:

String parsed string value

canHandle

public boolean canHandle(String invocation)

execute

public String execute(org.alfresco.service.cmr.repository.NodeRef context,
             String invocation)