info.magnolia.ui.workbench.tree

Class HierarchicalJcrContainer

java.lang.Object

info.magnolia.ui.workbench.container.AbstractContainer

info.magnolia.ui.workbench.container.AbstractJcrContainer

info.magnolia.ui.workbench.tree.HierarchicalJcrContainer

All Implemented Interfaces:

com.vaadin.v7.data.Container, com.vaadin.v7.data.Container.Hierarchical, com.vaadin.v7.data.Container.Indexed, com.vaadin.v7.data.Container.ItemSetChangeNotifier, com.vaadin.v7.data.Container.Ordered, com.vaadin.v7.data.Container.Sortable, Refreshable, Serializable

public class HierarchicalJcrContainer
extends AbstractJcrContainer
implements com.vaadin.v7.data.Container.Hierarchical

Hierarchical implementation of AbstractJcrContainer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HierarchicalJcrContainer.ItemsSortedEvent Implementation of items sorted event.

Nested classes/interfaces inherited from class info.magnolia.ui.workbench.container.AbstractContainer

AbstractContainer.ItemSetChangeEvent, AbstractContainer.PropertySetChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Container

com.vaadin.v7.data.Container.Editor, com.vaadin.v7.data.Container.Filter, com.vaadin.v7.data.Container.Filterable, com.vaadin.v7.data.Container.Hierarchical, com.vaadin.v7.data.Container.Indexed, com.vaadin.v7.data.Container.ItemSetChangeEvent, com.vaadin.v7.data.Container.ItemSetChangeListener, com.vaadin.v7.data.Container.ItemSetChangeNotifier, com.vaadin.v7.data.Container.Ordered, com.vaadin.v7.data.Container.PropertySetChangeEvent, com.vaadin.v7.data.Container.PropertySetChangeListener, com.vaadin.v7.data.Container.PropertySetChangeNotifier, com.vaadin.v7.data.Container.SimpleFilterable, com.vaadin.v7.data.Container.Sortable, com.vaadin.v7.data.Container.Viewer

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Container.Indexed

com.vaadin.v7.data.Container.Indexed.ItemAddEvent, com.vaadin.v7.data.Container.Indexed.ItemRemoveEvent

Field Summary

Fields inherited from class info.magnolia.ui.workbench.container.AbstractJcrContainer

ASCENDING_KEYWORD, DEFAULT_CACHE_RATIO, DEFAULT_NODE_TYPE, DEFAULT_PAGE_LENGTH, DESCENDING_KEYWORD, JCR_NAME_FUNCTION, ORDER_BY, PROPERTY_NAME_AND_UUID_SEPARATOR, SELECT_TEMPLATE, SELECTOR_NAME, sorters, WHERE_TEMPLATE_FOR_PATH

Constructor Summary

Constructors

Constructor and Description
HierarchicalJcrContainer(JcrContentConnectorDefinition definition)

Method Summary

Modifier and Type	Method and Description
boolean	areChildrenAllowed(Object itemId)
protected Collection<JcrItemId>	createContainerIds(Collection<javax.jcr.Item> children)
Collection<javax.jcr.Item>	getChildren(javax.jcr.Item item)
Collection<JcrItemId>	getChildren(Object itemId)
JcrItemId	getParent(Object itemId)
protected String	getQueryWhereClause()
protected String	getQueryWhereClauseNodeTypes()
Collection<javax.jcr.Item>	getRootItemIds()
protected javax.jcr.Node	getRootNode()
boolean	hasChildren(Object itemId)
boolean	isIncludingSystemProperties()
protected boolean	isNodeVisible(javax.jcr.Node node)
boolean	isRoot(javax.jcr.Item item) Checks if an item is a root.
boolean	isRoot(Object itemId)
boolean	isSortable()
void	refresh() Refreshes the container - clears all caches and resets size and offset.
Collection<JcrItemId>	rootItemIds()
boolean	setChildrenAllowed(Object itemId, boolean areChildrenAllowed)
void	setIncludeSystemProperties(boolean includingSystemProperties)
boolean	setParent(Object itemId, Object newParentId)
void	setSortable(boolean sortable)
void	sort(Object[] propertyId, boolean[] ascending) ******************************************

Methods inherited from class info.magnolia.ui.workbench.container.AbstractJcrContainer

addItem, addItem, addItemAfter, addItemAfter, addItemAt, addItemAt, addItemSetChangeListener, addListener, addSortableProperty, clearItemIndexes, constructJCRQuery, containsId, ensureItemIndices, executeQuery, findSearchableNodeTypes, fireItemSetChange, fireItemSetChange, firstItemId, getCacheRatio, getConfiguration, getContainerProperty, getCurrentOffset, getDefaultOrderBy, getIdByIndex, getItem, getItemIds, getItemIds, getItemIndexes, getJcrItem, getJcrNameOrderByFunction, getMainNodeType, getPage, getPageLength, getQuerySelectStatement, getQueryWhereClauseWorkspacePath, getSearchableNodeTypes, getSortableContainerPropertyIds, getWorkspace, handleRepositoryException, indexOfId, isFirstId, isLastId, lastItemId, nextItemId, prevItemId, removeAllItems, removeItem, removeItemSetChangeListener, removeListener, resetOffset, setCacheRatio, setPageLength, setSize, size, updateSize

Methods inherited from class info.magnolia.ui.workbench.container.AbstractContainer

addContainerProperty, getContainerPropertyIds, getType, removeContainerProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.v7.data.Container.Hierarchical

removeItem

Methods inherited from interface com.vaadin.v7.data.Container

addContainerProperty, addItem, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getType, removeAllItems, removeContainerProperty, size

Constructor Detail

HierarchicalJcrContainer

public HierarchicalJcrContainer(JcrContentConnectorDefinition definition)

Method Detail

getChildren

public Collection<JcrItemId> getChildren(Object itemId)

Specified by:

getChildren in interface com.vaadin.v7.data.Container.Hierarchical

getParent

public JcrItemId getParent(Object itemId)

Specified by:

getParent in interface com.vaadin.v7.data.Container.Hierarchical

rootItemIds

public Collection<JcrItemId> rootItemIds()

Specified by:

rootItemIds in interface com.vaadin.v7.data.Container.Hierarchical

refresh

public void refresh()

Description copied from class: AbstractJcrContainer

Refreshes the container - clears all caches and resets size and offset. Does NOT remove sorting or filtering rules!

Specified by:

refresh in interface Refreshable

Overrides:

refresh in class AbstractJcrContainer

setParent

public boolean setParent(Object itemId,
                         Object newParentId)
                  throws UnsupportedOperationException

Specified by:

setParent in interface com.vaadin.v7.data.Container.Hierarchical

Throws:

UnsupportedOperationException

areChildrenAllowed

public boolean areChildrenAllowed(Object itemId)

Specified by:

areChildrenAllowed in interface com.vaadin.v7.data.Container.Hierarchical

setChildrenAllowed

public boolean setChildrenAllowed(Object itemId,
                                  boolean areChildrenAllowed)
                           throws UnsupportedOperationException

Specified by:

setChildrenAllowed in interface com.vaadin.v7.data.Container.Hierarchical

Throws:

UnsupportedOperationException

isRoot

public boolean isRoot(Object itemId)

Specified by:

isRoot in interface com.vaadin.v7.data.Container.Hierarchical

hasChildren

public boolean hasChildren(Object itemId)

Specified by:

hasChildren in interface com.vaadin.v7.data.Container.Hierarchical

sort

public void sort(Object[] propertyId,
                 boolean[] ascending)

Description copied from class: AbstractJcrContainer

******************************************

Specified by:

sort in interface com.vaadin.v7.data.Container.Sortable

Overrides:

sort in class AbstractJcrContainer

setIncludeSystemProperties

public void setIncludeSystemProperties(boolean includingSystemProperties)

isIncludingSystemProperties

public boolean isIncludingSystemProperties()

createContainerIds

protected Collection<JcrItemId> createContainerIds(Collection<javax.jcr.Item> children)

getChildren

public Collection<javax.jcr.Item> getChildren(javax.jcr.Item item)

isNodeVisible

protected boolean isNodeVisible(javax.jcr.Node node)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getRootItemIds

public Collection<javax.jcr.Item> getRootItemIds()
                                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isRoot

public boolean isRoot(javax.jcr.Item item)
               throws javax.jcr.RepositoryException

Checks if an item is a root. Since root node is never shown, we consider its child nodes and properties as roots to remove unnecessary offset in trees.

Throws:

javax.jcr.RepositoryException

getQueryWhereClause

protected String getQueryWhereClause()

Overrides:

getQueryWhereClause in class AbstractJcrContainer

Returns:

the JCR query where clause to select only node types which are not hidden in list and nodes under the path configured in the workspace as String - if the latter is not configured return a blank string so that all nodes are considered.

See Also:

AbstractJcrContainer.getQueryWhereClauseNodeTypes(), AbstractJcrContainer.getQueryWhereClauseWorkspacePath()

getQueryWhereClauseNodeTypes

protected String getQueryWhereClauseNodeTypes()

Overrides:

getQueryWhereClauseNodeTypes in class AbstractJcrContainer

Returns:

a String containing the node types to be displayed in a list view and searched for in a query. All node types declared in a workbench definition are returned unless their hideInList property is true or the node is of type mgnl:folder (custom implementations of this method may still decide to display folders). Assuming a node types declaration like the following

 ...
 + workbench
  + nodeTypes
   + foo
    * name = nt:foo
   + bar
    * name = nt:bar
    * hideInList = true
   + baz (a mixin type)
    * name = nt:baz
 ...
 

this method will return the following string [jcr:primaryType] = 'nt:foo' or [jcr:mixinTypes] = 'baz'. This will eventually be used to restrict the node types to be displayed in list views and searched for in search views, i.e. select * from [nt:base] where ([jcr:primaryType] = 'nt:foo' or [jcr:mixinTypes] = 'baz').

See Also:

AbstractJcrContainer.findSearchableNodeTypes()

getRootNode

protected javax.jcr.Node getRootNode()
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isSortable

public boolean isSortable()

setSortable

public void setSortable(boolean sortable)