Package org.compiere.model

Class MTree

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_Tree

org.compiere.model.MTree_Base

org.compiere.model.MTree

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_Tree, I_Persistent, Evaluatee, ImmutablePOSupport

public class MTree
extends MTree_Base

Builds Tree.

Version:

$Id: MTree.java,v 1.2 2006/07/30 00:51:02 jjanke Exp $

Author:

Jorg Janke

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Tree

TREETYPE_Activity, TREETYPE_AD_Reference_ID, TREETYPE_BoM, TREETYPE_BPartner, TREETYPE_Campaign, TREETYPE_CMContainer, TREETYPE_CMContainerStage, TREETYPE_CMMedia, TREETYPE_CMTemplate, TREETYPE_CustomTable, TREETYPE_ElementValue, TREETYPE_Menu, TREETYPE_Organization, TREETYPE_Product, TREETYPE_ProductCategory, TREETYPE_Project, TREETYPE_SalesRegion, TREETYPE_User1, TREETYPE_User2, TREETYPE_User3, TREETYPE_User4

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_Tree

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_Tree_ID, COLUMNNAME_AD_Tree_UU, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_Description, COLUMNNAME_IsActive, COLUMNNAME_IsAllNodes, COLUMNNAME_IsDefault, COLUMNNAME_IsLoadAllNodesImmediately, COLUMNNAME_IsTreeDrivenByValue, COLUMNNAME_IsValueDisplayed, COLUMNNAME_Name, COLUMNNAME_Parent_Column_ID, COLUMNNAME_Processing, COLUMNNAME_TreeType, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MTree(Properties ctx, int AD_Tree_ID, boolean editable, boolean clientTree, boolean allNodes, String trxName)
MTree(Properties ctx, int AD_Tree_ID, boolean editable, boolean clientTree, boolean allNodes, String trxName, String linkColName, int linkID)
MTree(Properties ctx, int AD_Tree_ID, boolean editable, boolean clientTree, String trxName)	Construct and Load Tree
MTree(Properties ctx, int AD_Tree_ID, boolean editable, boolean clientTree, String trxName, String linkColName, int linkID)
MTree(Properties ctx, int AD_Tree_ID, String trxName)	Default Constructor.
MTree(Properties ctx, ResultSet rs, String trxName)	Resultset constructor for model factory.

Method Summary

Modifier and Type	Method	Description
static int	getDefaultAD_Tree_ID(int AD_Client_ID, String keyColumnName)	Get default (oldest) AD_Tree_ID for KeyColumn.
static String	getRefTableFromTree(int treeId)	Return the table name of the table driving a tree
static String	getRefTableNameFromTableName(String tableName, int treeId)	Return the reference table name from the given tree node table name
MTreeNode	getRoot()	Get Root node
boolean	isBPartner()	Is Business Partner Tree
boolean	isMenu()	Is Menu Tree
boolean	isProduct()	Is Product Tree
String	toString()	String representation
void	trimTree()	Trim tree of empty summary nodes

Methods inherited from class org.compiere.model.MTree_Base

addNode, afterSave, beforeSave, get, get, get, getActionColorName, getNodeTableName, getNodeTableName, getSourceTableName, getSourceTableName, isLoadAllNodesImmediately, markImmutable

Methods inherited from class org.compiere.model.X_AD_Tree

get_AccessLevel, getAD_Table, getAD_Table_ID, getAD_Tree_ID, getAD_Tree_UU, getDescription, getKeyNamePair, getName, getParent_Column, getParent_Column_ID, getTreeType, initPO, isAllNodes, isDefault, isLoadAllNodesImmediately, isProcessing, isTreeDrivenByValue, isValueDisplayed, setAD_Table_ID, setAD_Tree_ID, setAD_Tree_UU, setDescription, setIsAllNodes, setIsDefault, setIsLoadAllNodesImmediately, setIsTreeDrivenByValue, setIsValueDisplayed, setName, setParent_Column_ID, setProcessing, setTreeType

Methods inherited from class org.compiere.model.PO

afterDelete, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_QueryTimeout, get_Table_ID, get_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_QueryTimeout, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys, validForeignKeysEx

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_Tree

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Details

MTree

public MTree(Properties ctx,
 int AD_Tree_ID,
 String trxName)

Default Constructor. Need to call loadNodes explicitly.

Parameters:

ctx - context for security

AD_Tree_ID - The tree to build

trxName - transaction

MTree

public MTree(Properties ctx,
 ResultSet rs,
 String trxName)

Resultset constructor for model factory. Need to call loadNodes explicitly.

Parameters:

ctx -

rs -

trxName -

MTree

public MTree(Properties ctx,
 int AD_Tree_ID,
 boolean editable,
 boolean clientTree,
 String trxName)

Construct and Load Tree

Parameters:

ctx -

AD_Tree_ID - The tree to build

editable - True, if tree can be modified - includes inactive and empty summary nodes

clientTree - the tree is displayed on the java client (not on web)

trxName - transaction

MTree

public MTree(Properties ctx,
 int AD_Tree_ID,
 boolean editable,
 boolean clientTree,
 String trxName,
 String linkColName,
 int linkID)

Parameters:

ctx -

AD_Tree_ID -

editable -

clientTree -

trxName -

linkColName -

linkID -

MTree

public MTree(Properties ctx,
 int AD_Tree_ID,
 boolean editable,
 boolean clientTree,
 boolean allNodes,
 String trxName)

Parameters:

ctx -

AD_Tree_ID -

editable -

clientTree -

allNodes -

trxName -

MTree

public MTree(Properties ctx,
 int AD_Tree_ID,
 boolean editable,
 boolean clientTree,
 boolean allNodes,
 String trxName,
 String linkColName,
 int linkID)

Parameters:

ctx -

AD_Tree_ID -

editable -

clientTree -

allNodes -

trxName -

linkColName -

linkID -

Method Details

getDefaultAD_Tree_ID

public static int getDefaultAD_Tree_ID(int AD_Client_ID,
 String keyColumnName)

Get default (oldest) AD_Tree_ID for KeyColumn. Called from GridController.

Parameters:

keyColumnName - key column name, eg. C_Project_ID

AD_Client_ID - client

Returns:

AD_Tree_ID

trimTree

public void trimTree()

Trim tree of empty summary nodes

getRoot

public MTreeNode getRoot()

Get Root node

Returns:

root

isMenu

public boolean isMenu()

Is Menu Tree

Returns:

true if menu

isProduct

public boolean isProduct()

Is Product Tree

Returns:

true if product

isBPartner

public boolean isBPartner()

Is Business Partner Tree

Returns:

true if partner

toString

public String toString()

String representation

Overrides:

toString in class X_AD_Tree

Returns:

info

getRefTableFromTree

public static String getRefTableFromTree(int treeId)

Return the table name of the table driving a tree

Parameters:

treeId -

Returns:

getRefTableNameFromTableName

public static String getRefTableNameFromTableName(String tableName,
 int treeId)

Return the reference table name from the given tree node table name

Parameters:

tableName - tree node table name (AD_TreeBar, AD_TreeNodeBP, etc)

treeId - AD_Tree_ID (for AD_TreeNode)

Returns:

reference table name