org.alfresco.wcm.client.impl

Class SectionImpl

java.lang.Object

org.alfresco.wcm.client.impl.ResourceBaseImpl

org.alfresco.wcm.client.impl.SectionImpl

All Implemented Interfaces:

Serializable, Resource, Section

public class SectionImpl
extends ResourceBaseImpl
implements Section

Base section interface implementation

Author:

Roy Wetherall

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.alfresco.wcm.client.Section

PROPERTY_EXCLUDE_FROM_NAV, PROPERTY_REDIRECT_CONFIG, PROPERTY_SECTION_CONFIG

Fields inherited from interface org.alfresco.wcm.client.Resource

PROPERTY_AUTHOR, PROPERTY_DESCRIPTION, PROPERTY_MODIFIED_TIME, PROPERTY_TITLE

Constructor Summary

Constructors

Constructor and Description
SectionImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	checkRedirects(String path)
Query	createQuery() A factory method for returning an empty search query object.
Asset	getAsset(String resourceName) Gets the asset with the given name in this section.
AssetCollection	getAssetCollection(String name) Retrieve the named asset collection from this section.
AssetCollection	getAssetCollection(String name, int resultsToSkip, int maxResults)
boolean	getExcludeFromNav() Should this section be excluded from navigation components?
Asset	getIndexPage() Gets a section's index page
String	getPath() Gets the path of the section
Section	getSection(String sectionName) Find a subsection with the specified name
List<Section>	getSections() Gets the child sections.
List<Tag>	getTags() Gets the tags used within this section (and below) order by their usage (most popular first)
String	getTemplate(String type) Gets the template for a given type of asset for this section
Map<String,String>	getTemplateMappings() Get the template mappings for this section
PathResolutionDetails	resolvePath(String path)
SearchResults	search(Query query) Carry out a search for resources below this section
SearchResults	search(String phrase, int maxResults, int resultsToSkip) Carry out a search for resources below this section that contain all the words in the supplied phrase
SearchResults	searchByTag(String tag, int maxResults, int resultsToSkip) Carry out a search for resources below this section that are tagged with the specified tag
void	setDictionaryService(DictionaryService dictionaryService) Set the dictionary service
void	setProperties(Map<String,Serializable> props) Set resources properties
void	setTags(List<Tag> tags) Set the tags used by this section (and below)

Methods inherited from class org.alfresco.wcm.client.impl.ResourceBaseImpl

getAssetFactory, getCollectionFactory, getContainingSection, getDescription, getId, getName, getPrimarySectionId, getProperties, getProperty, getSectionFactory, getTitle, getType, setAssetFactory, setCollectionFactory, setPrimarySectionId, setSectionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.wcm.client.Resource

getContainingSection, getDescription, getId, getName, getProperties, getProperty, getTitle, getType

Constructor Detail

SectionImpl

public SectionImpl()

Method Detail

getSections

public List<Section> getSections()

Description copied from interface: Section

Gets the child sections.

Specified by:

getSections in interface Section

Returns:

List

child sections

See Also:

Section.getSections()

getSection

public Section getSection(String sectionName)

Description copied from interface: Section

Find a subsection with the specified name

Specified by:

getSection in interface Section

Parameters:

sectionName - The name of the section that the caller is asking for

Returns:

The subsection of this section that has the request name (case-sensitive) or null if not found

See Also:

Section.getSection(java.lang.String)

setTags

public void setTags(List<Tag> tags)

Set the tags used by this section (and below)

Parameters:

tags - the tags used by the section

getTags

public List<Tag> getTags()

Description copied from interface: Section

Gets the tags used within this section (and below) order by their usage (most popular first)

Specified by:

getTags in interface Section

Returns:

the tags

See Also:

Section.getTags()

setDictionaryService

public void setDictionaryService(DictionaryService dictionaryService)

Set the dictionary service

Parameters:

dictionaryService -

getTemplateMappings

public Map<String,String> getTemplateMappings()

Description copied from interface: Section

