com.neurosys.content.service

Class GenericHierarchyContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

java.lang.Object

com.neurosys.content.service.GenericContentServiceImpl<C,CA,CF>

com.neurosys.content.service.GenericHierarchyContentServiceImpl<C,CA,CF>

Type Parameters:

C - as AbstractContent

CA - as AbstractContentAttribute

CF - as AbstractContentFacet

All Implemented Interfaces:

HierarchyService<C>, GenericContentService<C,CA,CF>, ChangeGenerator<Object[]>

Direct Known Subclasses:

CommentServiceImpl, PostServiceImpl

public class GenericHierarchyContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>
extends GenericContentServiceImpl<C,CA,CF>
implements HierarchyService<C>

Generic services for AbstractContent (which is a HierarchialDomainObject)00000
This class will also generate Event with are Object[]

Since this implements ChangeGenerator; it will also generate Events of Type

• Object[]{"save", content}
• Object[]{"new-content", content, sequence as Integer}
• Object[]{"publish", published-content, source-content, path as String}
• Object[]{"unpublish", content, published path as String}
• Object[]{"move", content, newParent, sequence as Integer, movedRelatedContent as Map<Status, C>}
• Object[]{"update-content-status", String name, Locale locale, Status oldStatus, Status newStatus}
• Object[]{"delete-subhierarchy", node as C}
• Object[]{"after-delete", name}
• Object[]{"save-facet", CF}
• Object[]{"clones", original content, clones as List of Content}

Author:

Arjun Dhar

Field Summary

Fields inherited from class com.neurosys.content.service.GenericContentServiceImpl

cache, cacheManager, contentSource, contentStatusCriticalForMove, mountPathReLoader, searchMap, templateService

Fields inherited from interface com.neurosys.content.service.GenericContentService

CONTENT_LOOKUP_CACHE_NAME, CONTENT_PUBLISH_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
GenericHierarchyContentServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
List<C>	clone(C content) clone a content across Status & Locales (alter-egos) of this same content. The passed content is not persisted.
protected List<C>	clone(C content, List<Status> statuses, List<Locale> locales) Ability to clone (create clones & persist) content across AbstractContent.getStatus() and/or AbstractContent.getLocale(). The content should have a valid parentId and hierarchy code already set. This method will not save the passed input content but will create a new clone for the alter egos of the supplied content. All the cloned content will search for their respective parents (creating a parallel cloned hierarchy)
void	convert(IHierarchialReference entity, Class to) If we wish to transform an entity type we should perform the transformation and then the update.
C	createNewContent(C content, Integer sequence) Saves content (new) & creates its clones (see ContentService#clone()).
void	deleteSubHierarchy(C rootNode) Delete a root node and its children. May throw an exception is there is a fault in the hierarchy or any node could not be deleted for some reason.
protected C	getContentProxyObject()
HierarchyContentSource<C,CA,CF>	getContentSource()
List<CF>	getFacets(Object contentNameorId, String facetName, Status status) Convenient method for Scripts to call to get dynamic content for a AbstractContentFacet reference..
String	getLastChildHierarchyCode(C parent) Get the last existing/current child Hierarchy code
List	getListeners() Get list directly.
List	loadHierarchy(C rootNode, boolean loadLeaves)
List<C>	loadHierarchyFlat(C rootNode) Load list of nodes under the root in order of hierarchy but does not to a structural hierarchial conversion (Homogeneous list)
String	mount(C content, Template template) Mount a page so its accessible on the webite.
void	move(C content, C newParent, Integer sequence) Move a content under a parent.
protected void	moveHierarchyOnly(C content, C newParent, Integer sequence, String parentLastHCode)
void	notifyAllListeners(Object[] event) Whenever a node is selected/updated, it also notifies its listeners.
C	publish(C content) Performs operations needed to publish the content and its related attributes, facets etc.
void	setContentSource(HierarchyContentSource<C,CA,CF> contentSource)
void	setListeners(List listeners) Set list directly.
void	unPublish(C content) It will remove the published version from the ContentSource.

Methods inherited from class com.neurosys.content.service.GenericContentServiceImpl

clearCache, clearTemplates, deleteContent, getAdditionalCacheNames, getCache, getCacheManager, getContentStatusCriticalForMove, getMountPathReLoader, getRelatedNavigations, getSearchMap, getSearchService, getTemplateService, getURL, index, publish, save, saveFacet, search, searchCount, setAdditionalCacheNames, setCache, setCacheManager, setContentSource, setContentStatusCriticalForMove, setMountPathReLoader, setRelatedNavigations, setSearchMap, setTemplateService, sysAutoIndex, updateContentStatus, updateNav

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericHierarchyContentServiceImpl

public GenericHierarchyContentServiceImpl()

Method Detail

getContentSource

public HierarchyContentSource<C,CA,CF> getContentSource()

Specified by:

getContentSource in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Overrides:

getContentSource in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

setContentSource

public void setContentSource(HierarchyContentSource<C,CA,CF> contentSource)

getLastChildHierarchyCode

public String getLastChildHierarchyCode(C parent)

Description copied from interface: HierarchyService

Get the last existing/current child Hierarchy code

Specified by:

getLastChildHierarchyCode in interface HierarchyService<C extends AbstractContent<CA,CF>>

Returns:

@nullable true

moveHierarchyOnly

protected void moveHierarchyOnly(C content,
                                 C newParent,
                                 Integer sequence,
                                 String parentLastHCode)
                          throws Exception

Throws:

Exception

move

public void move(C content,
                 C newParent,
                 Integer sequence)
          throws Exception

Description copied from interface: HierarchyService

Move a content under a parent. The order works by default to take the MAX/Last position under the parent; however if order is provided then it tries to adjust to specified order or else MAX/Last remains default.
This operations will also update the passed node with the latest IHierarchialReference.getParentId() and IHierarchialReference.getHierarchy().

Specified by:

move in interface HierarchyService<C extends AbstractContent<CA,CF>>

newParent - @nullable true (if IHierarchialReference.ROOT

sequence - as Integer @nullable true (optional)

Throws:

Exception

loadHierarchy

public List loadHierarchy(C rootNode,
                          boolean loadLeaves)

Specified by:

loadHierarchy in interface HierarchyService<C extends AbstractContent<CA,CF>>

Parameters:

rootNode - this

Returns:

loadHierarchyFlat

public List<C> loadHierarchyFlat(C rootNode)

Description copied from interface: HierarchyService

Load list of nodes under the root in order of hierarchy but does not to a structural hierarchial conversion (Homogeneous list)

Specified by:

loadHierarchyFlat in interface HierarchyService<C extends AbstractContent<CA,CF>>

Returns:

deleteSubHierarchy

public void deleteSubHierarchy(C rootNode)
                        throws Exception

Description copied from interface: HierarchyService

Delete a root node and its children.
May throw an exception is there is a fault in the hierarchy or any node could not be deleted for some reason.

Specified by:

deleteSubHierarchy in interface HierarchyService<C extends AbstractContent<CA,CF>>

Throws:

Exception

convert

public void convert(IHierarchialReference entity,
                    Class to)

Description copied from interface: HierarchyService

If we wish to transform an entity type we should perform the transformation and then the update. This requires an InheritanceType.SINGLE_TABLE or oen where there is a shared DiscriminatorValue
Note this implementation Update the entity Discriminator in the DB directly : Hacking

Specified by:

convert in interface HierarchyService<C extends AbstractContent<CA,CF>>

clone

protected List<C> clone(C content,
                        List<Status> statuses,
                        List<Locale> locales)

Ability to clone (create clones & persist) content across AbstractContent.getStatus() and/or AbstractContent.getLocale().
The content should have a valid parentId and hierarchy code already set.

This method will not save the passed input content but will create a new clone for the alter egos of the supplied content.
All the cloned content will search for their respective parents (creating a parallel cloned hierarchy)

Overrides:

clone in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Returns:

saved/persisted list of clones

clone

public List<C> clone(C content)

clone a content across Status & Locales (alter-egos) of this same content.
The passed content is not persisted.

Specified by:

clone in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Overrides:

clone in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Returns:

saved/persisted list of clones

mount

public String mount(C content,
                    Template template)

Mount a page so its accessible on the webite.

Specified by:

mount in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Returns:

publish

public C publish(C content)
          throws PartialTransactionException

Performs operations needed to publish the content and its related attributes, facets etc.
Typically at the service layer, the following operations constitute a publish (may differ in implementations):

• Clone Preview Content record (& related ContentFacets, attributes) to publish
• Generate new Markup related to template & content
• Refresh any caches
• Update Mount paths if required, so that navigation is up to date

It is preferred that the above steps (or any implementation specific steps) be maintained in one transaction. Failure in a single step should roll back the transaction.

Specified by:

publish in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Overrides:

publish in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

content - (this should be a record with Content.getStatus() as Status.DRAFT)

Throws:

PartialTransactionException

unPublish

public void unPublish(C content)
               throws Exception

Description copied from interface: GenericContentService

It will remove the published version from the ContentSource. By default any paths etc are not mounted.

Specified by:

unPublish in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Overrides:

unPublish in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Throws:

Exception

createNewContent

public C createNewContent(C content,
                          Integer sequence)

Saves content (new) & creates its clones (see ContentService#clone()). The content being saved should be ideally a Status.DRAFT version, if its not set then it will set it; and replicate across other status. The content should also have its parent id set.

Specified by:

createNewContent in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Overrides:

createNewContent in class GenericContentServiceImpl<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

sequence - is ignored in this implementation

content - @nullable false ;if Content#getParentId() is null then it will assume root

Returns:

saved Content object

getContentProxyObject

protected C getContentProxyObject()

getFacets

public List<CF> getFacets(Object contentNameorId,
                          String facetName,
                          Status status)

Description copied from interface: GenericContentService

Convenient method for Scripts to call to get dynamic content for a AbstractContentFacet reference.. Useful when called via embedded scripts in content.

Specified by:

getFacets in interface GenericContentService<C extends AbstractContent<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Parameters:

contentNameorId - as String or Long

facetName - as String

status - as Status (optional)

Returns:

List of AbstractContentFacet

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object[]>

notifyAllListeners

public void notifyAllListeners(Object[] event)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object[]>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object[]>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object[]>