org.exoplatform.wiki.mow.core.api.wiki

Class PageImpl

java.lang.Object

org.chromattic.ext.ntdef.NTHierarchyNode

org.chromattic.ext.ntdef.NTFolder

org.exoplatform.wiki.mow.core.api.wiki.PageImpl

All Implemented Interfaces:

Iterable<org.chromattic.ext.ntdef.NTHierarchyNode>

Direct Known Subclasses:

DraftPageImpl, HelpPage, TemplateImpl, WikiHome

public abstract class PageImpl
extends org.chromattic.ext.ntdef.NTFolder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PageImpl.RemoveMixVersionable
class	PageImpl.VersionData

Constructor Summary

Constructors

Constructor and Description
PageImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachment(AttachmentImpl attachment)
protected void	addPage(String pageName, PageImpl page)
void	addPublicPage(PageImpl page)
String	addRelatedPage(PageImpl page) add a related page
void	addWikiPage(PageImpl page)
NTVersion	checkin()
void	checkout()
abstract AttachmentImpl	createAttachment()
AttachmentImpl	createAttachment(String fileName, org.chromattic.ext.ntdef.Resource contentResource)
protected abstract AttachmentImpl	createContent()
protected abstract MigratingMixin	createMigratingMixin()
abstract UpdateAttachmentMixin	createUpdateAttachmentMixin()
protected abstract WatchedMixin	createWatchedMixin()
String	getActivityId()
abstract ActivityInfoMixin	getActivityInfoMixin()
AttachmentImpl	getAttachment(String attachmentId)
AttachmentImpl	getAttachmentByRootPermisison(String attachmentId)
Collection<AttachmentImpl>	getAttachments()
abstract Collection<AttachmentImpl>	getAttachmentsByChromattic()
Collection<AttachmentImpl>	getAttachmentsExcludeContent()
Collection<AttachmentImpl>	getAttachmentsExcludeContentByRootPermisison()
abstract String	getAuthor()
Map<String,PageImpl>	getChildPages()
Map<String,PageImpl>	getChildrenByRootPermission()
protected abstract Map<String,PageImpl>	getChildrenContainer()
org.chromattic.api.ChromatticSession	getChromatticSession()
abstract String	getComment()
AttachmentImpl	getContent()
protected abstract AttachmentImpl	getContentByChromattic()
abstract Date	getCreatedDate()
String	getID()
javax.jcr.Node	getJCRPageNode()
javax.jcr.Session	getJCRSession()
abstract MigratingMixin	getMigratingMixin()
abstract MovedMixin	getMovedMixin()
MOWService	getMOWService()
abstract String	getName()
abstract boolean	getOverridePermission()
abstract String	getOwner()
abstract PageImpl	getParentPage()
abstract String	getPath()
HashMap<String,String[]>	getPermission()
Map<String,javax.jcr.Value>	getReferredUUIDs() get reference uuids of current page
List<PageImpl>	getRelatedPages()
abstract RemovedMixin	getRemovedMixin()
abstract RenamedMixin	getRenamedMixin()
abstract String	getSyntax()
String	getTitle()
abstract String	getTitleByChromattic()
abstract Trash	getTrash()
abstract UncachedMixin	getUncachedMixin()
abstract UpdateAttachmentMixin	getUpdateAttachmentMixin()
abstract Date	getUpdatedDate()
abstract String	getURL()
VersionableMixin	getVersionableMixin()
abstract WatchedMixin	getWatchedMixin()
WikiImpl	getWiki()
WikiHome	getWikiHome()
PageImpl	getWikiPage(String pageId)
abstract String	getWorkspace()
boolean	hasPermission(PermissionType permissionType)
boolean	hasPermission(PermissionType permissionType, org.exoplatform.services.security.Identity user)
boolean	isMinorEdit()
void	makeVersionable()
void	makeWatched()
void	migrateAttachmentPermission()
void	migrateLegacyData() Migrates old page history data on the fly: 1.create version history of content child node based on the history of page node, 2.remove the mix:versionable from page node.
abstract void	remove()
void	removeAllRelatedPages()
void	removeAttachment(String attachmentId)
String	removeRelatedPage(PageImpl page) remove a specified related page.
void	restore(String versionName, boolean removeExisting)
void	setActivityId(String activityId)
abstract void	setActivityInfoMixin(ActivityInfoMixin activity)
abstract void	setAuthor(String author)
abstract void	setComment(String comment)
void	setComponentManager(org.xwiki.component.manager.ComponentManager componentManager)
protected abstract void	setContentByChromattic(AttachmentImpl content)
abstract void	setCreatedDate(Date date)
abstract void	setMigratingMixin(MigratingMixin mix)
void	setMinorEdit(boolean isMinorEdit)
abstract void	setMovedMixin(MovedMixin move)
void	setMOWService(MOWService mowService)
abstract void	setName(String name)
void	setNonePermission()
abstract void	setOverridePermission(boolean isOverridePermission)
abstract void	setOwner(String owner)
abstract void	setParentPage(PageImpl page)
void	setPermission(HashMap<String,String[]> permissions)
abstract void	setRemovedMixin(RemovedMixin remove)
abstract void	setRenamedMixin(RenamedMixin mix)
abstract void	setSyntax(String syntax)
void	setTitle(String title)
abstract void	setTitleByChromattic(String title)
abstract void	setTrash(Trash trash)
abstract void	setUncachedMixin(UncachedMixin mix)
abstract void	setUpdateAttachmentMixin(UpdateAttachmentMixin mix)
abstract void	setUpdatedDate(Date date)
abstract void	setURL(String url)
abstract void	setWatchedMixin(WatchedMixin mix)