Get the template mappings for this section

Specified by:

getTemplateMappings in interface Section

Returns:

Map the template mappings. Key/value pairs where the key is the name of the content type and the value is the name of the template to use when rendering content of that type.

See Also:

Section.getTemplateMappings()

getExcludeFromNav

public boolean getExcludeFromNav()

Description copied from interface: Section

Should this section be excluded from navigation components?

Specified by:

getExcludeFromNav in interface Section

Returns:

setProperties

public void setProperties(Map<String,Serializable> props)

Description copied from class: ResourceBaseImpl

Set resources properties

Overrides:

setProperties in class ResourceBaseImpl

Parameters:

props - property map

See Also:

ResourceBaseImpl.setProperties(java.util.Map)

getAsset

public Asset getAsset(String resourceName)

Description copied from interface: Section

Gets the asset with the given name in this section.

Specified by:

getAsset in interface Section

Returns:

Asset the named asset if it exists or null otherwise

See Also:

Section.getAsset(java.lang.String)

getIndexPage

public Asset getIndexPage()

Description copied from interface: Section

Gets a section's index page

Specified by:

getIndexPage in interface Section

Returns:

Asset index page for the section

See Also:

Section.getIndexPage()

getPath

public String getPath()

Description copied from interface: Section

Gets the path of the section

Specified by:

getPath in interface Section

Returns:

String url

See Also:

Section.getPath()

search

public SearchResults search(Query query)

Description copied from interface: Section

Carry out a search for resources below this section

Specified by:

search in interface Section

Parameters:

query - The query attributes to use

Returns:

The results of the search

search

public SearchResults search(String phrase,
                   int maxResults,
                   int resultsToSkip)

Description copied from interface: Section

Carry out a search for resources below this section that contain all the words in the supplied phrase

Specified by:

search in interface Section

Parameters:

phrase - The words to search for. This is considered to be a space-separated set of words that must all appear in an asset for it to match.

maxResults - The maximum number of results to return

resultsToSkip - The number of results to skip over before returning. In combination with maxResults, this is useful for pagination of results. For example, calling this operation with maxResults set to 10 and resultsToSkip set to 0 will return the first "page" of 10 results. Calling it with maxResults set to 10 and resultsToSkip set to 10 will return the second "page" of 10 results, and so on.

Returns:

The results of the search

searchByTag

public SearchResults searchByTag(String tag,
                        int maxResults,
                        int resultsToSkip)

Description copied from interface: Section

Carry out a search for resources below this section that are tagged with the specified tag

Specified by:

searchByTag in interface Section

maxResults - The maximum number of results to return

resultsToSkip - The number of results to skip over before returning. In combination with maxResults, this is useful for pagination of results. For example, calling this operation with maxResults set to 10 and resultsToSkip set to 0 will return the first "page" of 10 results. Calling it with maxResults set to 10 and resultsToSkip set to 10 will return the second "page" of 10 results, and so on.

Returns:

The results of the search

createQuery

public Query createQuery()

Description copied from interface: Section

A factory method for returning an empty search query object.

Specified by:

createQuery in interface Section

Returns:

See Also:

Section.createQuery()

getTemplate

public String getTemplate(String type)

Description copied from interface: Section

Gets the template for a given type of asset for this section

Specified by:

getTemplate in interface Section

Parameters:

type - type

Returns:

String template

See Also:

Section.getTemplate(java.lang.String)

getAssetCollection

public AssetCollection getAssetCollection(String name)

Description copied from interface: Section

Retrieve the named asset collection from this section. Returns null if this section does not have an asset collection with that name.

Specified by:

getAssetCollection in interface Section

Returns:

getAssetCollection

public AssetCollection getAssetCollection(String name,
                                 int resultsToSkip,
                                 int maxResults)

Specified by:

getAssetCollection in interface Section

resolvePath

public PathResolutionDetails resolvePath(String path)

Specified by:

resolvePath in interface Section

checkRedirects

protected String checkRedirects(String path)