|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IConnection
Represents the internal used Connection
class as an interface so that it could be implemented from others as well
Currently this is used to support the new palo server version, based on the
http protocol, as well as the legacy server.
NOTE: this class is for internal use only
Field Summary | |
---|---|
static int |
ADDORUPDATE_MODE_ADD
|
static int |
ADDORUPDATE_MODE_ADD_OR_UPDATE
|
static int |
ADDORUPDATE_MODE_FORCE_ADD
|
static int |
ADDORUPDATE_MODE_UPDATE
|
static java.lang.String |
ELEMENTINDEX_OUTOFBOUNDS
|
static java.lang.String |
NOT_CONNECTED
|
static int |
SPLASH_MODE_BASE_ADD
adds the new value to the values of the consolidated elements |
static int |
SPLASH_MODE_BASE_SET
set the value as the new value of the consolidated elements |
static int |
SPLASH_MODE_DEFAULT
recompute the values of the consolidated elements |
static int |
SPLASH_MODE_DISABLED
|
static int |
SPLASH_MODE_UNKNOWN
|
Method Summary | |
---|---|
void |
addDatabase(java.lang.String database)
Adds the given database. |
void |
clearDimension(java.lang.String database,
java.lang.String dimension)
Clears the specified dimension. |
void |
cubeCommitLog(java.lang.String database,
java.lang.String cube)
Deprecated. not required anymore |
java.lang.String[] |
cubeListDimensions(java.lang.String database,
java.lang.String cube)
Receives the dimension names of the specified cube. |
void |
cubeLoad(java.lang.String database,
java.lang.String cube)
Loads the cube data into memory. |
void |
databaseAddCube(java.lang.String database,
java.lang.String cube,
java.lang.String[] dimensions)
Adds a new cube with the given name and the specified dimensions |
void |
databaseAddDimension(java.lang.String database,
java.lang.String dimension)
Adds a new dimension to the database |
java.lang.String[] |
databaseListCubes(java.lang.String database)
Receives the cube names of the specified database |
java.lang.String[] |
databaseListDimensions(java.lang.String database)
Receives the dimension names of the specified database |
void |
databaseLoad(java.lang.String database)
Loads the given database. |
void |
databaseRenameDimension(java.lang.String database,
java.lang.String dimensionOldname,
java.lang.String dimensionNewname)
Renames a dimension |
void |
databaseSave(java.lang.String database)
Saves the specified database. |
void |
deleteCube(java.lang.String database,
java.lang.String cube)
Deletes the given cube. |
void |
deleteDatabase(java.lang.String database)
Deletes the given database. |
void |
deleteDimension(java.lang.String database,
java.lang.String dimension)
Deletes the specified dimension |
void |
dimElementDelete(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Deletes the specified element from its dimension |
ConsolidationInfo[] |
dimElementListConsolidated(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Receives the conoslidation informations about the specified element. |
void |
dimElementMove(java.lang.String database,
java.lang.String dimension,
java.lang.String element,
int newPosition)
Moves the given element to the specified position within its dimension. |
void |
dimElementRename(java.lang.String database,
java.lang.String dimension,
java.lang.String element,
java.lang.String newName)
Renames the given element |
void |
dimensionAddOrUpdateDimElement(java.lang.String database,
java.lang.String dimension,
java.lang.String element,
int addOrUpdateMode,
int dimElementType,
ConsolidationInfo[] ci,
boolean append)
Adds or update the given element. |
void |
dimensionCommitLog(java.lang.String database,
java.lang.String dimension)
Deprecated. not required anymore |
java.lang.String[] |
dimensionListCubes(java.lang.String database,
java.lang.String dimension)
Receives the cube names of the specified dimension. |
DimElementInfo[] |
dimensionListDimElements(java.lang.String database,
java.lang.String dimension)
Receives the dimension elements of the specified dimension. |
void |
dimensionProcess(java.lang.String database,
java.lang.String dimension)
Deprecated. not required anymore |
void |
disconnect()
Disconnects from the palo server |
int |
elementChildCount(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Returns the number of children for the specified element. |
int |
elementCount(java.lang.String database,
java.lang.String dimension)
Returns the number of elements for the specified dimension. |
int |
elementIndent(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Returns the indent of the given element. |
int |
elementIndex(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Returns the index of the specified element within its dimension. |
int |
elementIsChild(java.lang.String database,
java.lang.String dimension,
java.lang.String parent,
java.lang.String child)
Deprecated. not required anymore |
int |
elementLevel(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Deprecated. not required anymore |
java.lang.String |
elementName(java.lang.String database,
java.lang.String dimension,
int n)
Returns the name of the element at the given position within the specified dimension |
int |
elementParentCount(java.lang.String database,
java.lang.String dimension,
java.lang.String element)
Returns the number of parents for the specified element. |
int |
elementTopLevel(java.lang.String database,
java.lang.String dimension)
Deprecated. not required anymore |
int |
elementType(java.lang.String database,
java.lang.String dimension,
int n)
Returns the type of the element at the given position within the specified dimension |
java.lang.Object |
getData(java.lang.String database,
java.lang.String cube,
int nCoordinates,
java.lang.String[] coordinates)
Returns the value of the cell which is determined by the given coordinates. |
java.lang.Object[] |
getDataArea(java.lang.String database,
java.lang.String cube,
java.lang.String[][] elements)
Convenient method to receive multiple cell values at one time. |
java.lang.String |
getPassword()
Returns the login password |
java.lang.String |
getServer()
Returns the server name which hosts the palo server, e.g. localhost |
java.lang.String |
getService()
Returns the port number |
java.lang.String |
getUsername()
Returns the login name |
boolean |
isConnected()
Returns true if a connection to the server is established, false otherwise |
void |
ping()
Tests if the palo server is still reachable |
java.lang.String[] |
rootListDatabases()
Returns the names of the databases of the palo server |
void |
rootSave()
Saves the server data, i.e. its database names |
void |
setDataBulk(java.lang.String database,
java.lang.String cube,
java.lang.String[][] coordinates,
java.lang.Object[] values,
int splashMode)
Convenient method to set multiple cell values at one time. |
void |
setDataNumeric(java.lang.String database,
java.lang.String cube,
int nCoordinates,
java.lang.String[] coordinates,
double value)
Sets the given double value at the specified cell
getData(String, String, int, String[]) |
void |
setDataNumericSplashed(java.lang.String database,
java.lang.String cube,
int nCoordinates,
java.lang.String[] coordinates,
double value,
int splashMode)
Sets the given double value at the specified cell. |
void |
setDataString(java.lang.String database,
java.lang.String cube,
int nCoordinates,
java.lang.String[] coordinates,
java.lang.String value)
Sets the given String value at the specified cell
getData(String, String, int, String[]) |
void |
unloadCube(java.lang.String database,
java.lang.String cube)
Unloads the cube data from memory. |
void |
unloadDatabase(java.lang.String database)
Unloads the specified database from memory. |
void |
unloadDimension(java.lang.String database,
java.lang.String dimension)
Deprecated. |
Field Detail |
---|
static final java.lang.String NOT_CONNECTED
static final java.lang.String ELEMENTINDEX_OUTOFBOUNDS
static final int ADDORUPDATE_MODE_ADD
static final int ADDORUPDATE_MODE_FORCE_ADD
static final int ADDORUPDATE_MODE_UPDATE
static final int ADDORUPDATE_MODE_ADD_OR_UPDATE
static final int SPLASH_MODE_DISABLED
static final int SPLASH_MODE_UNKNOWN
static final int SPLASH_MODE_DEFAULT
static final int SPLASH_MODE_BASE_SET
static final int SPLASH_MODE_BASE_ADD
Method Detail |
---|
java.lang.String getServer()
java.lang.String getService()
java.lang.String getUsername()
java.lang.String getPassword()
boolean isConnected()
void disconnect() throws PaloException
PaloException
- if an communication exception occursvoid ping() throws PaloException
PaloException
- if palo server is not reachable anymorejava.lang.String[] rootListDatabases()
java.lang.String[] databaseListCubes(java.lang.String database)
database
- a database name
java.lang.String[] databaseListDimensions(java.lang.String database)
database
- a database name
java.lang.String[] cubeListDimensions(java.lang.String database, java.lang.String cube)
database
- the name of a database which contains the cubecube
- a cube name
java.lang.String[] dimensionListCubes(java.lang.String database, java.lang.String dimension)
database
- the name of a database which contains the dimensiondimension
- a dimension name
DimElementInfo[] dimensionListDimElements(java.lang.String database, java.lang.String dimension)
database
- the name of a database which contains the dimensiondimension
- the dimension name
DimElementInfo
arrayConsolidationInfo[] dimElementListConsolidated(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementelement
- the name of an element
ConsolidationInfo
arrayint elementChildCount(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementelement
- the name of an element
int elementParentCount(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementelement
- the name of an element
int elementCount(java.lang.String database, java.lang.String dimension)
database
- the name of a database which contains the dimensiondimension
- a dimension name
int elementIndex(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementelement
- the name of an element
int elementIsChild(java.lang.String database, java.lang.String dimension, java.lang.String parent, java.lang.String child)
database
- dimension
- parent
- child
-
int elementLevel(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- dimension
- element
-
int elementIndent(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- the name of a database which contains the dimensiondimension
- the name of the dimension which contains the elementelement
- the element name
int elementTopLevel(java.lang.String database, java.lang.String dimension)
database
- dimension
-
java.lang.String elementName(java.lang.String database, java.lang.String dimension, int n)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementn
- the element position
int elementType(java.lang.String database, java.lang.String dimension, int n)
database
- the name of a database which contains the dimensiondimension
- the dimension name which contains the elementn
- the element position
java.lang.Object getData(java.lang.String database, java.lang.String cube, int nCoordinates, java.lang.String[] coordinates) throws PaloException
Element
names from the
Dimension
s which made up the cube
. It is
important to specifiy the elements in the same order as the dimensions
are within the cube.
database
- the name of a database which contains the cubecube
- a cube namenCoordinates
- number of coordinatescoordinates
- the element names
PaloException
- if an exception occurs during the communication
with the palo serverjava.lang.Object[] getDataArea(java.lang.String database, java.lang.String cube, java.lang.String[][] elements) throws PaloException
getData(String, String, int, String[])
database
- the name of a database which contains the cubecube
- a cube nameelements
- two dimensional array of element coordinates
PaloException
- if an exception occurs during the communication
with the palo servervoid setDataString(java.lang.String database, java.lang.String cube, int nCoordinates, java.lang.String[] coordinates, java.lang.String value) throws PaloException
String
value at the specified cell
getData(String, String, int, String[])
database
- the name of a database which contains the cubecube
- a cube namenCoordinates
- number of coordinatescoordinates
- the element namesvalue
- the new value
PaloException
- if an exception occurs during the communication
with the palo servervoid setDataNumeric(java.lang.String database, java.lang.String cube, int nCoordinates, java.lang.String[] coordinates, double value) throws PaloException
double
value at the specified cell
getData(String, String, int, String[])
database
- the name of a database which contains the cubecube
- a cube namenCoordinates
- number of coordinatescoordinates
- the element namesvalue
- the new value
PaloException
- if an exception occurs during the communication
with the palo servervoid setDataNumericSplashed(java.lang.String database, java.lang.String cube, int nCoordinates, java.lang.String[] coordinates, double value, int splashMode) throws PaloException
double
value at the specified cell.
The splashMode paramater is only important for consolidated cells and
determines how the value is scattered among the consolidated elements.
Please use the defined class constants for valid values. Although more
modes are currently defined only three are supported, namely:
SPLASH_MODE_DEFAULT, SPLASH_MODE_BASE_SET and SPLASH_MODE_BASE_ADD
database
- the name of a database which contains the cubecube
- a cube namenCoordinates
- number of coordinatescoordinates
- the element namesvalue
- the new valuesplashMode
- the splash mode, use defined class constants
PaloException
- if an exception occurs during the communication
with the palo servervoid setDataBulk(java.lang.String database, java.lang.String cube, java.lang.String[][] coordinates, java.lang.Object[] values, int splashMode) throws PaloException
setDataNumericSplashed(String, String, int, String[], double, int)
database
- the name of a database which contains the cubecube
- a cube namecoordinates
- the coordinates of the cellsvalue
- the new valuessplashMode
- the splash mode, use defined class constants
PaloException
- if an exception occurs during the communication
with the palo servervoid addDatabase(java.lang.String database)
database
- name of the new database.void unloadDatabase(java.lang.String database)
database
- name of the databasevoid deleteDatabase(java.lang.String database)
database
- name of the database.void unloadDimension(java.lang.String database, java.lang.String dimension)
database
- the database name which contains the dimenionsdimension
- the dimension namevoid deleteDimension(java.lang.String database, java.lang.String dimension)
database
- the database name which contains the dimenionsdimension
- the dimension namevoid clearDimension(java.lang.String database, java.lang.String dimension)
database
- the database name which contains the dimenionsdimension
- the dimension namevoid databaseAddCube(java.lang.String database, java.lang.String cube, java.lang.String[] dimensions)
database
- name of the database to add the cube tocube
- the cube namedimensions
- the dimension namesvoid databaseAddDimension(java.lang.String database, java.lang.String dimension)
database
- name of the database to add the dimension todimensionthe
- dimension namevoid databaseRenameDimension(java.lang.String database, java.lang.String dimensionOldname, java.lang.String dimensionNewname)
database
- name of the database which contains the dimensiondimensionOldname
- old dimension namedimensionNewname
- new dimension namevoid dimensionAddOrUpdateDimElement(java.lang.String database, java.lang.String dimension, java.lang.String element, int addOrUpdateMode, int dimElementType, ConsolidationInfo[] ci, boolean append)
database
- name of the database which contains the dimensiondimension
- name of the dimension which contains the elementelement
- the element nameaddOrUpdateMode
- one of the defined add or update mode constantsdimElementType
- a valid element typeci
- ConsolidatioInfo
s if anyappend
- void dimElementRename(java.lang.String database, java.lang.String dimension, java.lang.String element, java.lang.String newName)
database
- name of the database which contains the dimensiondimension
- name of the dimension which contains the elementelement
- old element namenewName
- new element namevoid dimElementMove(java.lang.String database, java.lang.String dimension, java.lang.String element, int newPosition)
database
- name of the database which contains the dimensiondimension
- name of the dimension which contains the elementelement
- name of the element which should be movednewPosition
- the new element positionvoid dimElementDelete(java.lang.String database, java.lang.String dimension, java.lang.String element)
database
- name of the database which contains the dimensiondimension
- name of the dimension which contains the elementelement
- name of the element which should be deletedvoid cubeLoad(java.lang.String database, java.lang.String cube)
database
- name of the database which contains the cubecube
- the cube namevoid databaseLoad(java.lang.String database)
cubeLoad(String, String)
database
- name of the database to loadvoid cubeCommitLog(java.lang.String database, java.lang.String cube)
database
- name of the database which contains the cubecube
- the cube namevoid databaseSave(java.lang.String database)
database
- name of the database to savevoid rootSave()
void dimensionProcess(java.lang.String database, java.lang.String dimension)
database
- name of the database which contains the dimensiondimension
- the dimension namevoid unloadCube(java.lang.String database, java.lang.String cube)
database
- name of the database which contains the cubecube
- the cube namevoid deleteCube(java.lang.String database, java.lang.String cube)
database
- name of the database which contains the cubecube
- the cube namevoid dimensionCommitLog(java.lang.String database, java.lang.String dimension)
database
- name of the database which contains the dimensiondimension
- the dimension name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |