com.essbase.api.datasource

Interface IEssPartition

All Superinterfaces:

IEssBaseObject, IEssExtendedObject

public interface IEssPartition
extends IEssExtendedObject

This class should be used to work with the Essbase Partitions feature. The API declarations in this class use words local, remote to relate with Essbase cubes in the Partition pair. A user session can be active against only one cube at any point in time. Local (cube) connection in API should be assumed that the relative cube connection is the one that the user is active at that point. Remote (cube) connection relates to the cube in the Partition pair that the user is not active at the point of creating the Partition. The words local and remote in the API declarations have no relevance with the Essbase terminology data source, data target used with Essbase Partitions. The Partition's data direction and metadata-direction are used to decide the source and target cube in the Partition pair.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IEssPartition.IEssPartitionInfo

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALTER_ALL
static int	ALTER_SINGLE
static int	ALTER_TYPE_APPLICATION
static int	ALTER_TYPE_DATABASE
static int	ALTER_TYPE_SYSTEM
static int	ALTER_TYPE_USER
static short	DIRECTION_DATA_BOTH
static short	DIRECTION_DATA_SOURCE
static short	DIRECTION_DATA_TARGET
static short	DIRECTION_METADATA_BOTH
static short	DIRECTION_METADATA_SOURCE
static short	DIRECTION_METADATA_TARGET
static int	ESS_ALLCHG
static short	ESS_PARTITION_ALL
static short	ESS_PARTITION_NONE
static int	ESS_PARTITION_OTLDIM_ADD
static int	ESS_PARTITION_OTLDIM_ALL
static int	ESS_PARTITION_OTLDIM_DELETE
static int	ESS_PARTITION_OTLDIM_MBRCHG
static int	ESS_PARTITION_OTLDIM_MOVE
static int	ESS_PARTITION_OTLDIM_RENAME
static int	ESS_PARTITION_OTLDIM_UPDATE
static int	ESS_PARTITION_OTLMBR_ADD
static int	ESS_PARTITION_OTLMBR_ALL
static int	ESS_PARTITION_OTLMBR_DELETE
static int	ESS_PARTITION_OTLMBR_MOVE
static int	ESS_PARTITION_OTLMBR_RENAME
static int	ESS_PARTITION_OTLMBR_UPDATE
static int	ESS_PARTITION_OTLMBRATTR_ALIAS
static int	ESS_PARTITION_OTLMBRATTR_ALL
static int	ESS_PARTITION_OTLMBRATTR_ATTRIBUTE
static int	ESS_PARTITION_OTLMBRATTR_ATYPE
static int	ESS_PARTITION_OTLMBRATTR_CALC
static int	ESS_PARTITION_OTLMBRATTR_CCONVERT
static int	ESS_PARTITION_OTLMBRATTR_CRMBRNAME
static int	ESS_PARTITION_OTLMBRATTR_GENERATION
static int	ESS_PARTITION_OTLMBRATTR_LEVEL
static int	ESS_PARTITION_OTLMBRATTR_STATUS
static int	ESS_PARTITION_OTLMBRATTR_UCALC
static int	ESS_PARTITION_OTLMBRATTR_UDA
static short	TYPE_FEDERATED
static short	TYPE_LAZY_TRANSPARENT
static short	TYPE_LINKED
static short	TYPE_REPLICATED Partition maintenance constants
static short	TYPE_TRANSPARENT

Method Summary

