OTreeNode (ontimize-core 5.6.0 API)

java.lang.Object
- javax.swing.tree.DefaultMutableTreeNode
- - com.ontimize.gui.tree.OTreeNode

All Implemented Interfaces:

Internationalization, Serializable, Cloneable, Comparable, MutableTreeNode, TreeNode

Direct Known Subclasses:

PageFetchTreeNode
```
public class OTreeNode
extends DefaultMutableTreeNode
implements Comparable, Internationalization
```
Main class that represents a tree node. It implements Comparable to allow order the nodes. These ones could be organizational or data nodes. Organizational nodes creates the tree structure and data nodes are correspondent with database records.

XML parameters in constructor OTreeNode(Hashtable)

Since:

5.2000 Default implementation, 5.2060EN Pageable tree.

Author:

Imatia Innovation SL

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`ascending`
`protected String`	`associateDataFieldString`
`protected Hashtable`	`associatedDataField`
`protected Vector`	`associatedOrderedDataField` List that contains associatedFields(parentKeys) ordered.
`static String`	`ATTR`
`protected Hashtable`	`attributeEquivalences`
`protected String`	`attrString`
`protected String`	`cachedText`
`static String`	`CAN_DELETE`
`protected boolean`	`canDelete`
`static String`	`CLASSIFY_NODE`
`protected boolean`	`classifyNode`
`protected static Collator`	`comparator`
`protected static Locale`	`componentLocale`
`protected int`	`count`
`static boolean`	`defaultPageableEnabled`
`static String`	`DESC`
`protected static SimpleDateFormat`	`df`
`protected static SimpleDateFormat`	`dfH`
`protected boolean`	`dynamic`
`static String`	`DYNAMIC`
`static String`	`DYNAMIC_FORM`
`static String`	`DYNAMICFORM`
`protected String`	`dynamicFormClass`
`protected DynamicFormManager`	`dynamicFormManager`
`protected boolean`	`emptyNode`
`static String`	`ENTITY`
`protected String`	`entityName`
`static String`	`FIX_ATTR`
`protected Vector`	`fixAtributtes`
`static String`	`FORM`
`protected Vector`	`hiddenAttributes`
`static String`	`HIDE_ATTR`
`static String`	`ICON_NO_ORG`
`static String`	`ICON_ORG`
`protected ImageIcon`	`iconnoorg`
`protected String`	`iconnoorgStr`
`protected ImageIcon`	`iconorg`
`protected String`	`iconorgStr`
`protected String`	`id`
`static String`	`ID`
`protected Vector`	`keyList`
`static String`	`KEYS`
`static String`	`KEYS_VALUES`
`protected String`	`keysString`
`protected Hashtable`	`keysValues`
`protected boolean`	`leaf`
`protected String`	`orderByAttribute`
`protected boolean`	`orderToAdd`
`static String`	`ORG`
`protected boolean`	`organization`
`protected boolean`	`overrideLeaf`
`static String`	`PAGEABLE_ICON`
`protected boolean`	`pageableEnabled`
`protected ImageIcon`	`pageableIcon`
`protected Hashtable`	`parameters`
`static String`	`PARENT_KEYS`
`static String`	`QUERY_ROWS`
`protected Hashtable`	`queryResult`
`protected boolean`	`remark`
`protected List`	`renderTime`
`protected ResourceBundle`	`resourceArchive`
`protected int`	`rowsNumberToQuery`
`protected String`	`separator`
`static String`	`SEPARATOR`
`protected String`	`shownAttribute`
`protected Vector`	`shownAttributeList`
`protected String`	`shownForm`
`static String`	`SORT` Parameter to order nodes (sort="desc" / sort="asc").
`static String`	`SORTATTR`
`protected String`	`stringFixAttr`
`protected String`	`stringHideAttr`
`protected Object`	`text`
`static String`	`TEXT`
`static String`	`THERE_ARENT_RESULTS_KEY`
`static String`	`THERE_ARENT_RESULTS_KEY_es_ES`
`protected int`	`totalCount`

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Fields inherited from interface com.ontimize.gui.i18n.Internationalization
DEBUG_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

