Skip navigation links


com.essbase.eas.essbase.ui.outline
Class DefaultOutlineModel

java.lang.Object
  extended by javax.swing.tree.DefaultTreeModel
      extended by com.essbase.eas.essbase.ui.outline.DefaultOutlineModel

All Implemented Interfaces:
RepresentationListener, java.io.Serializable, javax.swing.tree.TreeModel
Direct Known Subclasses:
OutlineModel

public class DefaultOutlineModel
extends javax.swing.tree.DefaultTreeModel
implements RepresentationListener

extension of the default tree model to provide an abstract representation of an Essbase Outline.

Since:
6.2.0
Version:
7.1.0
Author:
Hank Cox
See Also:
Serialized Form

Field Summary
static int CHILD_BLOCK_SIZE
           
static boolean multiSelectOperation
           
protected  Representation representation
           

 

Fields inherited from class javax.swing.tree.DefaultTreeModel
asksAllowsChildren, listenerList, root

 

Constructor Summary
DefaultOutlineModel()
           
DefaultOutlineModel(Representation r)
           

 

Method Summary
 void activeAliasTableChanged(RepresentationEvent e)
          this event gets broadcast when the active alias table is changed.
 void addChild(Member parent, Member m, int index)
           
 Member[] addChildren(DefaultOutlineMutableTreeNode parent, Member[] children, boolean append)
           
 void addDimensionListener(DimensionListener l)
           
 void addDimensionUDA(Member dimension, java.lang.String value)
           
 Member addSiblingForMember(Member parent, Member prevSibling, Member newMember)
           
 Member addSiblingForMember(Member parent, Member prevSibling, java.lang.String value)
           
 Member[] convertNodesToMembers(java.lang.Object[] nodes)
           
 void createBooleanChildren(Member parent)
           
 java.io.File createDeletedHandleFile()
           
 long createSmartlist(java.lang.String smartlistName)
          Creates an empty smartlist
 void deleteMember(Member m)
           
 void deleteMembers(Member[] candidates, boolean showConfirmation)
           
 void deleteMembers(Member[] candidates, boolean showConfirmation, boolean showProgressDialog)
          removes a set of members.
 boolean deleteSmartlist(long smartlistHandle)
           
 boolean doesMemberExist(Member m)
           
 void eventTaken(RepresentationEvent e)
          this event gets broadcast an event is added to the outline's representation.
 void eventUndone(RepresentationEvent e)
          this event gets broadcast when an event is undone.
 java.lang.String generateMemberHashKey(Member m)
           
 Member getAccountsDimension()
          returns the member marked as an accounts dimension
 short getAllowableConsolidationFor(Member member)
           
 java.util.ArrayList getAllSmartlists()
           
 IndependentDimensionDefn[] getAssociatedIndependentDimensions(Member attrDim)
          Returns the independent dimensions associated with an attribute dimension
 Member[] getAttributeDimensions()
          returns an array of attribute dimensions.
 Member[] getAttributeDimensions(boolean includeLinkedAttribute)
          returns an array of linked attribute dimensions + normal attribute dimension.
 Member[] getAttributeDimensionsFor(Member baseDim)
          returns the attribute dimensions mapped to a base dimension.
 Member getBaseDimensionFor(Member attrDim)
          returns the base dimension an attribute dimension is mapped to.
 Member getBaseDimensionFor(java.lang.String attrDim)
          returns the base dimension an attribute dimension is mapped to.
 Member getChildAt(Member member, int childIndex)
           
 Member[] getChildrenFor(Member member)
          retrieves an array of member objects that are the children of a specific member.
 Member[] getChildrenFor(Member member, boolean force)
           
 Member[] getChildrenForEx(Member member)
           
 Member getCountryDimension()
          returns the member marked as a country dimension.
 java.util.Hashtable getDeletedHandleTable()
           
 Member getDimensionAt(int childIndex)
           
 Member getDimensionFor(DimensionCategory category)
           
 Member getDimensionFor(Member m)
          returns the dimension for a member.
 Member getDimensionFor(java.lang.String value)
          returns the dimension for a string name.
 Member[] getDimensions()
          returns an array of members that are the dimensions for this outline.
 Member[] getDimensionsForEditor()
          returns an array of members that are the dimensions for this outline.
 java.util.Collection getDimensionUDAS(Member dimension)
           
 DynamicTimeSeries[] getDynamicTimeSeries(boolean refresh)
           
 DefinedGeneration[] getGenerations()
           
 DefinedGeneration[] getGenerationsFor(java.lang.String dimensionName)
           
 Member getHierarchyTop(Member member)
           
 Member[] getIndependentDimensions()
          Returns the independent dimensions in the outline
 DefinedLevel[] getLevels()
           
 DefinedLevel[] getLevelsFor(java.lang.String dimensionName)
           
 Member[] getLinkedAttributeDimensions()
          returns an array of linked attribute dimensions.
 java.lang.String getMemberCombinedName(long memberHandle)
           
 MemberContext getMemberContext(Member member)
           
 Member getMemberFor(long handle)
           
 Member getMemberFor(java.lang.String value)
           
 java.lang.String getMemberFormatString(long memberHandle)
           
 long getMemberSmartlist(long memberHandle)
           
 short getMemberType(Member member)
           
 DefaultOutlineMutableTreeNode getNodeFor(Member member)
           
 OutlineProperties getOutlineProperties()
          Deprecated.  
 boolean getReadOnly()
           
 Representation getRepresentation()
           
 java.lang.String[] getServerDateFormatsForDateMeasures()
           
 SLODefinition getSmartlist(long memberHandle)
           
 Member getTimeDimension()
          returns the member marked as a time dimension.
 MemberAttribute[] getVaryingMemberAttributes(Member baseMember, Member attrDim, boolean needValiditySet)
          Returns the list of all varying asccoiations associatied with a base memeber
 MemberAttribute[] getVaryingMemberAttributesQuery(Member baseMember, Member attrDim, ValiditySet[] searchPerspective, boolean needValiditySet)
          Returns the list of all varying asccoiations associatied with a base memeber in query mode
 boolean isAttributeDimensionMapped(Member attrDim)
          determines whether an attribute dimension is mapped.
 boolean isBooleanDimension(Member member)
           
 boolean isBooleanMember(Member member)
          determines whether a member is a boolean attribute member or dimension.
 boolean isForceOutlineClosing()
          forceOutlineClosing is a flag added to indicate that the Outline has to be closed because of an Out of memory error at the server.
 boolean isPrimaryHierarchy(Member member)
           
 boolean isReadOnly()
           
 boolean performAssignMemberShareNonUnique(Member[] members, Share value)
           
 boolean performMemberRename(Member member, java.lang.String value)
           
 void performResetExtendedShare(Member m, Share value)
           
 OutlineTreeNode[] performSortTreeNodesByChildIndex(OutlineTreeNode[] nodes)
           
 void putNodeIntoHashtable(DefaultOutlineMutableTreeNode node, Member m)
           
 boolean putSmartlist(java.util.ArrayList pidList, java.util.ArrayList valuesList, java.lang.String missingName, java.lang.String outOfRangeName, long smartlistHandle)
           
 void release()
           
 void releaseNode(Member m)
           
 void reload()
           
 void removeDimensionListener(DimensionListener l)
           
 MemberAccessFile retrieveChildrenFor(DefaultOutlineMutableTreeNode node, Member member, int startIndex)
           
 void scrubMember(Member m)
           
 void scrubMembers(Member[] members)
           
 void setDeletedHandleTable(java.util.Hashtable table)
           
 void setDimensionUDAS(Member dimension, java.lang.Object[] values)
           
 void setForceOutlineClosing(boolean forceOutlineClosing)
           
 boolean setMemberFormatString(long memberHandle, java.lang.String format)
           
 boolean setMemberSmartlist(long memberHandle, long smartlistHandle)
           
 boolean setMemberType(long memberHandle, short type)
           
 void setReadOnly(boolean value)
           
 void setRepresentation(Representation r)
           
 void sortChildrenFor(Member parent, boolean fAscending)
           
 void syncDimensions(DefaultOutlineMutableTreeNode root)
           
 boolean undoSortChildren(MemberSortEvent event)
           
 void updateDimensionsAfterSave()
           
 void updateDynamicTimeSeries()
           
 Member[] updateWithFindResults(Member[] candidates)
          takes the results of a find and inserts them into the hash tables we use to find members later.
 Member[] updateWithReplaceResults(ReplaceMember[] candidates)
           

 

Methods inherited from class javax.swing.tree.DefaultTreeModel
addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getChild, getChildCount, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getRoot, getTreeModelListeners, insertNodeInto, isLeaf, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, removeNodeFromParent, removeTreeModelListener, setAsksAllowsChildren, setRoot, valueForPathChanged

 

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

 

Field Detail

representation

protected Representation representation

multiSelectOperation

public static boolean multiSelectOperation

CHILD_BLOCK_SIZE

public static int CHILD_BLOCK_SIZE

Constructor Detail

DefaultOutlineModel

public DefaultOutlineModel()

DefaultOutlineModel

public DefaultOutlineModel(Representation r)

Method Detail

generateMemberHashKey

public java.lang.String generateMemberHashKey(Member m)

putNodeIntoHashtable

public void putNodeIntoHashtable(DefaultOutlineMutableTreeNode node,
                                 Member m)

scrubMembers

public void scrubMembers(Member[] members)

scrubMember

public void scrubMember(Member m)

releaseNode

public void releaseNode(Member m)

getNodeFor

public DefaultOutlineMutableTreeNode getNodeFor(Member member)

getMemberContext

public MemberContext getMemberContext(Member member)

addDimensionListener

public void addDimensionListener(DimensionListener l)

removeDimensionListener

public void removeDimensionListener(DimensionListener l)

