org.exoplatform.ecm.webui.component.explorer

Class UIJCRExplorer

java.lang.Object

org.exoplatform.webui.core.UIComponent

org.exoplatform.webui.core.UIContainer

org.exoplatform.ecm.webui.component.explorer.UIJCRExplorer

public class UIJCRExplorer
extends org.exoplatform.webui.core.UIContainer

Created by The eXo Platform SARL Author : nqhungvn nguyenkequanghung@yahoo.com July 3, 2006 10:07:15 AM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIJCRExplorer.HistoryEntry

Nested classes/interfaces inherited from class org.exoplatform.webui.core.UIContainer

org.exoplatform.webui.core.UIContainer.SelectTabActionListener

Field Summary

Fields inherited from class org.exoplatform.webui.core.UIComponent

AJAX_ASYNC, config, OBJECTID, UICOMPONENT, uiparent

Constructor Summary

Constructors

Constructor and Description
UIJCRExplorer()

Method Summary

Modifier and Type	Method and Description
void	addLockToken(javax.jcr.Node node) Allows you to add a lock token to the given node
void	cancelAction()
void	clearNodeHistory(String currentPath)
void	clearTagSelection()
void	closeEditingFile()
String	filterPath(String currentPath)
Set<String>	getAllItemByTypeFilterMap()
Set<String>	getAllItemFilterMap()
List<String>	getCheckedSupportType()
List<javax.jcr.Node>	getChildrenList(String path, boolean isReferences)
static javax.servlet.http.Cookie	getCookieByCookieName(String cookieName, javax.servlet.http.Cookie[] cookies)
String	getCurrentDriveWorkspace()
javax.jcr.Node	getCurrentNode()
String	getCurrentPath()
javax.jcr.Node	getCurrentStateNode()
String	getCurrentStatePath()
String	getCurrentWorkspace()
List<javax.jcr.Node>	getDocumentByTag()
String	getDocumentInfoTemplate()
DriveData	getDriveData()
Collection<UIJCRExplorer.HistoryEntry>	getHistory()
JCRResourceResolver	getJCRTemplateResourceResolver()
String	getLanguage()
List<String>	getMultiValues(javax.jcr.Node node, String name)
javax.jcr.Node	getNodeByPath(String nodePath, javax.jcr.Session session)
javax.jcr.Node	getNodeByPath(String nodePath, javax.jcr.Session session, boolean giveTarget)
LinkedList<String>	getNodesHistory()
javax.portlet.PortletPreferences	getPortletPreferences()
Preference	getPreference()
javax.jcr.Node	getRealCurrentNode()
String	getReferenceWorkspace()
org.exoplatform.services.jcr.core.ManageableRepository	getRepository()
String	getRepositoryName()
javax.jcr.Node	getRootNode()
String	getRootPath()
javax.jcr.Session	getSession()
javax.jcr.Session	getSessionByWorkspace(String wsName)
org.exoplatform.services.jcr.ext.common.SessionProvider	getSessionProvider()
org.exoplatform.services.jcr.ext.common.SessionProvider	getSystemProvider()
javax.jcr.Session	getSystemSession()
String	getTagPath()
Set<String>	getTagPaths()
int	getTagScope()
javax.jcr.Session	getTargetSession()
javax.jcr.Node	getViewNode(String nodeType)
String	getWorkspaceName()
LinkedList<String>	getWorkspacesHistory()
boolean	hasAddPermission()
boolean	hasEditPermission()
boolean	hasPaginator(String nodePath, String workspaceName) Check if node has paginator when viewing it's children.
boolean	hasReadPermission()
boolean	hasRemovePermission()
boolean	isAddingDocument()
boolean	isEditingDocument()
boolean	isFilterSave()
boolean	isPreferenceNode(javax.jcr.Node node)
boolean	isPreferencesSaved()
boolean	isReadAuthorized(org.exoplatform.services.jcr.core.ExtendedNode node)
boolean	isReferenceableNode(javax.jcr.Node node)
boolean	isReferenceNode() Indicates if the current node is a referenced node
boolean	isShowDocumentViewForFile()
boolean	isShowViewFile()
boolean	isSystemWorkspace()
boolean	isViewTag()
void	newJCRTemplateResourceResolver()
boolean	nodeIsLocked(javax.jcr.Node node)
boolean	nodeIsLocked(String path, javax.jcr.Session session)
String	previousWsName()
void	record(String str, String ws)
void	record(String str, String ws, int pageIndex)
void	refreshExplorer()
void	refreshExplorer(javax.jcr.Node currentNode, boolean closePopup)
void	refreshExplorerWithoutClosingPopup()
void	removeTagPath(String tagPath)
String	rewind()
void	setBackNodePath(String previousWorkspaceName, String previousPath) Tells to go back to the given location
void	setBackSelectNode(String workspaceName, String uri)
void	setCheckedSupportType(List<String> checkedSupportType)
void	setCurrentPath(String currentPath) Sets the virtual current path
void	setCurrentState()
void	setCurrentState(String currentStateWorkspaceName, String currentStatePath)
void	setCurrentStatePath(String currentStatePath)
void	setDriveData(DriveData driveData)
void	setFilterSave(boolean isFilterSave)
void	setIsHidePopup(boolean isHidePopup)
void	setIsReferenceNode(boolean isReferenceNode) Tells that the current node is a referenced node
void	setIsViewTag(boolean isViewTag)
void	setLanguage(String language)
void	setPathToAddressBar(String path)
void	setPreferences(Preference preference)
void	setPreferencesSaved(boolean value)
void	setReferenceWorkspace(String referenceWorkspace) Sets the workspace name the referenced node
void	setRenderTemplate(String template)
void	setRepositoryName(String repositoryName) Sets the repository of the current drive
void	setRootPath(String rootPath) Sets the root path
void	setSelectNode(String uri)
void	setSelectNode(String uri, boolean back)
void	setSelectNode(String workspaceName, String uri)
void	setSelectNode(String uri, String homePath, boolean back)
void	setSelectNode(String workspaceName, String uri, String homePath)
void	setSelectRootNode()
void	setShowDocumentViewForFile(boolean value)
void	setTagPath(String tagPath)
void	setTagScope(int scope)
void	setWorkspaceName(String workspaceName) Sets the workspace of the current drive
void	updateAjax(org.exoplatform.webui.event.Event<?> event)

Methods inherited from class org.exoplatform.webui.core.UIContainer

addChild, addChild, findComponentById, findComponentOfType, findFirstComponentOfType, getChild, getChild, getChildById, getChildren, hasChildren, removeChild, removeChildById, renderChild, renderChild, renderChild, renderChild, renderChildren, renderChildren, renderUIComponent, replaceChild, replaceChild, setChildren, setRenderedChild, setRenderedChild, setRenderedChildrenOfTypes

Methods inherited from class org.exoplatform.webui.core.UIComponent

broadcast, buildModelObject, createEvent, createUIComponent, createUIComponent, createUIComponent, doAsync, event, event, event, getAncestorOfType, getApplicationComponent, getComponentConfig, getId, getName, getParent, getTemplate, getTemplateResourceResolver, getUIComponentName, isRendered, loadConfirmMesssage, processAction, processDecode, processRender, renderEventURL, setComponentConfig, setComponentConfig, setId, setParent, setRendered, setRenderSibling, url, url, url

Methods inherited from class java.lang.Object

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

Constructor Detail

UIJCRExplorer

public UIJCRExplorer()
              throws Exception

Throws:

Exception

Method Detail

getAllItemFilterMap

public Set<String> getAllItemFilterMap()

getAllItemByTypeFilterMap

public Set<String> getAllItemByTypeFilterMap()

getTagScope

public int getTagScope()

setTagScope

public void setTagScope(int scope)

isFilterSave

public boolean isFilterSave()

setFilterSave

public void setFilterSave(boolean isFilterSave)

isShowDocumentViewForFile

public boolean isShowDocumentViewForFile()

setShowDocumentViewForFile

public void setShowDocumentViewForFile(boolean value)

isPreferencesSaved

public boolean isPreferencesSaved()

setPreferencesSaved

public void setPreferencesSaved(boolean value)

isAddingDocument

public boolean isAddingDocument()

isEditingDocument

public boolean isEditingDocument()

getCheckedSupportType

public List<String> getCheckedSupportType()

setCheckedSupportType

public void setCheckedSupportType(List<String> checkedSupportType)

filterPath

public String filterPath(String currentPath)
                  throws Exception

Throws:

Exception

setRootPath

public void setRootPath(String rootPath)

Sets the root path

getRootNode

public javax.jcr.Node getRootNode()
                           throws Exception

Returns:

the root node itself if it is not a link otherwise the target node (= resolve the link)