OTreeNode(Hashtable parameters)
This method uses the Hashtable and creates the tree node.

Constructors
Constructor and Description
`OTreeNode(Hashtable parameters)` This method uses the `Hashtable` and creates the tree node.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(MutableTreeNode node)` Overrides the method add to insert a node in a sorted tree.
`boolean`	`canDelete()`
`Object`	`clone()`
`OTreeNode`	`cloneNodeAndChildren()` Get a copy of the node and all the children
`protected OTreeNode`	`cloneThisAndChildren()`
`int`	`compareTo(Object object)`
`void`	`disableNodeSorting()` Allows to disable sorting in nodes.
`void`	`enableNodeSorting()` Enables sorting in node.
`protected void`	`finalize()`
`boolean`	`getAscending()`
`Hashtable`	`getAssociatedDataField()`
`Vector`	`getAssociatedOrderedDataField()`
`String`	`getAttr()`
`String[]`	`getAttributes()`
`Vector`	`getChildren()` Method to obtain children of a node.
`int`	`getCount()`
`DynamicFormManager`	`getDynamicFormManager()`
`String`	`getDynamicFormManagerClass()`
`String`	`getEntityName()`
`String`	`getFixAttr()`
`Vector`	`getFixAttributes()`
`String`	`getForm()`
`String`	`getHideAttr()`
`ImageIcon`	`getIcon()` Returns the icon to use with this node.
`String`	`getIconNoOrg()`
`String`	`getIconOrg()`
`String`	`getId()`
`Vector`	`getKeys()`
`String`	`getKeysString()`
`Hashtable`	`getKeysValues()` Returns a `Hashtable` where keys are attributes specified in keysValues, and values are their correspondent values.
`Hashtable`	`getNodeData()` Returns node keyvalues.
`String`	`getOrderByAttribute()`
`ImageIcon`	`getPageableIcon()`
`Hashtable`	`getParameters()`
`String`	`getParentKeyNameInParentNode(String parentKey)`
`Vector`	`getParentKeys()`
`Hashtable`	`getQueryResult()`
`boolean`	`getRemark()`
`int`	`getRowsNumberToQuery()`
`String`	`getSeparator()`
`Vector`	`getShownAttributeList()`
`String`	`getSortAttr()`
`String`	`getStringAssociatedDataField()`
`String`	`getText()`
`Vector`	`getTextsToTranslate()` Returns all the texts in the element suitable for being translated.
`int`	`getTotalCount()`
`Object`	`getUserObject()`
`Object`	`getValueForAttribute(Object attribute)`
`Vector`	`getVisibleAttributes()`
`boolean`	`isClassifyNode()`
`boolean`	`isDynamic()`
`boolean`	`isEmptyNode()`
`boolean`	`isLeaf()`
`boolean`	`isOrganizational()`
`boolean`	`isPageableEnabled()`
`void`	`setAssociatedDataField(Hashtable associatedFields)`
`void`	`setAssociatedOrderedDataField(Vector associatedOrderedDataField)`
`void`	`setAttribute(String attribute, Object value)`
`void`	`setAttributes(Vector attributes)`
`void`	`setAttributeText(String attr, String equivalence)`
`void`	`setClassifyNode(boolean classify)`
`void`	`setComponentLocale(Locale l)`
`void`	`setCount(int c)`
`void`	`setDynamic(boolean d)`
`void`	`setDynamicFormManager(DynamicFormManager dfm)`
`void`	`setEmptyNode(boolean emptyNode)`
`void`	`setEntityName(String entityName)`
`void`	`setForm(String form)`
`void`	`setKeys(Vector keys)`
`void`	`setKeysValues(Hashtable keysValues)` Establishes key values and attributes for this node, that is 'attr' and 'keys' specified in xml definition.
`void`	`setKeysValues(Object key, Object value)`
`void`	`setOrganizational(boolean o)`
`void`	`setOverrideLeaf(boolean override, boolean leaf)`
`void`	`setPageableIcon(ImageIcon pageableIcon)`
`void`	`setQueryResult(Hashtable result)`
`void`	`setRemark(boolean remark)` Indicates when node must show a special icon, for example, when its data have changed and tree has not been updated yet.
`void`	`setResourceBundle(ResourceBundle resources)` Sets the language resource bundle.
`void`	`setSeparator(String separator)`
`void`	`setSortAttr(String sortAttr)`
`void`	`setSortOrder(boolean ascendingSort)`
`void`	`setText(String textToShow)`
`void`	`setToString(String s)`
`void`	`setTotalCount(int totalRecordCount)`
`void`	`setUserObject(Object value)`
`void`	`sortNow()` Sorts child nodes with order: ascending or descending.
`String`	`toString()`
`protected void`	`updateNodeTextCache()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

