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
Modifier and TypeInterfaceDescriptionstatic enum
element permission in olap.static enum
element types -
Method Summary
Modifier and TypeMethodDescriptiongetAttributeValue
(String attributeName) Get the value of the attribute for this elementdefault Object
getAttributeValue
(String attributeName, String language) int
Get the number of children for this elementIElement[]
Get the children of the elementgetName()
Get the name of the elementint
Get the number of parents for this elementIElement[]
Get the parents of the elementdefault IElement.ElementPermission
get the permission for this elementIElement.ElementPermission
.int
get the current positionDeprecated.This method is deprecated and will be removed.Deprecated.This method is deprecated and will be removed.getType()
Get the type of the elementIElement.ElementType
double
Get the weight of this element under this parent elementvoid
move
(int position) move an element to a new positionvoid
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 elementIElement.ElementType
- Returns:
- type element type
-
getAttributeValue
Get the value of the attribute for this element- Parameters:
attributeName
- attribute name- Returns:
- the attribute value
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getAttributeValue
default Object getAttributeValue(String attributeName, String language) throws PaloJException, PaloException - Throws:
PaloJException
PaloException
-
getChildren
Get the children of the element- Returns:
- children list
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getParents
Get the parents of the element- Returns:
- parents list
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getChildCount
Get the number of children for this element- Returns:
- number of children
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getParentCount
Get the number of parents for this element- Returns:
- number of parents
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getWeight
Get the weight of this element under this parent element- Parameters:
parent
- parent element- Returns:
- double value
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getSubTree
Deprecated.This method is deprecated and will be removed.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 serverPaloJException
- exception from the library itself
-
getSubTreeAttributes
@Deprecated default Map<String,HashMap<String, getSubTreeAttributes() throws PaloException, PaloJExceptionObject>> Deprecated.This method is deprecated and will be removed.Get a map that maps an element to its attributes-values map, only the elements and its descendants will be included in the map.- Returns:
- map that maps an element to its attributes-values map
- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getAttributeValues
- Throws:
PaloException
PaloJException
-
rename
rename an element- Parameters:
newname
- new element name- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
move
move an element to a new position- Parameters:
position
- new position- Throws:
PaloException
- exception from OLAP serverPaloJException
- exception from the library itself
-
getPosition
int getPosition()get the current position- Returns:
- positive integer value
-
getPermission
get the permission for this elementIElement.ElementPermission
.IDimension.setWithElementPermission(boolean)
should be set to true before reading the elements- Returns:
- permission for this element
-