org.nuxeo.ecm.webapp.directory

Class VocabularyTreeNode

java.lang.Object

org.nuxeo.ecm.webapp.directory.VocabularyTreeNode

public class VocabularyTreeNode
extends Object

A vocabulary tree node based on l10nvocabulary or l10nxvocabulary directory. These schemas store translations in columns of the form label_xx_XX or label_xx. The label of a node is retrieved from column label_xx_XX (where xx_XX is the current locale name) if it exists, from column label_xx (where xx is the current locale language) else. If this one doesn't exist either, the english label (from label_en) is used.

Since:

5.5

Author:

Quentin Lamerand

Field Summary

Fields

Modifier and Type	Field and Description
protected List<VocabularyTreeNode>	children
protected DocumentModelList	childrenEntries
static String	DEFAULT_LANGUAGE
protected DirectoryService	directoryService
protected boolean	displayObsoleteEntries
protected String	id
protected char	keySeparator
protected String	label
static String	LABEL_FIELD_PREFIX
protected int	level
static String	OBSOLETE_FIELD
protected String	orderingField
protected Comparable	orderingValue
static String	PARENT_FIELD_ID
protected String	path
protected String	vocabularyName

Constructor Summary

Constructors

Constructor and Description
VocabularyTreeNode(int level, String id, String description, String path, String vocabularyName, DirectoryService directoryService)
VocabularyTreeNode(int level, String id, String description, String path, String vocabularyName, DirectoryService directoryService, boolean displayObsoleteEntries, char keySeparator, String orderingField)
VocabularyTreeNode(int level, String id, String description, String path, String vocabularyName, DirectoryService directoryService, boolean displayObsoleteEntries, char keySeparator, String orderingField, Comparable orderingValue)

Method Summary

Modifier and Type	Method and Description
static String	computeLabel(Locale locale, DocumentModel entry, String schemaName)
List<VocabularyTreeNode>	getChildren()
protected DocumentModelList	getChildrenEntries()
protected String	getDirectorySchema()
protected DirectoryService	getDirectoryService()
protected Session	getDirectorySession()
String	getId()
String	getLabel()
Comparable	getOrdering()
String	getPath()

Methods inherited from class java.lang.Object

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

Field Detail

PARENT_FIELD_ID

public static final String PARENT_FIELD_ID

See Also:

Constant Field Values

LABEL_FIELD_PREFIX

public static final String LABEL_FIELD_PREFIX

See Also:

Constant Field Values

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

See Also:

Constant Field Values

OBSOLETE_FIELD

public static final String OBSOLETE_FIELD

See Also:

Constant Field Values

path

protected final String path

level

protected final int level

id

protected String id

label

protected String label

directoryService

protected DirectoryService directoryService

children

protected List<VocabularyTreeNode> children

vocabularyName

protected String vocabularyName

childrenEntries

protected DocumentModelList childrenEntries

displayObsoleteEntries

protected boolean displayObsoleteEntries

orderingField

protected String orderingField

orderingValue

protected Comparable orderingValue

keySeparator

protected char keySeparator

Constructor Detail

VocabularyTreeNode

public VocabularyTreeNode(int level,
                          String id,
                          String description,
                          String path,
                          String vocabularyName,
                          DirectoryService directoryService)

VocabularyTreeNode

public VocabularyTreeNode(int level,
                          String id,
                          String description,
                          String path,
                          String vocabularyName,
                          DirectoryService directoryService,
                          boolean displayObsoleteEntries,
                          char keySeparator,
                          String orderingField)

VocabularyTreeNode

public VocabularyTreeNode(int level,
                          String id,
                          String description,
                          String path,
                          String vocabularyName,
                          DirectoryService directoryService,
                          boolean displayObsoleteEntries,
                          char keySeparator,
                          String orderingField,
                          Comparable orderingValue)

Method Detail

getChildren

public List<VocabularyTreeNode> getChildren()

computeLabel

public static String computeLabel(Locale locale,
                                  DocumentModel entry,
                                  String schemaName)

getChildrenEntries

protected DocumentModelList getChildrenEntries()

getId

public String getId()

getLabel

public String getLabel()

getPath

public String getPath()

getOrdering

public Comparable getOrdering()

getDirectoryService

protected DirectoryService getDirectoryService()

getDirectorySchema

protected String getDirectorySchema()

getDirectorySession

protected Session getDirectorySession()