Modifier and Type	Method and Description
void	alter(int setType, java.lang.String oldName, java.lang.String newName, int prtDirType) Performs sequence of steps to alter the partition.
void	delete() Performs sequence of steps to delete a Partition.
double	getAreaCellCount(java.lang.String area) Returns the cell count for the area
java.lang.String[]	getSourceArea() Get the area slices defined for source partition
java.lang.String[]	getTargetArea() Get the area slices defined for target partition
void	save() Performs sequence of steps to save the Partition by Creating/Updating the .ddb file with the details of IEssPartition on the Cube.
void	setArea(java.lang.String[] localPartionArea, java.lang.String[] remotePartitionArea) Sets the local and remote partition area
void	setDescription(java.lang.String srcDescription, java.lang.String targetDescription) Sets the Description for Source and Target partition
void	setLocalConnection(java.lang.String user, java.lang.String password) Sets the Local partition connection information.
void	setLocalConnection(java.lang.String svrName, java.lang.String user, java.lang.String password) Sets the Local partition connection information.
void	setMemberMap(java.lang.String[] localMbrs, java.lang.String[] remoteMbrs) Sets the Member Mapping for a partition.
void	setRemoteConnection(java.lang.String svrName, java.lang.String appName, java.lang.String dbName, java.lang.String userName, java.lang.String password) Sets the remote partition connection information.
void	setSliceMap(java.lang.String[] localMbrs, java.lang.String[] remoteMbrs, java.lang.String sliceName) Sets the MemberMapping for Source and Target partition that are specific to a particular Slice
void	validate() Deprecated. replaced with validateEx()
com.essbase.api.datasource.EssInvalidPartition[][]	validateEx() Performs sequence of steps to validate the partition.

Methods inherited from interface com.essbase.api.base.IEssExtendedObject

clearClientCache, getName, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

Field Detail

TYPE_REPLICATED

static final short TYPE_REPLICATED

Partition maintenance constants

See Also:

Constant Field Values

TYPE_LINKED

static final short TYPE_LINKED

See Also:

Constant Field Values

TYPE_TRANSPARENT

static final short TYPE_TRANSPARENT

See Also:

Constant Field Values

TYPE_FEDERATED

static final short TYPE_FEDERATED

See Also:

Constant Field Values

TYPE_LAZY_TRANSPARENT

static final short TYPE_LAZY_TRANSPARENT

See Also:

Constant Field Values

DIRECTION_DATA_SOURCE

static final short DIRECTION_DATA_SOURCE

See Also:

Constant Field Values

DIRECTION_DATA_TARGET

static final short DIRECTION_DATA_TARGET

See Also:

Constant Field Values

DIRECTION_DATA_BOTH

static final short DIRECTION_DATA_BOTH

See Also:

Constant Field Values

DIRECTION_METADATA_SOURCE

static final short DIRECTION_METADATA_SOURCE

See Also:

Constant Field Values

DIRECTION_METADATA_TARGET

static final short DIRECTION_METADATA_TARGET

See Also:

Constant Field Values

DIRECTION_METADATA_BOTH

static final short DIRECTION_METADATA_BOTH

See Also:

Constant Field Values

ALTER_TYPE_SYSTEM

static final int ALTER_TYPE_SYSTEM

See Also:

Constant Field Values

ALTER_TYPE_APPLICATION

static final int ALTER_TYPE_APPLICATION

See Also:

Constant Field Values

ALTER_TYPE_DATABASE

static final int ALTER_TYPE_DATABASE

See Also:

Constant Field Values

ALTER_TYPE_USER

static final int ALTER_TYPE_USER

See Also:

Constant Field Values

ALTER_SINGLE

static final int ALTER_SINGLE

See Also:

Constant Field Values

ALTER_ALL

static final int ALTER_ALL

See Also:

Constant Field Values

ESS_PARTITION_ALL

static final short ESS_PARTITION_ALL

See Also:

Constant Field Values

ESS_PARTITION_NONE

static final short ESS_PARTITION_NONE

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_ADD

static final int ESS_PARTITION_OTLDIM_ADD

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_DELETE

static final int ESS_PARTITION_OTLDIM_DELETE

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_UPDATE

static final int ESS_PARTITION_OTLDIM_UPDATE

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_MOVE

static final int ESS_PARTITION_OTLDIM_MOVE

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_RENAME

static final int ESS_PARTITION_OTLDIM_RENAME

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_MBRCHG

static final int ESS_PARTITION_OTLDIM_MBRCHG

See Also:

Constant Field Values

ESS_PARTITION_OTLDIM_ALL

static final int ESS_PARTITION_OTLDIM_ALL

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_ADD

static final int ESS_PARTITION_OTLMBR_ADD

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_DELETE

static final int ESS_PARTITION_OTLMBR_DELETE

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_RENAME

static final int ESS_PARTITION_OTLMBR_RENAME

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_MOVE