addChild

public void addChild(Member parent,
                     Member m,
                     int index)

addChildren

public Member[] addChildren(DefaultOutlineMutableTreeNode parent,
                            Member[] children,
                            boolean append)

getAttributeDimensions

public Member[] getAttributeDimensions()
returns an array of attribute dimensions.

getLinkedAttributeDimensions

public Member[] getLinkedAttributeDimensions()
returns an array of linked attribute dimensions.

getAttributeDimensions

public Member[] getAttributeDimensions(boolean includeLinkedAttribute)
returns an array of linked attribute dimensions + normal attribute dimension.

getDimensions

public Member[] getDimensions()
returns an array of members that are the dimensions for this outline.

getDimensionsForEditor

public Member[] getDimensionsForEditor()
returns an array of members that are the dimensions for this outline.

getDimensionFor

public Member getDimensionFor(java.lang.String value)
returns the dimension for a string name. If the string represents a member, returns the dimension for that member; if the string represents a dimension, returns that object.

getDimensionFor

public Member getDimensionFor(Member m)
returns the dimension for a member.

getDimensionFor

public Member getDimensionFor(DimensionCategory category)

getCountryDimension

public Member getCountryDimension()
returns the member marked as a country dimension.

getAccountsDimension

public Member getAccountsDimension()
returns the member marked as an accounts dimension

getTimeDimension

public Member getTimeDimension()
returns the member marked as a time dimension.

getAllowableConsolidationFor

public short getAllowableConsolidationFor(Member member)

getChildrenFor

public Member[] getChildrenFor(Member member,
                               boolean force)

getDimensionAt

public Member getDimensionAt(int childIndex)

getChildAt

public Member getChildAt(Member member,
                         int childIndex)

getChildrenFor

public Member[] getChildrenFor(Member member)
retrieves an array of member objects that are the children of a specific member.

getHierarchyTop

public Member getHierarchyTop(Member member)

isPrimaryHierarchy

public boolean isPrimaryHierarchy(Member member)

getChildrenForEx

public Member[] getChildrenForEx(Member member)

syncDimensions

public void syncDimensions(DefaultOutlineMutableTreeNode root)

retrieveChildrenFor

public MemberAccessFile retrieveChildrenFor(DefaultOutlineMutableTreeNode node,
                                            Member member,
                                            int startIndex)

