com.neurosys.content.service

Interface ContentPathConstructor

All Superinterfaces:

IPageParams

All Known Implementing Classes:

DefaultContentPathConstructor

public interface ContentPathConstructor
extends IPageParams

Defines an API capable of constructing WEB URL's required to access Content.
One may define their own strategy to access content via URL's

Author:

Arjun Dhar

Field Summary

Fields inherited from interface com.neurosys.module.model.IPageParams

ALL_RECS, CAMPAIGN_ID, LANG, PAGE_ID, PAGE_MODE_MOBILE, PAGE_MODE_POPUP, PAGE_NAME, PAGE_NUM, PAGE_PARAM, PAGE_PARENT, PAGE_PARENT_ID, PAGE_REFERRER, PAGE_TYPE, PREVIEW

Method Summary

Modifier and Type	Method and Description
String	decodeUrlSafeName(String name) Transform the safe url-name back to original.
String	encodeUrlSafeName(String name) Transform the intended name to a URL safe name; converting special characters etc The transformation should be reversible.
String	filterActualPageName(String rawName) The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean).
String	getPageName(PageIdentifier page) A standard way to identify a Page
String	getPageNameFromURL(String url) Define a uniform way of deriving a page name from the URL
String	pageNameConstruct(Template associatedTemplate, PageIdentifier page) Get mount path location/name
String	pageNameConstruct(Template associatedTemplate, PageIdentifier page, boolean preview) Get mount path location/name Paths constructed here should be compatible with MountPathReLoader#getStaus(java.util.Map)
void	setPageNameForURL(String url, String name) Allow the ability to tell the path constructor a name of Page/content for a given relative URL

Method Detail

pageNameConstruct

String pageNameConstruct(Template associatedTemplate,
                         PageIdentifier page)

Get mount path location/name

Parameters:

page -

Returns:

pageNameConstruct

String pageNameConstruct(Template associatedTemplate,
                         PageIdentifier page,
                         boolean preview)

Get mount path location/name
Paths constructed here should be compatible with MountPathReLoader#getStaus(java.util.Map)

Parameters:

page -

preview - (true means Status.DRAFT else Status.PUBLISH

Returns:

encodeUrlSafeName

String encodeUrlSafeName(String name)

Transform the intended name to a URL safe name; converting special characters etc
The transformation should be reversible. See #getNameFromSafeUrl(String)
Note: This only concerns the name not the full path

Parameters:

content - name as String

Returns:

as String

decodeUrlSafeName

String decodeUrlSafeName(String name)

Transform the safe url-name back to original. See encodeUrlSafeName(String)
Note: This only concerns the name not the full path

Parameters:

name -

Returns:

getPageNameFromURL

String getPageNameFromURL(String url)

Define a uniform way of deriving a page name from the URL

Parameters:

url - as String

Returns:

setPageNameForURL

void setPageNameForURL(String url,
                       String name)

Allow the ability to tell the path constructor a name of Page/content for a given relative URL

Parameters:

url -

name -

getPageName

String getPageName(PageIdentifier page)

A standard way to identify a Page

Parameters:

page - as PageIdentifier

Returns:

String as its Id/Name

filterActualPageName

String filterActualPageName(String rawName)

The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean). This can introduce some conventions. Filter them to extract the actual name if required.

Returns:

String