org.nuxeo.ecm.webapp.clipboard
Interface Summary

All Superinterfaces:

java.util.Map<java.lang.String,SummaryEntry>

All Known Implementing Classes:

SummaryImpl

public interface Summary
extends java.util.Map<java.lang.String,SummaryEntry>

This class is used to build the summary file in a Zip export. It can displays a summary in two ways:

• Flat with for all entries the full path to document
• Hierarchical.

This class extends Map<String,SummaryEntry> to store all entries and to allows to store the same document many times, at different level in the workingList. That's why the key is a String : the full path to the item in the workingList, using documents UUID.

Author:

Brice Chaffangeon

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

java.lang.String	displayEntry(java.lang.StringBuffer sb, SummaryEntry parentEntry) Displays recursively on entry.
java.util.List<SummaryEntry>	getChildren(SummaryEntry parentEntry)
SummaryEntry	getSummaryRoot() Gets the root SummaryEntry in the map.
boolean	hasChild(SummaryEntry parentEntry) Tests if the given entry has at least one child in the map.
java.lang.String	toFlatList() Display all the map in a flat way.
java.lang.String	toTreeString() Displays all the map hierarchically.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

hasChild

boolean hasChild(SummaryEntry parentEntry)

Tests if the given entry has at least one child in the map.

Parameters:

parentEntry - is the entry to test

Returns:

true if there is at least one child

getChildren

java.util.List<SummaryEntry> getChildren(SummaryEntry parentEntry)

Parameters:

parentEntry - is parent of children you want to get

Returns:

all the children of the parentEntry in the List

displayEntry

java.lang.String displayEntry(java.lang.StringBuffer sb,
                              SummaryEntry parentEntry)

Displays recursively on entry.

Parameters:

sb - is the String to display.

parentEntry - is the entry to display

Returns:

the String to display

toFlatList

java.lang.String toFlatList()

Display all the map in a flat way. The display is ordered by path.

Returns:

the string to display

toTreeString

java.lang.String toTreeString()

Displays all the map hierarchically.

Returns:

the string to display

getSummaryRoot

SummaryEntry getSummaryRoot()

Gets the root SummaryEntry in the map.

Returns:

the root SummaryEntry in the map