getMemberFor

public Member getMemberFor(java.lang.String value)

getMemberFor

public Member getMemberFor(long handle)

convertNodesToMembers

public Member[] convertNodesToMembers(java.lang.Object[] nodes)

addSiblingForMember

public Member addSiblingForMember(Member parent,
                                  Member prevSibling,
                                  Member newMember)

addSiblingForMember

public Member addSiblingForMember(Member parent,
                                  Member prevSibling,
                                  java.lang.String value)

createBooleanChildren

public void createBooleanChildren(Member parent)

deleteMember

public void deleteMember(Member m)

deleteMembers

public void deleteMembers(Member[] candidates,
                          boolean showConfirmation,
                          boolean showProgressDialog)
removes a set of members.

deleteMembers

public void deleteMembers(Member[] candidates,
                          boolean showConfirmation)

doesMemberExist

public boolean doesMemberExist(Member m)

undoSortChildren

public boolean undoSortChildren(MemberSortEvent event)

sortChildrenFor

public void sortChildrenFor(Member parent,
                            boolean fAscending)

isAttributeDimensionMapped

public boolean isAttributeDimensionMapped(Member attrDim)
determines whether an attribute dimension is mapped. If the member isn't an attribute dimension, this will return false.

isBooleanDimension

public boolean isBooleanDimension(Member member)

isBooleanMember

public boolean isBooleanMember(Member member)
determines whether a member is a boolean attribute member or dimension.

getBaseDimensionFor

public Member getBaseDimensionFor(java.lang.String attrDim)
returns the base dimension an attribute dimension is mapped to.

getBaseDimensionFor

public Member getBaseDimensionFor(Member attrDim)
returns the base dimension an attribute dimension is mapped to.

getAttributeDimensionsFor

public Member[] getAttributeDimensionsFor(Member baseDim)
returns the attribute dimensions mapped to a base dimension.

getOutlineProperties

public OutlineProperties getOutlineProperties()
Deprecated. 
gets the currently set outline properties.

getReadOnly

public boolean getReadOnly()

setReadOnly

public void setReadOnly(boolean value)

isReadOnly

public boolean isReadOnly()

setRepresentation

public void setRepresentation(Representation r)

getRepresentation

public Representation getRepresentation()

addDimensionUDA

public void addDimensionUDA(Member dimension,
                            java.lang.String value)

getDimensionUDAS

public java.util.Collection getDimensionUDAS(Member dimension)

getGenerations

public DefinedGeneration[] getGenerations()

getGenerationsFor

public DefinedGeneration[] getGenerationsFor(java.lang.String dimensionName)

getLevels

public DefinedLevel[] getLevels()

getLevelsFor

public DefinedLevel[] getLevelsFor(java.lang.String dimensionName)

getDynamicTimeSeries

public DynamicTimeSeries[] getDynamicTimeSeries(boolean refresh)

setDimensionUDAS

public void setDimensionUDAS(Member dimension,
                             java.lang.Object[] values)

eventTaken

public void eventTaken(RepresentationEvent e)
Description copied from interface: RepresentationListener
this event gets broadcast an event is added to the outline's representation.
Specified by:
eventTaken in interface RepresentationListener

eventUndone

public void eventUndone(RepresentationEvent e)
Description copied from interface: RepresentationListener
this event gets broadcast when an event is undone.
Specified by:
eventUndone in interface RepresentationListener

activeAliasTableChanged

public void activeAliasTableChanged(RepresentationEvent e)
Description copied from interface: RepresentationListener
this event gets broadcast when the active alias table is changed.
Specified by:
activeAliasTableChanged in interface RepresentationListener

reload

public void reload()
Overrides:
reload in class javax.swing.tree.DefaultTreeModel

updateDimensionsAfterSave

public void updateDimensionsAfterSave()

updateDynamicTimeSeries

public void updateDynamicTimeSeries()

updateWithFindResults

public Member[] updateWithFindResults(Member[] candidates)
takes the results of a find and inserts them into the hash tables we use to find members later. Returns an array of members that is updated to reflect members that have already been retrieved.

