Package com.jedox.palojlib.main

Class Element

java.lang.Object

com.jedox.palojlib.main.Element

All Implemented Interfaces:

IElement

public class Element
extends Object
implements IElement

Nested Class Summary

Nested classes/interfaces inherited from interface com.jedox.palojlib.interfaces.IElement

IElement.ElementPermission, IElement.ElementType

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<IAttribute,Object>	attributeValues

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Element(Dimension dimension, int id, String name, IElement.ElementType type, int position, int[] parentsIds, int[] childrenIds, double[] weights, HashMap<IAttribute,Object> attributesValues, int dimensionToken, String permission, boolean hiddenFiltered)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	getAttributeValue(String attributeName)	Get the value of the attribute for this element
Object	getAttributeValue(String attributeName, String language)
Map<IAttribute,Object>	getAttributeValues()
protected HashMap<IAttribute,Object>	getAttributeValues(Element language)
int	getChildCount()	Get the number of children for this element
Element[]	getChildren()	Get the children of the element
protected int[]	getChildrenIds()
protected Element[]	getChildrenObjects()
Double	getChildrenWeight(Integer childId)
int	getId()
String	getName()	Get the name of the element
int	getParentCount()	Get the number of parents for this element
Element[]	getParents()	Get the parents of the element
protected int[]	getParentsIds()
IElement.ElementPermission	getPermission()	get the permission for this element IElement.ElementPermission.
int	getPosition()	get the current position
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
int	hashCode()
void	move(int position)	move an element to a new position
void	rename(String name)	rename an element
protected void	setType(IElement.ElementType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jedox.palojlib.interfaces.IElement

getSubTree, getSubTreeAttributes

Field Details

attributeValues

protected HashMap<IAttribute,Object> attributeValues

Constructor Details

Element

protected Element(Dimension dimension,
 int id,
 String name,
 IElement.ElementType type,
 int position,
 int[] parentsIds,
 int[] childrenIds,
 double[] weights,
 HashMap<IAttribute,Object> attributesValues,
 int dimensionToken,
 String permission,
 boolean hiddenFiltered)
           throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

Method Details

getName

public String getName()

Description copied from interface: IElement

Get the name of the element

Specified by:

getName in interface IElement

Returns:

name element name

getPosition

public int getPosition()

Description copied from interface: IElement

get the current position

Specified by:

getPosition in interface IElement

Returns:

positive integer value

getType

public IElement.ElementType getType()

Description copied from interface: IElement

Get the type of the element IElement.ElementType

Specified by:

getType in interface IElement

Returns:

type element type

setType

protected void setType(IElement.ElementType type)

getAttributeValue

public Object getAttributeValue(String attributeName)
                         throws PaloJException,
PaloException

Description copied from interface: IElement

Get the value of the attribute for this element

Specified by:

getAttributeValue in interface IElement

Parameters:

attributeName - attribute name

Returns:

the attribute value

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

getAttributeValue

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

Specified by:

getAttributeValue in interface IElement

Throws:

PaloJException

PaloException

getChildCount

public int getChildCount()
                  throws PaloException,
PaloJException

Description copied from interface: IElement

Get the number of children for this element

Specified by:

getChildCount in interface IElement

Returns:

number of children

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getParentCount

public int getParentCount()
                   throws PaloException,
PaloJException

Description copied from interface: IElement

Get the number of parents for this element

Specified by:

getParentCount in interface IElement

Returns:

number of parents

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getChildren

public Element[] getChildren()
                      throws PaloException,
PaloJException

Description copied from interface: IElement

Get the children of the element

Specified by:

getChildren in interface IElement

Returns:

children list

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getChildrenObjects

protected Element[] getChildrenObjects()

getParents

public Element[] getParents()
                     throws PaloException,
PaloJException

Description copied from interface: IElement

Get the parents of the element

Specified by:

getParents in interface IElement

Returns:

parents list

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getWeight

public double getWeight(IElement parent)
                 throws PaloException,
PaloJException

Description copied from interface: IElement

Get the weight of this element under this parent element

Specified by:

getWeight in interface IElement

Parameters:

parent - parent element

Returns:

double value

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

rename

public void rename(String name)
            throws PaloException,
PaloJException

Description copied from interface: IElement

rename an element

Specified by:

rename in interface IElement

Parameters:

name - new element name

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

move

public void move(int position)
          throws PaloException,
PaloJException

Description copied from interface: IElement

move an element to a new position

Specified by:

move in interface IElement

Parameters:

position - new position

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getId

public int getId()

getParentsIds

protected int[] getParentsIds()

getChildrenIds

protected int[] getChildrenIds()

getAttributeValues

public Map<IAttribute,Object> getAttributeValues()

Specified by:

getAttributeValues in interface IElement

getAttributeValues

protected HashMap<IAttribute,Object> getAttributeValues(Element language)

getPermission

public IElement.ElementPermission getPermission()

Description copied from interface: IElement

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

Specified by:

getPermission in interface IElement

Returns:

permission for this element

getChildrenWeight

public Double getChildrenWeight(Integer childId)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object