Package com.jedox.palojlib.main

Class Database

java.lang.Object

com.jedox.palojlib.main.CachedComponent

com.jedox.palojlib.main.Database

All Implemented Interfaces:

IDatabase

public class Database
extends CachedComponent
implements IDatabase

Nested Class Summary

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

IDatabase.DatabaseType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	defaultExpiryDuration
static final String	defaultLanguage
protected LinkedHashMap<String,Dimension>	dimensionsNameMap

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

cacheTrustExpiry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Database(int contextId, int id, String name, IDatabase.DatabaseType type, String dimensionsNumber, String cubesNumber, String status, String token)

Method Summary

Modifier and Type	Method	Description
ICube	addCube(String name, IDimension[] dimensions)	Create a new cube with type normal
ICube	addCube(String name, IDimension[] dimensions, ICube.CubeType type)	Create a new cube with type normal
ICube	addCube(String name, IDimension[] dimensions, ICube.CubeType type, ICube basesCube)	Create a new cube with type normal
IDimension	addDimension(String name)	Create a new dimension with type normal
IDimension	addDimension(String name, IDimension.DimensionType type)	Create a new dimension
IDimension	addDimension(String name, IDimension.DimensionType type, boolean generateDefaultSubsets)	Create a new dimension
void	backup(String backupPath, boolean show_system, boolean include_archive, boolean show_audit, boolean include_csv, String password)	backup the database to disk.
String	generateScript(IDatabaseScriptContext dc)
protected Cube	getCubeById(int id)
Cube	getCubeByName(String name)	Get a certain cube by it is name, return null if does not exist.
ICube[]	getCubes()	Get the list of the cubes in the database including all types of cubes: normal,attribute,system, userinfo and gpu.
ICube[]	getCubes(IDimension dim)	Get the list of the cubes which include the given dimension.
DatabaseInfo	getDatabaseInfo()	database info IDatabaseInfo
protected Dimension	getDimensionById(int id)
IDimension	getDimensionByName(String name)	Get a certain dimension by it is name, return null if does not exist.
IDimension[]	getDimensions()	Get the list of the dimensions in the database including all types of dimensions
int	getId()	Get the id of the database
Element	getLanguageByName(String language)
Element[]	getLanguages()
String	getName()	public method from the interface
IDatabaseScriptContext	getScriptContext()
IDatabase.DatabaseType	getType()	Get the type of the database IDatabase.DatabaseType
void	removeCube(ICube c)	remove a certain cube, the cube will be moved depending on its id.
void	removeDimension(IDimension d)	remove a certain dimension, the dimension will be moved depending on its id.
void	rename(String name)	rename a database.
void	resetCaches()	clear any cached information if exists, the expiry trust time will not be affected.
void	save()	save the database to disk
void	setCacheTrustExpiries(int databaseExpiry, int cubeExpiry, int dimensionExpiry)	set the default cache trust time for the components

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.IDatabase

backup, save

Field Details

defaultExpiryDuration

public static final int defaultExpiryDuration

See Also:

• Constant Field Values

dimensionsNameMap

protected LinkedHashMap<String,Dimension> dimensionsNameMap

defaultLanguage

public static final String defaultLanguage

See Also:

• Constant Field Values

Constructor Details

Database

protected Database(int contextId,
 int id,
 String name,
 IDatabase.DatabaseType type,
 String dimensionsNumber,
 String cubesNumber,
 String status,
 String token)
            throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

Method Details

getName

public String getName()

public method from the interface

Specified by:

getName in interface IDatabase

Returns:

the name of the database

getType

public IDatabase.DatabaseType getType()

Description copied from interface: IDatabase

Get the type of the database IDatabase.DatabaseType

Specified by:

getType in interface IDatabase

Returns:

type of the database

addDimension

public IDimension addDimension(String name,
 IDimension.DimensionType type,
 boolean generateDefaultSubsets)
                        throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new dimension

Specified by:

addDimension in interface IDatabase

Parameters:

name - name of the new dimension

type - type of the dimension (normal, user info)

generateDefaultSubsets - If true the default subsets are generated for the dimension

Returns:

the newly created dimension

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDimension

public IDimension addDimension(String name,
 IDimension.DimensionType type)
                        throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new dimension

Specified by:

addDimension in interface IDatabase

Parameters:

name - name of the new dimension

type - type of the dimension (normal, user info)

Returns:

the newly created dimension

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addDimension

public IDimension addDimension(String name)
                        throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new dimension with type normal

Specified by:

addDimension in interface IDatabase

Parameters:

name - name of the new dimension

Returns:

the newly created dimension

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getDimensions

public IDimension[] getDimensions()
                           throws PaloException,
PaloJException

Description copied from interface: IDatabase

Get the list of the dimensions in the database including all types of dimensions

Specified by:

getDimensions in interface IDatabase

Returns:

list of the dimensions

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getDimensionByName

public IDimension getDimensionByName(String name)
                              throws PaloException,
PaloJException

Description copied from interface: IDatabase

Get a certain dimension by it is name, return null if does not exist.

Specified by:

getDimensionByName in interface IDatabase

Parameters:

name - name of the needed dimension

Returns:

dimension

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addCube