THERE_ARENT_RESULTS_KEY

public static final String THERE_ARENT_RESULTS_KEY

See Also:: Constant Field Values

THERE_ARENT_RESULTS_KEY_es_ES

public static final String THERE_ARENT_RESULTS_KEY_es_ES

See Also:: Constant Field Values

ENTITY
```
public static final String ENTITY
```
See Also:
Constant Field Values

KEYS
```
public static final String KEYS
```
See Also:
Constant Field Values

KEYS_VALUES
```
public static final String KEYS_VALUES
```
See Also:
Constant Field Values

ATTR
```
public static final String ATTR
```
See Also:
Constant Field Values

TEXT
```
public static final String TEXT
```
See Also:
Constant Field Values

FORM
```
public static final String FORM
```
See Also:
Constant Field Values

ORG
```
public static final String ORG
```
See Also:
Constant Field Values

PARENT_KEYS
```
public static final String PARENT_KEYS
```
See Also:
Constant Field Values

ICON_ORG
```
public static final String ICON_ORG
```
See Also:
Constant Field Values

ICON_NO_ORG
```
public static final String ICON_NO_ORG
```
See Also:
Constant Field Values

PAGEABLE_ICON

public static final String PAGEABLE_ICON

See Also:: Constant Field Values

ID
```
public static final String ID
```
See Also:
Constant Field Values

SEPARATOR
```
public static final String SEPARATOR
```
See Also:
Constant Field Values

SORTATTR
```
public static final String SORTATTR
```
See Also:
Constant Field Values

SORT
```
public static final String SORT
```
Parameter to order nodes (sort="desc" / sort="asc"). By default, "asc"

See Also:
Constant Field Values

DESC
```
public static final String DESC
```
See Also:
Constant Field Values

FIX_ATTR
```
public static final String FIX_ATTR
```
See Also:
Constant Field Values

HIDE_ATTR
```
public static final String HIDE_ATTR
```
See Also:
Constant Field Values

CAN_DELETE
```
public static final String CAN_DELETE
```
See Also:
Constant Field Values

DYNAMIC_FORM

public static final String DYNAMIC_FORM

See Also:: Constant Field Values

DYNAMICFORM
```
public static final String DYNAMICFORM
```
See Also:
Constant Field Values

DYNAMIC
```
public static final String DYNAMIC
```
See Also:
Constant Field Values

CLASSIFY_NODE

public static final String CLASSIFY_NODE

See Also:: Constant Field Values

QUERY_ROWS
```
public static final String QUERY_ROWS
```
See Also:
Constant Field Values

defaultPageableEnabled

public static boolean defaultPageableEnabled

shownForm
```
protected String shownForm
```

entityName
```
protected String entityName
```

shownAttribute
```
protected String shownAttribute
```

text
```
protected Object text
```

organization
```
protected boolean organization
```

keyList
```
protected Vector keyList
```

keysString
```
protected String keysString
```

keysValues
```
protected Hashtable keysValues
```

associatedDataField

protected Hashtable associatedDataField

