org.olap4j.query
Interface Selection


public interface Selection

A selection of members from an OLAP dimension hierarchy. The selection is a conceptual list of members from a given hierarchy. Once a selection object is created, one can decide to include or exclude this selection of members from the resulting query.

Concrete subclasses of this represent a real selection. Selections include things such as 'children of', 'siblings of', 'descendents of' etc.

This class is different from a Member because it represents an abstract member selection (e.g. children of widget' that may not represent any members whereas a Member represents a single member that is known to exist.

Since:
May 30, 2007
Version:
$Id: Selection.java 277 2009-08-18 18:50:30Z lucboudreau $
Author:
jdixon, jhyde, Luc Boudreau

Nested Class Summary
static class Selection.Operator
          Defines which selection operators are allowed, relative to a root member.
 
Method Summary
 void addQueryNodeListener(QueryNodeListener l)
          Registers a new listener for a QueryNode.
 Dimension getDimension()
           
 java.lang.String getHierarchyName()
           
 java.lang.String getLevelName()
           
 Member getMember()
           
 java.lang.String getName()
           
 Selection.Operator getOperator()
           
 void removeQueryNodeListener(QueryNodeListener l)
          De-registers a new listener for a QueryNode.
 void setName(java.lang.String name)
           
 void setOperator(Selection.Operator operator)
           
 

Method Detail

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getMember

Member getMember()

getDimension

Dimension getDimension()

getHierarchyName

java.lang.String getHierarchyName()

getLevelName

java.lang.String getLevelName()

getOperator

Selection.Operator getOperator()

setOperator

void setOperator(Selection.Operator operator)

addQueryNodeListener

void addQueryNodeListener(QueryNodeListener l)
Registers a new listener for a QueryNode.

Parameters:
l - The new listener object, implementation of QueryNodeListener
See Also:
QueryNodeListener

removeQueryNodeListener

void removeQueryNodeListener(QueryNodeListener l)
De-registers a new listener for a QueryNode. If the listener object passed as a parameter was not registered, the method will return silently.

Parameters:
l - The listener object to de-register.
See Also:
QueryNodeListener

SourceForge.net_Logo