Package org.nuxeo.ecm.platform.publisher.impl.core

Class SectionPublicationTree

java.lang.Object

org.nuxeo.ecm.platform.publisher.api.AbstractBasePublicationTree

org.nuxeo.ecm.platform.publisher.impl.core.SectionPublicationTree

All Implemented Interfaces:

Serializable, PublicationNode, PublicationTree

Direct Known Subclasses:

RootSectionsPublicationTree

public class SectionPublicationTree
extends AbstractBasePublicationTree

Simple implementation of a PublicationTree using the Core Sections.

Author:

tiry

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAN_ASK_FOR_PUBLISHING
protected static final String	DEFAULT_ROOT_PATH
protected DocumentModel	treeRoot

Fields inherited from class org.nuxeo.ecm.platform.publisher.api.AbstractBasePublicationTree

configName, coreSession, factory, ICON_COLLAPSED_KEY, ICON_EXPANDED_KEY, iconCollapsed, iconExpanded, ROOT_PATH_KEY, rootNode, rootPath, TITLE_KEY, treeTitle

Constructor Summary

Constructors

Constructor	Description
SectionPublicationTree()

Method Summary

Modifier and Type	Method	Description
protected boolean	accept(PublishedDocument publishedDocument)
boolean	canPublishTo(PublicationNode publicationNode)	Returns true if the current user can publish to the specified publicationNode, false otherwise.
boolean	canUnpublish(PublishedDocument publishedDocument)	Returns true if the current user can unpublish the given publishedDocument, false otherwise.
protected PublishedDocumentFactory	getDefaultFactory()
protected String	getDefaultRootPath()
List<PublishedDocument>	getExistingPublishedDocument(DocumentLocation docLoc)
PublicationNode	getNodeByPath(String path)
void	initTree(CoreSession coreSession, Map<String,String> parameters, PublishedDocumentFactory factory, String configName, String title)
boolean	isPublicationNode(DocumentModel documentModel)	Returns true if the given documentModel is a PublicationNode of the current tree, false otherwise.
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode)
PublishedDocument	publish(DocumentModel doc, PublicationNode targetNode, Map<String,String> params)
void	release()
void	unpublish(DocumentModel doc, PublicationNode targetNode)
void	unpublish(PublishedDocument publishedDocument)
PublicationNode	wrapToPublicationNode(DocumentModel documentModel)	Returns a PublicationNode for the current tree built on the given documentModel.
PublishedDocument	wrapToPublishedDocument(DocumentModel documentModel)

Methods inherited from class org.nuxeo.ecm.platform.publisher.api.AbstractBasePublicationTree

canManagePublishing, getChildrenDocuments, getChildrenNodes, getConfigName, getIconCollapsed, getIconExpanded, getName, getNodeType, getParent, getPath, getPublishedDocumentInNode, getPublishedDocumentsFor, getTitle, getTree, getTreeTitle, getTreeType, getType, hasValidationTask, setCurrentDocument, validatorPublishDocument, validatorRejectPublication

Methods inherited from class java.lang.Object

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

Field Details

CAN_ASK_FOR_PUBLISHING

public static final String CAN_ASK_FOR_PUBLISHING

See Also:

• Constant Field Values

DEFAULT_ROOT_PATH

protected static final String DEFAULT_ROOT_PATH

See Also:

• Constant Field Values

treeRoot

protected DocumentModel treeRoot

Constructor Details

SectionPublicationTree

public SectionPublicationTree()

Method Details

initTree

public void initTree(CoreSession coreSession,
 Map<String,String> parameters,
 PublishedDocumentFactory factory,
 String configName,
 String title)

Specified by:

initTree in interface PublicationTree

Overrides:

initTree in class AbstractBasePublicationTree

getExistingPublishedDocument

public List<PublishedDocument> getExistingPublishedDocument(DocumentLocation docLoc)

publish

public PublishedDocument publish(DocumentModel doc,
 PublicationNode targetNode)

Specified by:

publish in interface PublicationTree

Overrides:

publish in class AbstractBasePublicationTree

publish

public PublishedDocument publish(DocumentModel doc,
 PublicationNode targetNode,
 Map<String,String> params)

Specified by:

publish in interface PublicationTree

Overrides:

publish in class AbstractBasePublicationTree

unpublish

public void unpublish(DocumentModel doc,
 PublicationNode targetNode)

unpublish

public void unpublish(PublishedDocument publishedDocument)

getNodeByPath

public PublicationNode getNodeByPath(String path)

release

public void release()

getDefaultRootPath

protected String getDefaultRootPath()

Specified by:

getDefaultRootPath in class AbstractBasePublicationTree

getDefaultFactory

protected PublishedDocumentFactory getDefaultFactory()

Specified by:

getDefaultFactory in class AbstractBasePublicationTree

canPublishTo

public boolean canPublishTo(PublicationNode publicationNode)

Description copied from interface: PublicationTree

Returns true if the current user can publish to the specified publicationNode, false otherwise.

Specified by:

canPublishTo in interface PublicationTree

Overrides:

canPublishTo in class AbstractBasePublicationTree

Returns:

true if the current user can publish to the specified publicationNode, false otherwise.

canUnpublish

public boolean canUnpublish(PublishedDocument publishedDocument)

Description copied from interface: PublicationTree

Returns true if the current user can unpublish the given publishedDocument, false otherwise.

Specified by:

canUnpublish in interface PublicationTree

Overrides:

canUnpublish in class AbstractBasePublicationTree

Returns:

true if the current user can unpublish the given publishedDocument, false otherwise.

wrapToPublishedDocument

public PublishedDocument wrapToPublishedDocument(DocumentModel documentModel)

Specified by:

wrapToPublishedDocument in interface PublicationTree

Overrides:

wrapToPublishedDocument in class AbstractBasePublicationTree

isPublicationNode

public boolean isPublicationNode(DocumentModel documentModel)

Description copied from interface: PublicationTree

Returns true if the given documentModel is a PublicationNode of the current tree, false otherwise.

Specified by:

isPublicationNode in interface PublicationTree

Overrides:

isPublicationNode in class AbstractBasePublicationTree

wrapToPublicationNode

public PublicationNode wrapToPublicationNode(DocumentModel documentModel)

Description copied from interface: PublicationTree

Returns a PublicationNode for the current tree built on the given documentModel.

Specified by:

wrapToPublicationNode in interface PublicationTree

Overrides:

wrapToPublicationNode in class AbstractBasePublicationTree

accept

protected boolean accept(PublishedDocument publishedDocument)

Specified by:

accept in class AbstractBasePublicationTree