associatedOrderedDataField
```
protected Vector associatedOrderedDataField
```
List that contains associatedFields(parentKeys) ordered.

associateDataFieldString

protected String associateDataFieldString

stringFixAttr
```
protected String stringFixAttr
```

stringHideAttr
```
protected String stringHideAttr
```

hiddenAttributes
```
protected Vector hiddenAttributes
```

canDelete
```
protected boolean canDelete
```

cachedText
```
protected String cachedText
```

classifyNode
```
protected boolean classifyNode
```

dynamic
```
protected boolean dynamic
```

attributeEquivalences

protected Hashtable attributeEquivalences

queryResult
```
protected Hashtable queryResult
```

separator
```
protected String separator
```

ascending
```
protected boolean ascending
```

shownAttributeList
```
protected Vector shownAttributeList
```

attrString
```
protected String attrString
```

orderToAdd
```
protected boolean orderToAdd
```

iconorg
```
protected ImageIcon iconorg
```

iconnoorg
```
protected ImageIcon iconnoorg
```

pageableIcon
```
protected ImageIcon pageableIcon
```

iconorgStr
```
protected String iconorgStr
```

iconnoorgStr
```
protected String iconnoorgStr
```

emptyNode
```
protected boolean emptyNode
```

remark
```
protected boolean remark
```

pageableEnabled
```
protected boolean pageableEnabled
```

id
```
protected String id
```

orderByAttribute
```
protected String orderByAttribute
```

fixAtributtes
```
protected Vector fixAtributtes
```

dynamicFormClass
```
protected String dynamicFormClass
```

dynamicFormManager

protected DynamicFormManager dynamicFormManager

resourceArchive

protected ResourceBundle resourceArchive

leaf
```
protected boolean leaf
```

overrideLeaf
```
protected boolean overrideLeaf
```

comparator
```
protected static Collator comparator
```

componentLocale

protected static Locale componentLocale

renderTime
```
protected List renderTime
```

rowsNumberToQuery
```
protected int rowsNumberToQuery
```

df
```
protected static SimpleDateFormat df
```

dfH
```
protected static SimpleDateFormat dfH
```

totalCount
```
protected int totalCount
```

parameters
```
protected Hashtable parameters
```

count
```
protected int count
```

Constructor Detail

OTreeNode

public OTreeNode(Hashtable parameters)

This method uses the Hashtable and creates the tree node.

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr	attr1;...;attrn		yes	Indicates the field attribute. This fields will be displayed in node text.
entity			yes	Entity where tree data are obtained.
keys			yes	Primary keys of entity.
text			no	Text to show in organizational nodes.
form			no	Form to show when node is clicked.
parentkeys	parentk1;associparentk1;...;parentkn;associparentkn		no	Parent key and associated key for node. If parent key name and current-node key are the same name, this field will be filled with pairs of fields with the same name.
iconorg			no	Icon for organizational nodes.
iconnoorg			no	Icon for non-organizational nodes.
id			no	Identifier for an organizational node and its children placed in the inmediatly level.
separator			no	Separator character for attributes.
sortattr		The first attribute indicated in attr	no	Attribute to sort the tree.
fixattr	fixattr1;fixattr2;...;fixattrn		no	List of attributes that will be fixed by tree node in associated form.
hideattr	hideattr1;hideattr2;...;hideattrn		no	Attributes that will be queried, but not showed in node.
candelete	true/false	false	no	Indicates if a node can be deleted.
dynamicform			no	Name of class to show dynamic forms.
rendertime	render1;render2;...;rendern		no	Attribute to be renderized like a hour field.
classifynode			no
queryrows	positive values		no	For making pageable tree. Number of records that will be downloaded for each page. (since 5.2060EN)
sort	asc/desc	asc	no	Allow to sort current node ascending/descending. Before this version, ascending sort was set for all nodes(since 5.2077EN-0.3)

Method Detail

getRowsNumberToQuery
```
public int getRowsNumberToQuery()
```

compareTo
```
public int compareTo(Object object)
```
Specified by:

