Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

oracle.apps.fnd.applcore.trees.uiModel
Class HierarchyModel

java.lang.Object
  extended by javax.faces.model.DataModel
      extended by org.apache.myfaces.trinidad.model.CollectionModel
          extended by org.apache.myfaces.trinidad.model.TreeModel
              extended by org.apache.myfaces.trinidad.model.ChildPropertyTreeModel
                  extended by oracle.apps.fnd.applcore.trees.uiModel.HierarchyModel
All Implemented Interfaces:
org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.model.TreeLocalRowKeyIndex

public class HierarchyModel
extends org.apache.myfaces.trinidad.model.ChildPropertyTreeModel

ADF Faces Tree Model for Tree Management.

Version:
$Header: atgpf/applcore/applications/UIComponents/ViewController/src/oracle/apps/fnd/applcore/trees/uiModel/HierarchyModel.java /main/5 2010/05/03 05:39:29 abhaykum Exp $
Author:
Arun K Viswanathan <arun.viswanathan&064;oracle.com>

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex
org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy
 
Constructor Summary
HierarchyModel(java.lang.Object instance, java.lang.String childProperty, java.lang.String hierarchyId, java.lang.String treeStructureCode, java.lang.String treeCode, java.lang.String treeVersionId, java.lang.String treeVersionName)
          Creates a tree model.
 
Method Summary
 java.lang.String getHierarchyHeaderText()
          Gets the header text for hierarchy.
 java.lang.String getHierarchyId()
          Gets the hierarchyID for given hierarchy.
 int getRowCount()
           
 java.lang.String getTreeCode()
          Gets the TreeCode for given hierarchy.
 java.lang.String getTreeStructureCode()
          Gets the tree structure code for given hierarchy.
 java.lang.String getTreeVersionId()
          Gets the TreeVersionId for given hierarchy.
 boolean isContainer()
          Returns whether the tree node has children.
 boolean isRowAvailable()
           
 
Methods inherited from class org.apache.myfaces.trinidad.model.ChildPropertyTreeModel
createChildModel, enterContainer, exitContainer, getChildData, getChildProperty, getContainerRowKey, getRowData, getRowIndex, getRowKey, getSortCriteria, getWrappedData, isSortable, setChildProperty, setRowIndex, setRowKey, setSortCriteria, setWrappedData
 
Methods inherited from class org.apache.myfaces.trinidad.model.TreeModel
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, getAllAncestorContainerRowKeys, getContainerRowKey, getDepth, getDepth, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainerEmpty
 
Methods inherited from class org.apache.myfaces.trinidad.model.CollectionModel
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowData, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable
 
Methods inherited from class javax.faces.model.DataModel
addDataModelListener, getDataModelListeners, removeDataModelListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HierarchyModel

public HierarchyModel(java.lang.Object instance,
                      java.lang.String childProperty,
                      java.lang.String hierarchyId,
                      java.lang.String treeStructureCode,
                      java.lang.String treeCode,
                      java.lang.String treeVersionId,
                      java.lang.String treeVersionName)
Creates a tree model.

Parameters:
instance - the collection of root nodes of this hierarchy
childProperty - the property used to get the children
hierarchyId - Id associated with the given Hierarchy
treeStructureCode - associated tree structure code
treeCode - associated tree code
treeVersionId - associated tree version id
treeVersionName - associated tree version Name
Method Detail

isContainer

public boolean isContainer()
Returns whether the tree node has children.

Overrides:
isContainer in class org.apache.myfaces.trinidad.model.ChildPropertyTreeModel
Returns:
boolean whether the node has children

getHierarchyId

public java.lang.String getHierarchyId()
Gets the hierarchyID for given hierarchy.

Returns:
hierarchy id as string

getTreeStructureCode

public java.lang.String getTreeStructureCode()
Gets the tree structure code for given hierarchy.

Returns:
treeStructureCode as string

getTreeCode

public java.lang.String getTreeCode()
Gets the TreeCode for given hierarchy.

Returns:
treeCode as string

getTreeVersionId

public java.lang.String getTreeVersionId()
Gets the TreeVersionId for given hierarchy.

Returns:
treeVersionId as string

getHierarchyHeaderText

public java.lang.String getHierarchyHeaderText()
Gets the header text for hierarchy.

Returns:
hierarchy header text

getRowCount

public int getRowCount()
Specified by:
getRowCount in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
getRowCount in class org.apache.myfaces.trinidad.model.ChildPropertyTreeModel

isRowAvailable

public boolean isRowAvailable()
Specified by:
isRowAvailable in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
isRowAvailable in class org.apache.myfaces.trinidad.model.ChildPropertyTreeModel

Oracle Fusion Middleware extensions for Applications Core API Reference
11g Release 1 (11.1.1.6)

E22562-03

Copyright © 2012 Oracle. All Rights Reserved.