static final int ESS_PARTITION_OTLMBR_MOVE

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_UPDATE

static final int ESS_PARTITION_OTLMBR_UPDATE

See Also:

Constant Field Values

ESS_PARTITION_OTLMBR_ALL

static final int ESS_PARTITION_OTLMBR_ALL

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_STATUS

static final int ESS_PARTITION_OTLMBRATTR_STATUS

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_ALIAS

static final int ESS_PARTITION_OTLMBRATTR_ALIAS

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_UCALC

static final int ESS_PARTITION_OTLMBRATTR_UCALC

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_ATYPE

static final int ESS_PARTITION_OTLMBRATTR_ATYPE

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_CCONVERT

static final int ESS_PARTITION_OTLMBRATTR_CCONVERT

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_CRMBRNAME

static final int ESS_PARTITION_OTLMBRATTR_CRMBRNAME

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_UDA

static final int ESS_PARTITION_OTLMBRATTR_UDA

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_CALC

static final int ESS_PARTITION_OTLMBRATTR_CALC

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_LEVEL

static final int ESS_PARTITION_OTLMBRATTR_LEVEL

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_GENERATION

static final int ESS_PARTITION_OTLMBRATTR_GENERATION

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_ATTRIBUTE

static final int ESS_PARTITION_OTLMBRATTR_ATTRIBUTE

See Also:

Constant Field Values

ESS_PARTITION_OTLMBRATTR_ALL

static final int ESS_PARTITION_OTLMBRATTR_ALL

See Also:

Constant Field Values

ESS_ALLCHG

static final int ESS_ALLCHG

See Also:

Constant Field Values

Method Detail

setLocalConnection

void setLocalConnection(java.lang.String user,
                        java.lang.String password)
                 throws com.essbase.api.base.EssException

Sets the Local partition connection information. A user session can be active against only one cube at any point in time. Local (cube) connection in API should be assumed that the relative cube connection is the one that the user is active at that point. The words local in the API declarations have no relevance with the Essbase terminology data source, data target used with Essbase Partitions.

Parameters:

user - of the cube to which user is connected

password - of the cube to which user is connected

Throws:

com.essbase.api.base.EssException - if an error occurs.

setLocalConnection

void setLocalConnection(java.lang.String svrName,
                        java.lang.String user,
                        java.lang.String password)
                 throws com.essbase.api.base.EssException

Sets the Local partition connection information. A user session can be active against only one cube at any point in time. Local (cube) connection in API should be assumed that the relative cube connection is the one that the user is active at that point. The words local in the API declarations have no relevance with the Essbase terminology data source, data target used with Essbase Partitions.

Parameters:

svrName - The hostname/url of the cube to which user is connected

user - of the cube to which user is connected

password - of the cube to which user is connected

Throws:

com.essbase.api.base.EssException - if an error occurs.

setRemoteConnection

void setRemoteConnection(java.lang.String svrName,
                         java.lang.String appName,
                         java.lang.String dbName,
                         java.lang.String userName,
                         java.lang.String password)
                  throws com.essbase.api.base.EssException

Sets the remote partition connection information. Remote (cube) connection relates to the cube in the Partition pair that the user would not be active at the point of creating the Partition. The words remote in the API declarations have no relevance with the Essbase terminology data source, data target used with Essbase Partitions.

Parameters:

svrName - The hostname of target partition

appName - The Application name of the remote cube

dbName - Database name of the remote cube

userName - The username of the remote cube

password - the password of the remote cube

Throws:

com.essbase.api.base.EssException - if an error occurs.

setArea

void setArea(java.lang.String[] localPartionArea,
             java.lang.String[] remotePartitionArea)
      throws com.essbase.api.base.EssException

Sets the local and remote partition area

Parameters:

localPartionArea - will set the partition area of the cube to which user is active against

remotePartitionArea - will set the partition area of the cube with which user wants partition to pair with, it may be on same/different server

Throws:

com.essbase.api.base.EssException - if an error occurs.

setMemberMap

void setMemberMap(java.lang.String[] localMbrs,
                  java.lang.String[] remoteMbrs)
           throws com.essbase.api.base.EssException