Throws:

Exception

getRootPath

public String getRootPath()

Returns:

the root path

getCurrentNode

public javax.jcr.Node getCurrentNode()
                              throws Exception

Returns:

the current node itself if it is not a link otherwise the target node (= resolve the link)

Throws:

Exception

getRealCurrentNode

public javax.jcr.Node getRealCurrentNode()
                                  throws Exception

Returns:

the current node even if it is a link (= don't resolve the link)

Throws:

Exception

getCurrentPath

public String getCurrentPath()

Returns:

the virtual current path

setCurrentPath

public void setCurrentPath(String currentPath)

Sets the virtual current path

isReferenceNode

public boolean isReferenceNode()

Indicates if the current node is a referenced node

setIsReferenceNode

public void setIsReferenceNode(boolean isReferenceNode)

Tells that the current node is a referenced node

setReferenceWorkspace

public void setReferenceWorkspace(String referenceWorkspace)

Sets the workspace name the referenced node

getReferenceWorkspace

public String getReferenceWorkspace()

setBackNodePath

public void setBackNodePath(String previousWorkspaceName,
                            String previousPath)
                     throws Exception

Tells to go back to the given location

Throws:

Exception

hasPaginator

public boolean hasPaginator(String nodePath,
                            String workspaceName)
                     throws Exception

Check if node has paginator when viewing it's children.

Parameters:

nodePath -

workspaceName -

Returns:

Throws:

Exception

setDriveData

public void setDriveData(DriveData driveData)

getDriveData

public DriveData getDriveData()

setLanguage

public void setLanguage(String language)

getLanguage

public String getLanguage()

getNodesHistory

public LinkedList<String> getNodesHistory()

getWorkspacesHistory

public LinkedList<String> getWorkspacesHistory()

getHistory

public Collection<UIJCRExplorer.HistoryEntry> getHistory()

getSessionProvider

public org.exoplatform.services.jcr.ext.common.SessionProvider getSessionProvider()

getSystemProvider

public org.exoplatform.services.jcr.ext.common.SessionProvider getSystemProvider()

getTargetSession

public javax.jcr.Session getTargetSession()
                                   throws Exception

Returns:

the session of the current node (= UIJCRExplorer.getCurrentNode())

Throws:

Exception

getSession

public javax.jcr.Session getSession()
                             throws Exception

Throws:

Exception

getWorkspaceName

public String getWorkspaceName()

getSystemSession

public javax.jcr.Session getSystemSession()
                                   throws Exception

Throws:

Exception

getDocumentInfoTemplate

public String getDocumentInfoTemplate()

setRenderTemplate

public void setRenderTemplate(String template)

setCurrentState

public void setCurrentState()

setCurrentState

public void setCurrentState(String currentStateWorkspaceName,
                            String currentStatePath)

getCurrentStatePath

public String getCurrentStatePath()

setCurrentStatePath

public void setCurrentStatePath(String currentStatePath)

getCurrentStateNode

public javax.jcr.Node getCurrentStateNode()
                                   throws Exception

Throws:

Exception

getJCRTemplateResourceResolver

public JCRResourceResolver getJCRTemplateResourceResolver()

newJCRTemplateResourceResolver

public void newJCRTemplateResourceResolver()

setRepositoryName

public void setRepositoryName(String repositoryName)

Sets the repository of the current drive

getRepositoryName

public String getRepositoryName()

Returns:

the repository of the current drive

setWorkspaceName

public void setWorkspaceName(String workspaceName)

Sets the workspace of the current drive

getCurrentDriveWorkspace

public String getCurrentDriveWorkspace()

Returns:

the workspace of the current drive

getCurrentWorkspace

public String getCurrentWorkspace()

Returns:

the workspace of the session of the current node (= UIJCRExplorer.getCurrentNode())

getRepository

public org.exoplatform.services.jcr.core.ManageableRepository getRepository()
                                                                     throws Exception

Throws:

Exception

getSessionByWorkspace

public javax.jcr.Session getSessionByWorkspace(String wsName)
                                        throws Exception

Throws:

Exception

isSystemWorkspace

public boolean isSystemWorkspace()
                          throws Exception

Throws:

Exception

refreshExplorer

public void refreshExplorer()
                     throws Exception

Throws:

Exception

refreshExplorerWithoutClosingPopup

public void refreshExplorerWithoutClosingPopup()
                                        throws Exception

Throws:

Exception

setPathToAddressBar

public void setPathToAddressBar(String path)
                         throws Exception

Throws:

Exception

refreshExplorer

public void refreshExplorer(javax.jcr.Node currentNode,
                            boolean closePopup)
                     throws Exception

Throws:

Exception

nodeIsLocked

public boolean nodeIsLocked(String path,
                            javax.jcr.Session session)
                     throws Exception

Throws:

Exception

nodeIsLocked

public boolean nodeIsLocked(javax.jcr.Node node)
                     throws Exception

Throws:

Exception

addLockToken

public void addLockToken(javax.jcr.Node node)
                  throws Exception

Allows you to add a lock token to the given node

Throws:

Exception

hasAddPermission

public boolean hasAddPermission()

hasEditPermission

public boolean hasEditPermission()

hasRemovePermission

public boolean hasRemovePermission()

hasReadPermission

public boolean hasReadPermission()

getViewNode

public javax.jcr.Node getViewNode(String nodeType)
                           throws Exception

Throws:

Exception

getMultiValues

public List<String> getMultiValues(javax.jcr.Node node,
                                   String name)
                            throws Exception

Throws:

Exception

setIsHidePopup

public void setIsHidePopup(boolean isHidePopup)

updateAjax

public void updateAjax(org.exoplatform.webui.event.Event<?> event)
                throws Exception

Throws:

Exception

isShowViewFile

public boolean isShowViewFile()
                       throws Exception

Throws:

Exception

cancelAction

public void cancelAction()
                  throws Exception

Throws:

Exception

record

public void record(String str,
                   String ws)

record

public void record(String str,
                   String ws,
                   int pageIndex)

clearNodeHistory

public void clearNodeHistory(String currentPath)

clearTagSelection

public void clearTagSelection()

rewind

public String rewind()

previousWsName

public String previousWsName()

setSelectNode

public void setSelectNode(String workspaceName,
                          String uri)
                   throws Exception

Throws:

Exception

setSelectNode

public void setSelectNode(String workspaceName,
                          String uri,
                          String homePath)
                   throws Exception

Throws:

Exception

setBackSelectNode

public void setBackSelectNode(String workspaceName,
                              String uri)
                       throws Exception

Throws:

Exception

setSelectRootNode

public void setSelectRootNode()
                       throws Exception

Throws:

Exception

setSelectNode

public void setSelectNode(String uri)
                   throws Exception

Throws:

Exception

setSelectNode

public void setSelectNode(String uri,
                          boolean back)
                   throws Exception

Throws:

Exception

setSelectNode

public void setSelectNode(String uri,
                          String homePath,
                          boolean back)
                   throws Exception

Throws:

Exception

getChildrenList

public List<javax.jcr.Node> getChildrenList(String path,
                                            boolean isReferences)
                                     throws Exception

Throws:

Exception

isReferenceableNode

public boolean isReferenceableNode(javax.jcr.Node node)
                            throws Exception

Throws:

Exception

isPreferenceNode

public boolean isPreferenceNode(javax.jcr.Node node)

getNodeByPath

public javax.jcr.Node getNodeByPath(String nodePath,
                                    javax.jcr.Session session)
                             throws Exception

Throws:

Exception

getNodeByPath

public javax.jcr.Node getNodeByPath(String nodePath,
                                    javax.jcr.Session session,
                                    boolean giveTarget)
                             throws Exception

Throws:

Exception

setTagPath

public void setTagPath(String tagPath)

getTagPaths

public Set<String> getTagPaths()

getTagPath

public String getTagPath()

removeTagPath

public void removeTagPath(String tagPath)

getDocumentByTag

public List<javax.jcr.Node> getDocumentByTag()
                                      throws Exception

Throws:

Exception

setIsViewTag

public void setIsViewTag(boolean isViewTag)

isViewTag

public boolean isViewTag()

getPortletPreferences

public javax.portlet.PortletPreferences getPortletPreferences()

isReadAuthorized

public boolean isReadAuthorized(org.exoplatform.services.jcr.core.ExtendedNode node)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCookieByCookieName

public static javax.servlet.http.Cookie getCookieByCookieName(String cookieName,
                                                              javax.servlet.http.Cookie[] cookies)

getPreference

public Preference getPreference()

setPreferences

public void setPreferences(Preference preference)

closeEditingFile

public void closeEditingFile()
                      throws Exception

Throws:

Exception