Package com.jedox.palojlib.interfaces

Interface IElement

All Known Implementing Classes:

Element

public interface IElement

represent an Element in an olap dimension

Author:

khaddadin

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IElement.ElementPermission	element permission in olap.
static enum	IElement.ElementType	element types

Method Summary

Modifier and Type	Method	Description
default Set<IElement>	collectSubElements()	Collect all the descendents of this element, including this element
Object	getAttributeValue(String attributeName)	Get the value of the attribute for this element
default Object	getAttributeValue(String attributeName, String language)
Map<IAttribute,Object>	getAttributeValues()
int	getChildCount()	Get the number of children for this element
IElement[]	getChildren()	Get the children of the element
String	getName()	Get the name of the element
int	getParentCount()	Get the number of parents for this element
IElement[]	getParents()	Get the parents of the element
default IElement.ElementPermission	getPermission()	get the permission for this element IElement.ElementPermission.
int	getPosition()	get the current position
default Map<String,IElement[]>	getSubTree()	Deprecated. This method is deprecated, use collectSubElements() instead.
IElement.ElementType	getType()	Get the type of the element IElement.ElementType
double	getWeight(IElement parent)	Get the weight of this element under this parent element
void	move(int position)	move an element to a new position
void	rename(String newname)	rename an element

Method Details

getName

String getName()

Get the name of the element

Returns:

name element name

getType

IElement.ElementType getType()

Get the type of the element IElement.ElementType

Returns:

type element type

getAttributeValue

Object getAttributeValue(String attributeName)
                  throws PaloJException,
PaloException

Get the value of the attribute for this element

Parameters:

attributeName - attribute name

Returns:

the attribute value

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getAttributeValue

default Object getAttributeValue(String attributeName,
 String language)
                          throws PaloJException,
PaloException

Throws:

PaloJException

PaloException

getChildren

IElement[] getChildren()
                throws PaloException,
PaloJException

Get the children of the element

Returns:

children list

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getParents

IElement[] getParents()
               throws PaloException,
PaloJException

Get the parents of the element

Returns:

parents list

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getChildCount

int getChildCount()
           throws PaloException,
PaloJException

Get the number of children for this element

Returns:

number of children

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getParentCount

int getParentCount()
            throws PaloException,
PaloJException

Get the number of parents for this element

Returns:

number of parents

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getWeight

double getWeight(IElement parent)
          throws PaloException,
PaloJException

Get the weight of this element under this parent element

Parameters:

parent - parent element

Returns:

double value

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

collectSubElements

default Set<IElement> collectSubElements()
                                  throws PaloException,
PaloJException

Collect all the descendents of this element, including this element

Returns:

set of elements which are descendants of this element

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getSubTree

@Deprecated
default Map<String,IElement[]> getSubTree()
                                   throws PaloException,
PaloJException

Deprecated.

This method is deprecated, use collectSubElements() instead.

Get a map that maps an element to its children, only the elements and its descendants will be included in the map.

Returns:

map that maps an element name to a list of children element

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getAttributeValues

Map<IAttribute,Object> getAttributeValues()
                                   throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

rename

void rename(String newname)
     throws PaloException,
PaloJException

rename an element

Parameters:

newname - new element name

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

move

void move(int position)
   throws PaloException,
PaloJException

move an element to a new position

Parameters:

position - new position

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getPosition

int getPosition()

get the current position

Returns:

positive integer value

getPermission

default IElement.ElementPermission getPermission()

get the permission for this element IElement.ElementPermission. IDimension.setWithElementPermission(boolean) should be set to true before reading the elements

Returns:

permission for this element