Methods inherited from class org.chromattic.ext.ntdef.NTFolder

addChild, addChild, createFile, createFile, createFolder, createFolder, getChild, getChildren, getFile, getFolder, iterator

Methods inherited from class org.chromattic.ext.ntdef.NTHierarchyNode

getCreated, getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

PageImpl

public PageImpl()

Method Detail

getID

public String getID()
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setMOWService

public void setMOWService(MOWService mowService)

getMOWService

public MOWService getMOWService()

getChromatticSession

public org.chromattic.api.ChromatticSession getChromatticSession()

getJCRSession

public javax.jcr.Session getJCRSession()

setComponentManager

public void setComponentManager(org.xwiki.component.manager.ComponentManager componentManager)

getJCRPageNode

public javax.jcr.Node getJCRPageNode()
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getName

public abstract String getName()

Specified by:

getName in class org.chromattic.ext.ntdef.NTHierarchyNode

setName

public abstract void setName(String name)

getPath

public abstract String getPath()

getWorkspace

public abstract String getWorkspace()

getContentByChromattic

protected abstract AttachmentImpl getContentByChromattic()

setContentByChromattic

protected abstract void setContentByChromattic(AttachmentImpl content)

createContent

protected abstract AttachmentImpl createContent()

getContent

public AttachmentImpl getContent()

getTitleByChromattic

public abstract String getTitleByChromattic()

setTitleByChromattic

public abstract void setTitleByChromattic(String title)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getSyntax

public abstract String getSyntax()

setSyntax

public abstract void setSyntax(String syntax)

getComment

public abstract String getComment()

setComment

public abstract void setComment(String comment)

getOwner

public abstract String getOwner()

setOwner

public abstract void setOwner(String owner)

getAuthor

public abstract String getAuthor()

setAuthor

public abstract void setAuthor(String author)

getCreatedDate

public abstract Date getCreatedDate()

setCreatedDate

public abstract void setCreatedDate(Date date)

getUpdatedDate

public abstract Date getUpdatedDate()

setUpdatedDate

public abstract void setUpdatedDate(Date date)

getURL

public abstract String getURL()

setURL

public abstract void setURL(String url)

getActivityInfoMixin

public abstract ActivityInfoMixin getActivityInfoMixin()

setActivityInfoMixin

public abstract void setActivityInfoMixin(ActivityInfoMixin activity)

getMovedMixin

public abstract MovedMixin getMovedMixin()

setMovedMixin

public abstract void setMovedMixin(MovedMixin move)

getRemovedMixin

public abstract RemovedMixin getRemovedMixin()

setRemovedMixin

public abstract void setRemovedMixin(RemovedMixin remove)

getRenamedMixin

public abstract RenamedMixin getRenamedMixin()

setRenamedMixin

public abstract void setRenamedMixin(RenamedMixin mix)

getUncachedMixin

public abstract UncachedMixin getUncachedMixin()

setUncachedMixin

public abstract void setUncachedMixin(UncachedMixin mix)

getWatchedMixin

public abstract WatchedMixin getWatchedMixin()

setWatchedMixin

public abstract void setWatchedMixin(WatchedMixin mix)

createWatchedMixin

protected abstract WatchedMixin createWatchedMixin()

getMigratingMixin

public abstract MigratingMixin getMigratingMixin()

setMigratingMixin

public abstract void setMigratingMixin(MigratingMixin mix)

createMigratingMixin

protected abstract MigratingMixin createMigratingMixin()

makeWatched

public void makeWatched()

getVersionableMixin

public VersionableMixin getVersionableMixin()

makeVersionable

public void makeVersionable()

checkin

public NTVersion checkin()
                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

checkout

public void checkout()
              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

restore

public void restore(String versionName,
           boolean removeExisting)
             throws WikiException

Throws:

WikiException

createAttachment

public abstract AttachmentImpl createAttachment()

createAttachment

public AttachmentImpl createAttachment(String fileName,
                              org.chromattic.ext.ntdef.Resource contentResource)
                                throws WikiException

Throws:

WikiException

getAttachmentsByChromattic

public abstract Collection<AttachmentImpl> getAttachmentsByChromattic()

getAttachments

public Collection<AttachmentImpl> getAttachments()

getAttachmentsExcludeContent

public Collection<AttachmentImpl> getAttachmentsExcludeContent()
                                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getAttachmentsExcludeContentByRootPermisison

public Collection<AttachmentImpl> getAttachmentsExcludeContentByRootPermisison()

getAttachment

public AttachmentImpl getAttachment(String attachmentId)

getAttachmentByRootPermisison

public AttachmentImpl getAttachmentByRootPermisison(String attachmentId)
                                             throws Exception

Throws:

Exception

addAttachment

public void addAttachment(AttachmentImpl attachment)
                   throws org.chromattic.api.DuplicateNameException

Throws:

org.chromattic.api.DuplicateNameException

removeAttachment

public void removeAttachment(String attachmentId)

getParentPage

public abstract PageImpl getParentPage()

setParentPage

public abstract void setParentPage(PageImpl page)

getTrash

public abstract Trash getTrash()

setTrash

public abstract void setTrash(Trash trash)

getChildrenContainer

protected abstract Map<String,PageImpl> getChildrenContainer()

getChildPages

public Map<String,PageImpl> getChildPages()

getChildrenByRootPermission

public Map<String,PageImpl> getChildrenByRootPermission()

getOverridePermission

public abstract boolean getOverridePermission()

setOverridePermission

public abstract void setOverridePermission(boolean isOverridePermission)

hasPermission

public boolean hasPermission(PermissionType permissionType)

hasPermission

public boolean hasPermission(PermissionType permissionType,
                    org.exoplatform.services.security.Identity user)

getPermission

public HashMap<String,String[]> getPermission()
                                       throws WikiException

Throws:

WikiException

setPermission

public void setPermission(HashMap<String,String[]> permissions)
                   throws WikiException

Throws:

WikiException

setNonePermission

public void setNonePermission()
                       throws WikiException

Throws:

WikiException

getActivityId

public String getActivityId()

setActivityId

public void setActivityId(String activityId)

addPage

protected void addPage(String pageName,
           PageImpl page)

addWikiPage

public void addWikiPage(PageImpl page)

addPublicPage

public void addPublicPage(PageImpl page)
                   throws WikiException

Throws:

WikiException

getWikiPage

public PageImpl getWikiPage(String pageId)
                     throws Exception

Throws:

Exception

getWiki

public WikiImpl getWiki()

getWikiHome

public WikiHome getWikiHome()

isMinorEdit

public boolean isMinorEdit()

setMinorEdit

public void setMinorEdit(boolean isMinorEdit)

remove

public abstract void remove()

addRelatedPage

public String addRelatedPage(PageImpl page)
                      throws javax.jcr.RepositoryException

add a related page

Parameters:

page -

Returns:

uuid of node of related page if add successfully.
null if add failed.

Throws:

NullPointerException - if the param is null

Exception - when any error occurs.

javax.jcr.RepositoryException

getRelatedPages

public List<PageImpl> getRelatedPages()
                               throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

removeRelatedPage

public String removeRelatedPage(PageImpl page)
                         throws javax.jcr.RepositoryException

remove a specified related page.

Parameters:

page -

Returns:

uuid of node if related page is removed successfully
null if removing failed.

Throws:

Exception - when an error is thrown.

javax.jcr.RepositoryException

getReferredUUIDs

public Map<String,javax.jcr.Value> getReferredUUIDs()
                                             throws javax.jcr.RepositoryException

get reference uuids of current page

Returns:

Map map of referred uuids of current page

Throws:

Exception - when an error is thrown.

javax.jcr.RepositoryException

removeAllRelatedPages

public void removeAllRelatedPages()
                           throws Exception

Throws:

Exception

migrateLegacyData

public void migrateLegacyData()
                       throws javax.jcr.RepositoryException

Migrates old page history data on the fly: 1.create version history of content child node
based on the history of page node, 2.remove the mix:versionable from page node.

Throws:

Exception

javax.jcr.RepositoryException

getUpdateAttachmentMixin

public abstract UpdateAttachmentMixin getUpdateAttachmentMixin()

setUpdateAttachmentMixin

public abstract void setUpdateAttachmentMixin(UpdateAttachmentMixin mix)

createUpdateAttachmentMixin

public abstract UpdateAttachmentMixin createUpdateAttachmentMixin()

migrateAttachmentPermission

public void migrateAttachmentPermission()
                                 throws WikiException

Throws:

WikiException