public ICube addCube(String name,
 IDimension[] dimensions,
 ICube.CubeType type)
              throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new cube with type normal

Specified by:

addCube in interface IDatabase

Parameters:

name - name of the new cube

dimensions - list of dimensions

type - type of the cube (normal, user info)

Returns:

the newly created cube

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addCube

public ICube addCube(String name,
 IDimension[] dimensions,
 ICube.CubeType type,
 ICube basesCube)
              throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new cube with type normal

Specified by:

addCube in interface IDatabase

Parameters:

name - name of the new cube,

dimensions - list of dimensions

type - type of the cube (normal, user info)

basesCube - the cube will be used as a base cube for the newly created cube.

Returns:

the newly created cube

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

addCube

public ICube addCube(String name,
 IDimension[] dimensions)
              throws PaloException,
PaloJException

Description copied from interface: IDatabase

Create a new cube with type normal

Specified by:

addCube in interface IDatabase

Parameters:

name - name of the new cube

dimensions - list of dimensions

Returns:

the newly created cube

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getCubes

public ICube[] getCubes()
                 throws PaloException,
PaloJException

Description copied from interface: IDatabase

Get the list of the cubes in the database including all types of cubes: normal,attribute,system, userinfo and gpu.

Specified by:

getCubes in interface IDatabase

Returns:

list of the cubes

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getCubes

public ICube[] getCubes(IDimension dim)
                 throws PaloException,
PaloJException

Description copied from interface: IDatabase

Get the list of the cubes which include the given dimension.

Specified by:

getCubes in interface IDatabase

Parameters:

dim - dimension

Returns:

list of the cubes

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getCubeByName

public Cube getCubeByName(String name)
                   throws PaloException,
PaloJException

Description copied from interface: IDatabase

Get a certain cube by it is name, return null if does not exist.

Specified by:

getCubeByName in interface IDatabase

Parameters:

name - name of the needed cube

Returns:

cube

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

removeCube

public void removeCube(ICube c)
                throws PaloException,
PaloJException

Description copied from interface: IDatabase

remove a certain cube, the cube will be moved depending on its id.

Specified by:

removeCube in interface IDatabase

Parameters:

c - cube to be removed

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

removeDimension

public void removeDimension(IDimension d)
                     throws PaloException,
PaloJException

Description copied from interface: IDatabase

remove a certain dimension, the dimension will be moved depending on its id.

Specified by:

removeDimension in interface IDatabase

Parameters:

d - dimension to be removed

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

save

public void save()
          throws PaloException,
PaloJException

Description copied from interface: IDatabase

save the database to disk

Specified by:

save in interface IDatabase

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

backup

public void backup(String backupPath,
 boolean show_system,
 boolean include_archive,
 boolean show_audit,
 boolean include_csv,
 String password)
            throws PaloException,
PaloJException

Description copied from interface: IDatabase

backup the database to disk.

Specified by:

backup in interface IDatabase

Parameters:

backupPath - Path to file with Zip extension where the backup of the database will be saved.

show_system - include also System DB to the archive

include_archive - nclude also archive files

show_audit - include also audit file to the archive

include_csv - include also csv files

password - encrypt archive with password if set. (null if no encryption should be done)

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

getId

public int getId()

Description copied from interface: IDatabase

Get the id of the database

Specified by:

getId in interface IDatabase

Returns:

the id

rename

public void rename(String name)
            throws PaloException,
PaloJException

Description copied from interface: IDatabase

rename a database.

Specified by:

rename in interface IDatabase

Parameters:

name - new database name

Throws:

PaloException - exception from OLAP server

PaloJException - exception from the library itself

generateScript

public String generateScript(IDatabaseScriptContext dc)

Specified by:

generateScript in interface IDatabase

getScriptContext

public IDatabaseScriptContext getScriptContext()

Specified by:

getScriptContext in interface IDatabase

getDatabaseInfo

public DatabaseInfo getDatabaseInfo()

Description copied from interface: IDatabase

database info IDatabaseInfo

Specified by:

getDatabaseInfo in interface IDatabase

Returns:

database info

setCacheTrustExpiries

public void setCacheTrustExpiries(int databaseExpiry,
 int cubeExpiry,
 int dimensionExpiry)

Description copied from interface: IDatabase

set the default cache trust time for the components

Specified by:

setCacheTrustExpiries in interface IDatabase

Parameters:

databaseExpiry - time in ms in which database cache will be trusted

cubeExpiry - time in ms in which cube cache will be trusted

dimensionExpiry - time in ms in which dimension cache will be trusted

getDimensionById

protected Dimension getDimensionById(int id)
                              throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

getCubeById

protected Cube getCubeById(int id)
                    throws PaloException,
PaloJException

Throws:

PaloException

PaloJException

resetCaches

public void resetCaches()

Description copied from interface: IDatabase

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

Specified by:

resetCaches in interface IDatabase

getLanguages

public Element[] getLanguages()
                       throws PaloException,
PaloJException

Specified by:

getLanguages in interface IDatabase

Throws:

PaloException

PaloJException

getLanguageByName

public Element getLanguageByName(String language)
                          throws PaloException,
PaloJException

Specified by:

getLanguageByName in interface IDatabase

Throws:

PaloException

PaloJException