Sets the Member Mapping for a partition.

Parameters:

localMbrs - will set the partition area of the cube to which user is active against - This will set the global mapping for local cube

remoteMbrs - will set the partition area of the cube with which user wants partition to pair with, it may be on same/different server - This will set the global mapping for remote cube

Throws:

com.essbase.api.base.EssException - if an error occurs.

setSliceMap

void setSliceMap(java.lang.String[] localMbrs,
                 java.lang.String[] remoteMbrs,
                 java.lang.String sliceName)
          throws com.essbase.api.base.EssException

Sets the MemberMapping for Source and Target partition that are specific to a particular Slice

Parameters:

localMbrs - will set the partition area of the cube to which user is active against

remoteMbrs - will set the partition area of the cube with which user wants partition to pair with, it may be on same/different server

sliceName - sliceName should be one of the members from definitions given for the remote's map. This will be used to set local mapping, which will override global mapping This should be used after the setMemberMap. User had to ensure that setMemberMap has set the global values This can be used to specify area level member mapping

Throws:

com.essbase.api.base.EssException - if an error occurs.

setDescription

void setDescription(java.lang.String srcDescription,
                    java.lang.String targetDescription)
             throws com.essbase.api.base.EssException

Sets the Description for Source and Target partition

Parameters:

srcDescription - Source partition description.

targetDescription - Target partition description.

Throws:

com.essbase.api.base.EssException - if an error occurs.

save

void save()
   throws com.essbase.api.base.EssException

Performs sequence of steps to save the Partition by Creating/Updating the .ddb file with the details of IEssPartition on the Cube.

Throws:

com.essbase.api.base.EssException - if an error occurs.

delete

void delete()
     throws com.essbase.api.base.EssException

Performs sequence of steps to delete a Partition. This operations removes the IEssPartition details from the .ddb file of the cube, and if there are no other partitions on the cube present, the .ddb file will be deleted The partition instance after the delete should not be used.

Throws:

com.essbase.api.base.EssException - if an error occurs.

validate

void validate()
       throws com.essbase.api.base.EssException

Deprecated. replaced with validateEx()

Performs sequence of steps to validate the partition

Throws:

com.essbase.api.base.EssException - if an error occurs.

validateEx

com.essbase.api.datasource.EssInvalidPartition[][] validateEx()
                                                       throws com.essbase.api.base.EssException

Performs sequence of steps to validate the partition. Returns the warnings/errors identified during the validation.

Returns:

EssInvalidPartition[][] - EssInvalidPartition[0][] has the source partition messages, EssInvalidPartition[1][] has the target partition messages

Throws:

com.essbase.api.base.EssException - if an error occurs.

alter

void alter(int setType,
           java.lang.String oldName,
           java.lang.String newName,
           int prtDirType)
    throws com.essbase.api.base.EssException

Performs sequence of steps to alter the partition.

Parameters:

setType - is IEssPartition.ALTER_TYPE_SYSTEM to alter hostname, IEssPartition.ALTER_TYPE_APPLICATION to alter appName, IEssPartition.ALTER_TYPE_DATABASE to alter dbName, IEssPartition.ALTER_TYPE_USER to connect as different partition user.

oldName - The old hostname.

newName - The new hostname.

prtDirType - IEssPartition.ALTER_SINGLE to alter source/target, IEssPartition.ALTER_ALL to alter both source and target partition

Throws:

com.essbase.api.base.EssException - if an error occurs.

getSourceArea

java.lang.String[] getSourceArea()
                          throws com.essbase.api.base.EssException

Get the area slices defined for source partition

Returns:

area slices defined for source partition

Throws:

com.essbase.api.base.EssException - if an error occurs.

getTargetArea

java.lang.String[] getTargetArea()
                          throws com.essbase.api.base.EssException

Get the area slices defined for target partition

Returns:

area slices defined for target partition

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAreaCellCount

double getAreaCellCount(java.lang.String area)
                 throws com.essbase.api.base.EssException

Returns the cell count for the area

Parameters:

area - region for which the cell count is required

Returns:

the cell count for the area/region

Throws:

com.essbase.api.base.EssException - if an error occurs.