updateWithReplaceResults

public Member[] updateWithReplaceResults(ReplaceMember[] candidates)

release

public void release()

getDeletedHandleTable

public java.util.Hashtable getDeletedHandleTable()

setDeletedHandleTable

public void setDeletedHandleTable(java.util.Hashtable table)

createDeletedHandleFile

public java.io.File createDeletedHandleFile()

performSortTreeNodesByChildIndex

public OutlineTreeNode[] performSortTreeNodesByChildIndex(OutlineTreeNode[] nodes)

performResetExtendedShare

public void performResetExtendedShare(Member m,
                                      Share value)

performAssignMemberShareNonUnique

public boolean performAssignMemberShareNonUnique(Member[] members,
                                                 Share value)

performMemberRename

public boolean performMemberRename(Member member,
                                   java.lang.String value)
Parameters:
member -
value -
Returns:

getAssociatedIndependentDimensions

public IndependentDimensionDefn[] getAssociatedIndependentDimensions(Member attrDim)
Returns the independent dimensions associated with an attribute dimension
Parameters:
attrDimHandle - Attribute dimension handle whose associated independent dimension is fetched

getVaryingMemberAttributes

public MemberAttribute[] getVaryingMemberAttributes(Member baseMember,
                                                    Member attrDim,
                                                    boolean needValiditySet)
Returns the list of all varying asccoiations associatied with a base memeber
Parameters:
baseMember - Base member
attrDim - Attribute dimension or NULL for all attribute dimensions
needValiditySet - Boolean to specify whether validity set is required or not
Returns:

getVaryingMemberAttributesQuery

public MemberAttribute[] getVaryingMemberAttributesQuery(Member baseMember,
                                                         Member attrDim,
                                                         ValiditySet[] searchPerspective,
                                                         boolean needValiditySet)
                                                  throws java.lang.Exception
Returns the list of all varying asccoiations associatied with a base memeber in query mode
Parameters:
baseMember - Base member
attrDim - Attribute dimension or NULL for all attribute dimensions
perspective - Search Perspective array, specify NULL for returing all varying attributes
needValiditySet - Boolean to specify whether validity set is required or not
Returns:
Throws:
java.lang.Exception

getIndependentDimensions

public Member[] getIndependentDimensions()
Returns the independent dimensions in the outline

createSmartlist

public long createSmartlist(java.lang.String smartlistName)
Creates an empty smartlist
Parameters:
slType - Type of the smartlist to be created (Dynamic or static)
smartlistName - Name of the smartlist to be created

deleteSmartlist

public boolean deleteSmartlist(long smartlistHandle)

putSmartlist

public boolean putSmartlist(java.util.ArrayList pidList,
                            java.util.ArrayList valuesList,
                            java.lang.String missingName,
                            java.lang.String outOfRangeName,
                            long smartlistHandle)

getAllSmartlists

public java.util.ArrayList getAllSmartlists()

getSmartlist

public SLODefinition getSmartlist(long memberHandle)

setMemberSmartlist

public boolean setMemberSmartlist(long memberHandle,
                                  long smartlistHandle)

getMemberSmartlist

public long getMemberSmartlist(long memberHandle)

setMemberType

public boolean setMemberType(long memberHandle,
                             short type)

getMemberType

public short getMemberType(Member member)

getServerDateFormatsForDateMeasures

public java.lang.String[] getServerDateFormatsForDateMeasures()

setMemberFormatString

public boolean setMemberFormatString(long memberHandle,
                                     java.lang.String format)

getMemberFormatString

public java.lang.String getMemberFormatString(long memberHandle)

getMemberCombinedName

public java.lang.String getMemberCombinedName(long memberHandle)

isForceOutlineClosing

public boolean isForceOutlineClosing()
forceOutlineClosing is a flag added to indicate that the Outline has to be closed because of an Out of memory error at the server. If this flag is set, Outline operations would not work, and the outline has to be closed by the user and reopened.

setForceOutlineClosing

public void setForceOutlineClosing(boolean forceOutlineClosing)

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.