compareTo in interface Comparable

setAttributes

public void setAttributes(Vector attributes)

setEntityName

public void setEntityName(String entityName)

setForm
```
public void setForm(String form)
```

setSeparator

public void setSeparator(String separator)

clone
```
public Object clone()
```
Overrides:

clone in class DefaultMutableTreeNode

toString
```
public String toString()
```
Overrides:

toString in class DefaultMutableTreeNode

getForm
```
public String getForm()
```

setToString
```
public void setToString(String s)
```

getEntityName
```
public String getEntityName()
```

getKeys
```
public Vector getKeys()
```

getParentKeys
```
public Vector getParentKeys()
```

setKeysValues

public void setKeysValues(Object key,
                 Object value)

getKeysValues
```
public Hashtable getKeysValues()
```
Returns a Hashtable where keys are attributes specified in keysValues, and values are their correspondent values.

Returns:
the Hashtable

getNodeData
```
public Hashtable getNodeData()
```
Returns node keyvalues.

Returns:
a Hashtable with keyvalues

getSortAttr
```
public String getSortAttr()
```

getAttributes
```
public String[] getAttributes()
```

setAttribute

public void setAttribute(String attribute,
                Object value)

isOrganizational
```
public boolean isOrganizational()
```

cloneNodeAndChildren
```
public OTreeNode cloneNodeAndChildren()
```
Get a copy of the node and all the children

cloneThisAndChildren

protected OTreeNode cloneThisAndChildren()

setOverrideLeaf

public void setOverrideLeaf(boolean override,
                   boolean leaf)

isLeaf
```
public boolean isLeaf()
```
Specified by:

isLeaf in interface TreeNode

Overrides:

isLeaf in class DefaultMutableTreeNode

getChildren
```
public Vector getChildren()
```
Method to obtain children of a node.

Returns:
a Vector with children

add
```
public void add(MutableTreeNode node)
```
Overrides the method add to insert a node in a sorted tree.

Overrides:

add in class DefaultMutableTreeNode

getAssociatedDataField

public Hashtable getAssociatedDataField()

setAssociatedDataField

public void setAssociatedDataField(Hashtable associatedFields)

getAssociatedOrderedDataField

public Vector getAssociatedOrderedDataField()

setAssociatedOrderedDataField

public void setAssociatedOrderedDataField(Vector associatedOrderedDataField)

getParentKeyNameInParentNode

public String getParentKeyNameInParentNode(String parentKey)

setKeys
```
public void setKeys(Vector keys)
```

getValueForAttribute

public Object getValueForAttribute(Object attribute)

getKeysString
```
public String getKeysString()
```

getStringAssociatedDataField

public String getStringAssociatedDataField()

getAttr
```
public String getAttr()
```

setText

public void setText(String textToShow)

setKeysValues
```
public void setKeysValues(Hashtable keysValues)
```
Establishes key values and attributes for this node, that is 'attr' and 'keys' specified in xml definition.

Parameters:
keysValues -

setQueryResult

public void setQueryResult(Hashtable result)

getQueryResult
```
public Hashtable getQueryResult()
```

setResourceBundle
```
public void setResourceBundle(ResourceBundle resources)
```
Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Parameters:
resources - the new language bundle.

disableNodeSorting
```
public void disableNodeSorting()
```
Allows to disable sorting in nodes.

enableNodeSorting
```
public void enableNodeSorting()
```
Enables sorting in node.

setSortAttr

public void setSortAttr(String sortAttr)

sortNow
```
public void sortNow()
```
Sorts child nodes with order: ascending or descending.

getAscending
```
public boolean getAscending()
```

setComponentLocale
```
public void setComponentLocale(Locale l)
```
Specified by:

setComponentLocale in interface Internationalization

setSortOrder

public void setSortOrder(boolean ascendingSort)

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

getIcon
```
public ImageIcon getIcon()
```
Returns the icon to use with this node. In other case returns null. It is used by class TreeCellRenderer.

Returns:
the image icon

