|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.sas.dataselectors.filters.OLAPMemberTreeModel
public class OLAPMemberTreeModel
This tree model extends the Swing DefaultTreeModel class to add population methods for OLAP members. By providing a DataItem or Dimension at construction, the tree model will populate itself with the appropriate nodes based on metadata found on the OLAP server. This class also acts as a value list within the filter model to provide selectable members as values for OLAP filters.
Field Summary | |
---|---|
protected java.util.Collection |
_itemValues
A collection of values for use within the filter model. |
protected java.util.Iterator |
_itemValuesIterator
An iterator over the filter model values list to provide sequential access. |
protected java.lang.String |
_label
The label for this model. |
protected MetadataInterface |
_metadata
The OLAP metadata interface object used to gather metadata from an OLAP source. |
static java.lang.String |
RB_KEY
The prefix used for resource properties associated with this class. |
Fields inherited from interface com.sas.dataselectors.filters.FilterValuesInterface |
---|
GETTHRESHHOLDALLVALUES |
Constructor Summary | |
---|---|
OLAPMemberTreeModel(com.sas.iquery.metadata.business.DataItem dataItem,
MetadataInterface metadata)
Constructs a new tree model and prepopulates it using metadata gathered from the given DataItem and MetadataInterface objects. |
|
OLAPMemberTreeModel(com.sas.iquery.metadata.business.DataItem dataItem,
MetadataInterface metadata,
int levelDepth)
|
|
OLAPMemberTreeModel(DimensionInterface dimension)
Constructs a new tree model and prepopulates it using metadata gathered from the given DimensionInterface object. |
|
OLAPMemberTreeModel(OLAPMemberTreeNode root)
Constructs a new tree model with the given tree node as the root. |
|
OLAPMemberTreeModel(OLAPMemberTreeNode root,
boolean asksAllowsChildren)
Constructs a new tree model with the given tree node as the root. |
Method Summary | |
---|---|
java.util.List |
getFirstValues(long lThreshold)
Returns the first list of values. |
java.lang.String |
getListLabel()
Returns the current label for this list of values. |
static MemberInterface[] |
getMemberArrayForPathNodeList(MetadataInterface metadata,
java.lang.String cubeName,
java.lang.String memberName)
Retrieves an array of members from a metadata server based on the specified properties. |
MetadataInterface |
getMetadata()
Returns the OLAP Metadata Interface object used to gather metadata from an OLAP source. |
java.util.List |
getNextValues(long lThreshold)
Returns the next list of values. |
java.util.List |
getTreePathNodeList(com.sas.iquery.metadata.business.DataItem dataItem,
java.lang.String memberName)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties. |
java.util.List |
getTreePathNodeList(FilterItemInterface filterItem,
FilterValueInterface filterValue)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters. |
java.util.List |
getTreePathNodeList(FilterValueInterface filterValue)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters. |
static void |
getTreePathNodeList(OLAPMemberTreeModel tree,
MemberInterface[] members,
java.util.List list)
Constructs the path that correlates to the list of members by adding the tree nodes for each member to the supplied list. |
static java.util.List |
getTreePathNodeList(OLAPMemberTreeModel tree,
MetadataInterface metadata,
java.lang.String cubeName,
java.lang.String memberName)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties. |
java.util.List |
getTreePathNodeList(java.lang.String memberName)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties. |
java.util.List |
getTreePathNodeList(java.lang.String cubeName,
java.lang.String memberName)
Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties. |
boolean |
hasMoreValues()
Returns TRUE if more values are available, FALSE otherwise. |
void |
setListLabel(java.lang.String value)
Allows setting a label for this list of values. |
void |
setMetadata(MetadataInterface metadata)
Sets the OLAP Metadata Interface object to be used by this model when gathering metadata from an OLAP source. |
void |
setRoot(javax.swing.tree.TreeNode root)
Sets the root node of this tree model. |
java.lang.String |
toString()
Returns a text representation of this model. |
Field Detail |
---|
public static java.lang.String RB_KEY
protected transient java.lang.String _label
protected java.util.Collection _itemValues
protected java.util.Iterator _itemValuesIterator
protected MetadataInterface _metadata
Constructor Detail |
---|
public OLAPMemberTreeModel(OLAPMemberTreeNode root, boolean asksAllowsChildren)
root
- the root node of the new tree modelaskAllowsChildren
- a boolean, false if any node can
have children, true if each node is asked to see if
it can have childrenDefaultTreeModel.asksAllowsChildren
public OLAPMemberTreeModel(OLAPMemberTreeNode root)
root
- the root node of the new tree modelpublic OLAPMemberTreeModel(com.sas.iquery.metadata.business.DataItem dataItem, MetadataInterface metadata) throws com.sas.iquery.metadata.MetadataException
dataItem
- the entry point in the OLAP member treemetadata
- the interface to use when getting metadata from an OLAP source
com.sas.iquery.metadata.MetadataException
- if any errors occur while retrieving data from the OLAP metadata
serverpublic OLAPMemberTreeModel(com.sas.iquery.metadata.business.DataItem dataItem, MetadataInterface metadata, int levelDepth) throws com.sas.iquery.metadata.MetadataException
com.sas.iquery.metadata.MetadataException
public OLAPMemberTreeModel(DimensionInterface dimension) throws OLAPException
dimension
- the entry point in the OLAP member tree
OLAPException
- if any errors occur while retrieving data from the OLAP metadata
serverMethod Detail |
---|
public MetadataInterface getMetadata()
getMetadata
in interface OLAPMemberTreePathFactoryInterface
public void setMetadata(MetadataInterface metadata)
metadata
- the new interfacepublic boolean hasMoreValues()
hasMoreValues
in interface FilterValuesInterface
public java.util.List getFirstValues(long lThreshold) throws DataRetrievalError
getFirstValues
in interface FilterValuesInterface
lThreshold
- the maximum number of values to return
DataRetrievalError
- if any errors occur while retrieving data from the OLAP metadata
serverpublic java.util.List getNextValues(long lThreshold) throws DataRetrievalError
getNextValues
in interface FilterValuesInterface
lThreshold
- the maximum number of values to return
DataRetrievalError
- if any errors occur while retrieving data from the OLAP metadata
serverpublic void setRoot(javax.swing.tree.TreeNode root)
setRoot
in class javax.swing.tree.DefaultTreeModel
root
- the new root node for this modelpublic void setListLabel(java.lang.String value)
value
- The new label for this listpublic java.lang.String getListLabel()
getListLabel
in interface FilterValuesInterface
public java.lang.String toString()
toString
in class java.lang.Object
public static MemberInterface[] getMemberArrayForPathNodeList(MetadataInterface metadata, java.lang.String cubeName, java.lang.String memberName) throws OLAPException
metadata
- the MetadataInterface connected to the OLAP cube metadata servercubeName
- the name of the cube the target member is a part ofmemberName
- the target member
OLAPException
- in the event of a communication error with the metadata
serverpublic static java.util.List getTreePathNodeList(OLAPMemberTreeModel tree, MetadataInterface metadata, java.lang.String cubeName, java.lang.String memberName) throws FilterException
tree
- the source tree modelmetadata
- the MetadataInterface connected to the OLAP cube metadata servercubeName
- the name of the cube the target member is a part ofmemberName
- the target member
FilterException
- in the event of a communications failure or any error with the metadata serverpublic static void getTreePathNodeList(OLAPMemberTreeModel tree, MemberInterface[] members, java.util.List list) throws OLAPException
tree
- the tree model to work withmembers
- the list of members to retrieve tree nodes for (the rough path through the member tree)list
- the list of tree nodes forming the path from the root of the model along the
supplied list of members
OLAPException
- if any errors occur while retrieving data from the OLAP metadata
serverpublic java.util.List getTreePathNodeList(com.sas.iquery.metadata.business.DataItem dataItem, java.lang.String memberName) throws FilterException
dataItem
- a BIQ DataItem from the OLAP cube to be searchedmemberName
- the unique member name of the target cube member
FilterException
- in the event of a communications failure or any error with the metadata serverpublic java.util.List getTreePathNodeList(java.lang.String cubeName, java.lang.String memberName) throws FilterException
getTreePathNodeList
in interface OLAPMemberTreePathFactoryInterface
cubeName
- the name of the OLAP cube to be searchedmemberName
- the unique member name of the target cube member
FilterException
- in the event of a communications failure or any error with the metadata serverpublic java.util.List getTreePathNodeList(java.lang.String memberName) throws FilterException
getTreePathNodeList
in interface OLAPMemberTreePathFactoryInterface
cubeName
- the name of the OLAP cube to be searchedmemberName
- the unique member name of the target cube member
FilterException
- in the event of a communications failure or any error with the metadata serverpublic java.util.List getTreePathNodeList(FilterItemInterface filterItem, FilterValueInterface filterValue) throws FilterException
getTreePathNodeList
in interface OLAPMemberTreePathFactoryInterface
filterItem
- a FilterItemInterface representing a BIQ DataItem from the OLAP cube to be searchedfilterValue
- a FilterValueInterface representing the target member of an OLAP cube
FilterException
- in the event of a communications failure or any error with the metadata serverpublic java.util.List getTreePathNodeList(FilterValueInterface filterValue) throws FilterException
getTreePathNodeList
in interface OLAPMemberTreePathFactoryInterface
filterValue
- a FilterValueInterface representing the target member of an OLAP cube
FilterException
- in the event of a communications failure or any error with the metadata server
|
Components |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |