Package com.jedox.palojlib.main

Class Dimension

java.lang.Object

com.jedox.palojlib.main.CachedComponent

com.jedox.palojlib.main.Dimension

All Implemented Interfaces:

IDimension

public class Dimension
extends CachedComponent
implements IDimension

Nested Class Summary

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

IDimension.DimensionType

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cacheExists
static final int	defaultExpiryDuration
protected LinkedHashMap<Integer,Element>	elementsIdMap
protected HashMap<String,Element>	elementsNameMap
protected static final String	EMPTY_CONSOLIDATION_LIST_ERROR_MSG
protected boolean	hasConsolidatedElements
protected DimensionInfo	info
protected static final String	SUBSET_CUBE_DIMENSION_NAME
protected static final String	SUBSET_CUBE_NAME

Fields inherited from class com.jedox.palojlib.main.CachedComponent

cacheTrustExpiry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Dimension(DimensionHandler dimensionHandler, int id, String name, Database database, IDimension.DimensionType type, String attributeDimensionId, String attributeCubeId, String maximumLevel, String maximumIndent, String maximumDepth, String token, String numberOfElements, String defaultRead, String defaultWrite, String defaultNA, String defaultTotal, String defaultParent)

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String name, IElement.ElementType type)	Create one attribute, this method does not invalidate the cache.
void	addAttributes(String[] names, IElement.ElementType[] types)	Create new attributes in this dimension
void	addAttributeValues(IAttribute attribute, IElement[] elements, Object[] values)	Writes the attribute values for these elements
IElement	addBaseElement(String name, IElement.ElementType type)	Create one element, this method does not invalidate the cache.
void	addConsolidations(IConsolidation[] consolidations)	Add the consolidations for the elements mentioned as parents in the consolidations set, the children will be added to the existing children list.
void	addElements(String[] names, IElement.ElementType[] types)	Create a list of elements
void	appendElements(IElement[] elements)	Add new elements with the given type or simply change type of existing elements
protected void	buildCache()
protected boolean	cacheExists()
protected boolean	checkCacheStatus()
void	createVirtualDimension(IAttribute attribute)	Creates a virtual dimension specified by a dimension attribute.
IElement[]	evaluateGlobalSubset(String subsetname, IVariable[] subsetVariables)	Evaluate the given subset with the set of variables
String	generateScript(IDimensionScriptContext ds)
IAttribute	getAttributeByName(String name)	Get an attribute using its name
IAttribute	getAttributeByName(String name, String language)
ICube	getAttributeCube()	Get the attribute cube if exists
protected int	getAttributeDimensionId()
IAttribute[]	getAttributes()	Get a list of attributes for this dimension
IElement[]	getBasesElements()	Get the list of the bases elements in the dimension
protected Database	getDatabase()
IElement	getDefaultNAElement()	Get the element set as default N/A for the dimension
IElement	getDefaultParentElement()	Get the element set as default parent for the dimension
IElement	getDefaultReadElement()	Get the element set as default read for the dimension
IElement	getDefaultTotalElement()	Get the element set as default total for the dimension
IElement	getDefaultWriteElement()	Get the element set as default write for the dimension
protected DimensionHandler	getDimensionhandler()
DimensionInfo	getDimensionInfo()	Get the dimension info object IDimensionInfo
IElement	getElement(String elementName, boolean withPermission)	Get a single element in the dimension, the dimension elements will not be read in this case
protected Element	getElementById(int id)
IElement	getElementByName(String name)	Get an element using its name
IElement[]	getElements()	Get the list of elements in the dimension
IElement[]	getElementsByName(String[] names)	Get an array of elements using their names, an exception will be thrown if at least one of them does not exist
String[]	getGlobalSubsets()	Get the list of global subsets
String[]	getGlobalSubsetVariables(String subsetname)	get the list of variables for the given global subset
int	getId()	Get the ID of the Dimension
String	getName()	Get the name of the dimension
IElement[]	getRootElements()	Get the list of the root elements in the dimension
IDimensionScriptContext	getScriptContext()
protected DimensionInfo	getServerDimensionInfo()
IDimension.DimensionType	getType()	Get the dimension type IDimension.DimensionType
IDimension[]	getVirtualDimensions()	Get a list of all virtual dimensions derived from attributes of this dimension
boolean	hasConsolidatedElements()	Check if at least one C-Element exists
void	markCacheDirty()	/** Set the cache to be no longer trusted without clearing the cached information.
void	moveElements(IElement[] elements, Integer[] positions)	Move a list of elements to new positions
Consolidation	newConsolidation(IElement parent, IElement child, double weight)	Create a consolidation object, no change is yet done to the dimension
Object	readAttributeValue(IElement element, String attributeName, String language)
protected DimensionInfo	refreshDimensionInfo()
int	removeAllConsolidations()	Clear all consolidations that exists in the dimension
void	removeAttributes(IAttribute[] attributes)	Removes the attributes
void	removeAttributeValues(IAttribute attribute, IElement[] elements)	Removes the attribute values for these elements in this dimension, for the given language in the attribute.
void	removeConsolidations(IElement[] elements)	Remove the consolidations for these elements i.e. their children
void	removeElements(IElement[] elements)	Removes the elements
void	removeVirtualDimension(IAttribute attribute)	Removes a virtual dimension specified by a dimension attribute.
void	rename(String name)	Rename a dimension
void	resetCache()	Clear any cached information if exists, the expiry trust time will not be affected
void	setWithElementPermission(boolean withPermission)	Decide whether elements should be read with permission or not
void	updateConsolidations(IConsolidation[] consolidations)	Update the consolidation for the elements mentioned as parents in the consolidations set.
void	updateElementsType(IElement[] elements, IElement.ElementType type)	Update the types of the elements, only ElementTypes type string and numeric can be used IElement.ElementType.

Methods inherited from class com.jedox.palojlib.main.CachedComponent

endTrustTime, inTrustTime, setCacheTrustExpiry

Methods inherited from class java.lang.Object

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

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

getBasesElements, getDefaultNAElement, getDefaultParentElement, getDefaultReadElement, getDefaultTotalElement, getDefaultWriteElement, getElement, getElementByName, getElements, getElementsByName, getRootElements, getSingleElement, getSingleElement, setCacheTrustExpiry

Field Details

defaultExpiryDuration

public static final int defaultExpiryDuration

See Also:

• Constant Field Values

info

protected DimensionInfo info

cacheExists

protected boolean cacheExists

elementsIdMap

protected LinkedHashMap<Integer,Element> elementsIdMap

elementsNameMap

protected HashMap<String,Element> elementsNameMap

hasConsolidatedElements

protected boolean hasConsolidatedElements

SUBSET_CUBE_NAME

protected static final String SUBSET_CUBE_NAME

See Also:

• Constant Field Values

SUBSET_CUBE_DIMENSION_NAME

protected static final String SUBSET_CUBE_DIMENSION_NAME

See Also:

• Constant Field Values

EMPTY_CONSOLIDATION_LIST_ERROR_MSG

protected static final String EMPTY_CONSOLIDATION_LIST_ERROR_MSG

See Also:

• Constant Field Values

Constructor Details

Dimension

protected Dimension(DimensionHandler dimensionHandler,
 int id,
 String name,
 Database database,
 IDimension.DimensionType type,
 String attributeDimensionId,
 String attributeCubeId,
 String maximumLevel,
 String maximumIndent,
 String maximumDepth,
 String token,
 String numberOfElements,
 String defaultRead,
 String defaultWrite,
 String defaultNA,
 String defaultTotal,
 String defaultParent)
             throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

Method Details

getName

public String getName()

Description copied from interface: IDimension

Get the name of the dimension

Specified by:

getName in interface IDimension

Returns:

name of the dimension

getType

public IDimension.DimensionType getType()

Description copied from interface: IDimension

Get the dimension type IDimension.DimensionType

Specified by:

getType in interface IDimension

Returns:

type

getDimensionInfo

public DimensionInfo getDimensionInfo()

Description copied from interface: IDimension

Get the dimension info object IDimensionInfo

Specified by:

getDimensionInfo in interface IDimension

Returns:

dimension info object

getElements

public IElement[] getElements()
                       throws PaloException,
PaloJException

Description copied from interface: IDimension

Get the list of elements in the dimension

Specified by:

getElements in interface IDimension

Returns:

list of elements

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getRootElements

public IElement[] getRootElements()
                           throws PaloException,
PaloJException

Description copied from interface: IDimension

Get the list of the root elements in the dimension

Specified by:

getRootElements in interface IDimension

Returns:

list of root elements

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getBasesElements

public IElement[] getBasesElements()
                            throws PaloException,
PaloJException

Description copied from interface: IDimension

Get the list of the bases elements in the dimension

Specified by:

getBasesElements in interface IDimension

Returns:

list of root elements

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

readAttributeValue

public Object readAttributeValue(IElement element,
 String attributeName,
 String language)

getElementByName

public IElement getElementByName(String name)
                          throws PaloException,
PaloJException

Description copied from interface: IDimension

Get an element using its name

Specified by:

getElementByName in interface IDimension

Parameters:

name - name of the element

Returns:

element object

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getDefaultReadElement

public IElement getDefaultReadElement()

Description copied from interface: IDimension

Get the element set as default read for the dimension

Specified by:

getDefaultReadElement in interface IDimension

Returns:

get the element if exists, null if it does not exist

getDefaultParentElement

public IElement getDefaultParentElement()

Description copied from interface: IDimension

Get the element set as default parent for the dimension

Specified by:

getDefaultParentElement in interface IDimension

Returns:

get the element if exists, null if it does not exist

getDefaultNAElement

public IElement getDefaultNAElement()

Description copied from interface: IDimension

Get the element set as default N/A for the dimension

Specified by:

getDefaultNAElement in interface IDimension

Returns:

get the element if exists, null if it does not exist

getDefaultTotalElement

public IElement getDefaultTotalElement()

Description copied from interface: IDimension

Get the element set as default total for the dimension

Specified by:

getDefaultTotalElement in interface IDimension

Returns:

get the element if exists, null if it does not exist

getDefaultWriteElement

public IElement getDefaultWriteElement()

Description copied from interface: IDimension

Get the element set as default write for the dimension

Specified by:

getDefaultWriteElement in interface IDimension

Returns:

get the element if exists, null if it does not exist

getElementsByName

public IElement[] getElementsByName(String[] names)
                             throws PaloException,
PaloJException

Description copied from interface: IDimension

Get an array of elements using their names, an exception will be thrown if at least one of them does not exist

Specified by:

getElementsByName in interface IDimension

Parameters:

names - names array of the elements

Returns:

element array object

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

hasConsolidatedElements

public boolean hasConsolidatedElements()

Description copied from interface: IDimension

Check if at least one C-Element exists

Specified by:

hasConsolidatedElements in interface IDimension

Returns:

true, if at least one C-element exists

getAttributes

public IAttribute[] getAttributes()
                           throws PaloException,
PaloJException

Description copied from interface: IDimension

Get a list of attributes for this dimension

Specified by:

getAttributes in interface IDimension

Returns:

attributes dimension attributes

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getAttributeByName

public IAttribute getAttributeByName(String name)
                              throws PaloException,
PaloJException

Description copied from interface: IDimension

Get an attribute using its name

Specified by:

getAttributeByName in interface IDimension

Parameters:

name - name of the attribute

Returns:

attribute object

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getAttributeByName

public IAttribute getAttributeByName(String name,
 String language)
                              throws PaloException,
PaloJException

Specified by:

getAttributeByName in interface IDimension

Throws:

PaloException

PaloJException

addElements

public void addElements(String[] names,
 IElement.ElementType[] types)
                 throws PaloException,
PaloJException

Description copied from interface: IDimension

Create a list of elements

Specified by:

addElements in interface IDimension

Parameters:

names - the names of the new elements

types - the types of the new elements

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

appendElements

public void appendElements(IElement[] elements)
                    throws PaloException,
PaloJException

Description copied from interface: IDimension

Add new elements with the given type or simply change type of existing elements

Specified by:

appendElements in interface IDimension

Parameters:

elements - element to append

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

moveElements

public void moveElements(IElement[] elements,
 Integer[] positions)
                  throws PaloException,
PaloJException

Description copied from interface: IDimension

Move a list of elements to new positions

Specified by:

moveElements in interface IDimension

Parameters:

elements - elements to move

positions - new positions

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addBaseElement

public IElement addBaseElement(String name,
 IElement.ElementType type)
                        throws PaloJException,
PaloException

Description copied from interface: IDimension

Create one element, this method does not invalidate the cache.

Specified by:

addBaseElement in interface IDimension

Parameters:

name - the name of the new element

type - the type of the new element

Returns:

the newly created Element

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

addAttribute

public void addAttribute(String name,
 IElement.ElementType type)
                  throws PaloJException,
PaloException

Description copied from interface: IDimension

Create one attribute, this method does not invalidate the cache.

Specified by:

addAttribute in interface IDimension

Parameters:

name - the name of the new attribute

type - the type of the new attribute

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

addAttributes

public void addAttributes(String[] names,
 IElement.ElementType[] types)
                   throws PaloJException,
PaloException

Description copied from interface: IDimension

Create new attributes in this dimension

Specified by:

addAttributes in interface IDimension

Parameters:

names - names of the new attributes

types - types of the new attributes

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

removeConsolidations

public void removeConsolidations(IElement[] elements)
                          throws PaloException,
PaloJException

Description copied from interface: IDimension

Remove the consolidations for these elements i.e. their children

Specified by:

removeConsolidations in interface IDimension

Parameters:

elements - dimension elements

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

removeAllConsolidations

public int removeAllConsolidations()
                            throws PaloException,
PaloJException

Description copied from interface: IDimension

Clear all consolidations that exists in the dimension

Specified by:

removeAllConsolidations in interface IDimension

Returns:

number of C-Elements that were converted to base element

Throws:

PaloException

PaloJException

updateConsolidations

public void updateConsolidations(IConsolidation[] consolidations)
                          throws PaloException,
PaloJException

Description copied from interface: IDimension

Update the consolidation for the elements mentioned as parents in the consolidations set.

Specified by:

updateConsolidations in interface IDimension

Parameters:

consolidations - element parent-child relationships

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

newConsolidation

public Consolidation newConsolidation(IElement parent,
 IElement child,
 double weight)

Description copied from interface: IDimension

Create a consolidation object, no change is yet done to the dimension

Specified by:

newConsolidation in interface IDimension

Parameters:

parent - parent element

child - child element

weight - child weight

Returns:

the consolidation object

removeAttributes

public void removeAttributes(IAttribute[] attributes)
                      throws PaloException,
PaloJException

Description copied from interface: IDimension

Removes the attributes

Specified by:

removeAttributes in interface IDimension

Parameters:

attributes - names of the attributes to be removed

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

removeElements

public void removeElements(IElement[] elements)
                    throws PaloException,
PaloJException

Description copied from interface: IDimension

Removes the elements

Specified by:

removeElements in interface IDimension

Parameters:

elements - names of the elements to be removed

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addAttributeValues

public void addAttributeValues(IAttribute attribute,
 IElement[] elements,
 Object[] values)
                        throws PaloJException,
PaloException

Description copied from interface: IDimension

Writes the attribute values for these elements

Specified by:

addAttributeValues in interface IDimension

Parameters:

attribute - dimension attribute

elements - dimension elements

values - attribute new values

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

removeAttributeValues

public void removeAttributeValues(IAttribute attribute,
 IElement[] elements)
                           throws PaloJException,
PaloException

Description copied from interface: IDimension

Removes the attribute values for these elements in this dimension, for the given language in the attribute.

Specified by:

removeAttributeValues in interface IDimension

Parameters:

attribute - attribute

elements - list of elements, null value means all.

Throws:

PaloJException - exception from the library itself

PaloException - exception from OLAP server

addConsolidations

public void addConsolidations(IConsolidation[] consolidations)
                       throws PaloException,
PaloJException

Description copied from interface: IDimension

Add the consolidations for the elements mentioned as parents in the consolidations set, the children will be added to the existing children list. This will send one separate request per Element.

Specified by:

addConsolidations in interface IDimension

Parameters:

consolidations - element parent-child relationships

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getAttributeCube

public ICube getAttributeCube()

Description copied from interface: IDimension

Get the attribute cube if exists

Specified by:

getAttributeCube in interface IDimension

Returns:

get the attribute cube if exists, null if it does not exist

generateScript

public String generateScript(IDimensionScriptContext ds)

Specified by:

generateScript in interface IDimension

getScriptContext

public IDimensionScriptContext getScriptContext()

Specified by:

getScriptContext in interface IDimension

buildCache

protected void buildCache()
                   throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

cacheExists

protected boolean cacheExists()

checkCacheStatus

protected boolean checkCacheStatus()
                            throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

getId

public int getId()

Description copied from interface: IDimension

Get the ID of the Dimension

Specified by:

getId in interface IDimension

Returns:

Dimension ID

rename

public void rename(String name)
            throws PaloException,
PaloJException

Description copied from interface: IDimension

Rename a dimension

Specified by:

rename in interface IDimension

Parameters:

name - new dimension name

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

updateElementsType

public void updateElementsType(IElement[] elements,
 IElement.ElementType type)
                        throws PaloException,
PaloJException

Description copied from interface: IDimension

Update the types of the elements, only ElementTypes type string and numeric can be used IElement.ElementType. Consolidated elements can not be included in the given list of elements.

Specified by:

updateElementsType in interface IDimension

Parameters:

elements - the new elements

type - string or numeric

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getElement

public IElement getElement(String elementName,
 boolean withPermission)
                    throws PaloException,
PaloJException

Description copied from interface: IDimension

Get a single element in the dimension, the dimension elements will not be read in this case

Specified by:

getElement in interface IDimension

Parameters:

elementName - name of the element

withPermission - true will get the element permissions as well, default is false.

Returns:

element if exists,otherwise null.

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getGlobalSubsetVariables

public String[] getGlobalSubsetVariables(String subsetname)

Description copied from interface: IDimension

get the list of variables for the given global subset

Specified by:

getGlobalSubsetVariables in interface IDimension

Parameters:

subsetname - name of the subset

Returns:

list of variables

evaluateGlobalSubset

public IElement[] evaluateGlobalSubset(String subsetname,
 IVariable[] subsetVariables)

Description copied from interface: IDimension

Evaluate the given subset with the set of variables

Specified by:

evaluateGlobalSubset in interface IDimension

Parameters:

subsetname - name of the subset

subsetVariables - subset variables (can be empty)

Returns:

the list of elements in the dimension that matches the subset

getGlobalSubsets

public String[] getGlobalSubsets()

Description copied from interface: IDimension

Get the list of global subsets

Specified by:

getGlobalSubsets in interface IDimension

Returns:

list of global subsets

getElementById

protected Element getElementById(int id)
                          throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

getServerDimensionInfo

protected DimensionInfo getServerDimensionInfo()
                                        throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

refreshDimensionInfo

protected DimensionInfo refreshDimensionInfo()
                                      throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

setWithElementPermission

public void setWithElementPermission(boolean withPermission)

Description copied from interface: IDimension

Decide whether elements should be read with permission or not

Specified by:

setWithElementPermission in interface IDimension

Parameters:

withPermission - true means element permission will be read as well, default is false.

resetCache

public void resetCache()

Description copied from interface: IDimension

Clear any cached information if exists, the expiry trust time will not be affected

Specified by:

resetCache in interface IDimension

markCacheDirty

public void markCacheDirty()

Description copied from interface: IDimension

/** Set the cache to be no longer trusted without clearing the cached information. Upon next access to the dimension elements, the cache will get validated and eventually updated from OLAP Server. Expiry trust time will not be affected.

Specified by:

markCacheDirty in interface IDimension

getDatabase

protected Database getDatabase()

getAttributeDimensionId

protected int getAttributeDimensionId()

createVirtualDimension

public void createVirtualDimension(IAttribute attribute)

Description copied from interface: IDimension

Creates a virtual dimension specified by a dimension attribute.

Specified by:

createVirtualDimension in interface IDimension

Parameters:

attribute - a string attribute of the dimension

removeVirtualDimension

public void removeVirtualDimension(IAttribute attribute)

Description copied from interface: IDimension

Removes a virtual dimension specified by a dimension attribute.

Specified by:

removeVirtualDimension in interface IDimension

Parameters:

attribute - a string attribute of the dimension

getVirtualDimensions

public IDimension[] getVirtualDimensions()

Description copied from interface: IDimension

Get a list of all virtual dimensions derived from attributes of this dimension

Specified by:

getVirtualDimensions in interface IDimension

Returns:

a list of virtual dimensions

getDimensionhandler

protected DimensionHandler getDimensionhandler()