getIconOrg
```
public String getIconOrg()
```

getIconNoOrg
```
public String getIconNoOrg()
```

setUserObject
```
public void setUserObject(Object value)
```
Specified by:

setUserObject in interface MutableTreeNode

Overrides:

setUserObject in class DefaultMutableTreeNode

getUserObject
```
public Object getUserObject()
```
Overrides:

getUserObject in class DefaultMutableTreeNode

setAttributeText

public void setAttributeText(String attr,
                    String equivalence)

getId
```
public String getId()
```

setEmptyNode

public void setEmptyNode(boolean emptyNode)

isEmptyNode
```
public boolean isEmptyNode()
```

getSeparator
```
public String getSeparator()
```

getOrderByAttribute
```
public String getOrderByAttribute()
```

getText
```
public String getText()
```

setRemark
```
public void setRemark(boolean remark)
```
Indicates when node must show a special icon, for example, when its data have changed and tree has not been updated yet.

Parameters:
remark - the condition of remark

getRemark
```
public boolean getRemark()
```

canDelete
```
public boolean canDelete()
```

getFixAttributes
```
public Vector getFixAttributes()
```

getFixAttr
```
public String getFixAttr()
```

getHideAttr
```
public String getHideAttr()
```

setOrganizational

public void setOrganizational(boolean o)

updateNodeTextCache
```
protected void updateNodeTextCache()
```

getDynamicFormManagerClass

public String getDynamicFormManagerClass()

getDynamicFormManager

public DynamicFormManager getDynamicFormManager()

setDynamicFormManager

public void setDynamicFormManager(DynamicFormManager dfm)

getTextsToTranslate
```
public Vector getTextsToTranslate()
```
Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:
all the texts in the element suitable for being translated.

getShownAttributeList
```
public Vector getShownAttributeList()
```

getVisibleAttributes
```
public Vector getVisibleAttributes()
```

isClassifyNode
```
public boolean isClassifyNode()
```

setClassifyNode

public void setClassifyNode(boolean classify)

isDynamic
```
public boolean isDynamic()
```

setDynamic
```
public void setDynamic(boolean d)
```

setCount
```
public void setCount(int c)
```

getCount
```
public int getCount()
```

isPageableEnabled
```
public boolean isPageableEnabled()
```

getParameters
```
public Hashtable getParameters()
```

setTotalCount

public void setTotalCount(int totalRecordCount)

getTotalCount
```
public int getTotalCount()
```

getPageableIcon
```
public ImageIcon getPageableIcon()
```

setPageableIcon

public void setPageableIcon(ImageIcon pageableIcon)

Class OTreeNode

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

Constructor Summary

Method Summary

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

Methods inherited from class java.lang.Object

Field Detail

THERE_ARENT_RESULTS_KEY

THERE_ARENT_RESULTS_KEY_es_ES

ENTITY

KEYS

KEYS_VALUES

ATTR

TEXT

FORM

ORG

PARENT_KEYS

ICON_ORG

ICON_NO_ORG

PAGEABLE_ICON

ID

SEPARATOR

SORTATTR

SORT

DESC

FIX_ATTR

HIDE_ATTR

CAN_DELETE

DYNAMIC_FORM

DYNAMICFORM

DYNAMIC

CLASSIFY_NODE

QUERY_ROWS

defaultPageableEnabled

shownForm

entityName

shownAttribute

text

organization

keyList

keysString

keysValues

associatedDataField

associatedOrderedDataField

associateDataFieldString

stringFixAttr

stringHideAttr

hiddenAttributes

canDelete

cachedText

classifyNode

dynamic

attributeEquivalences

queryResult

separator

ascending

shownAttributeList

attrString

orderToAdd

iconorg

iconnoorg

pageableIcon

iconorgStr

iconnoorgStr

emptyNode

remark

pageableEnabled

id

orderByAttribute

fixAtributtes

dynamicFormClass

dynamicFormManager

resourceArchive

leaf

overrideLeaf

comparator

componentLocale

renderTime