Skip navigation links

com.essbase.eas.essbase.ui.outline
Class Transport

java.lang.Object
com.essbase.eas.essbase.ui.outline.Transport

public final class Transport

extends java.lang.Object

implements methods used to transport outline data between the client and server layers of the application.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

Constructor Summary

Transport()

Method Summary

static boolean	addTimeDimension(Representation r, TimeDimDefn tdDefn)
static boolean	assignAttributeDimension(Representation r, Member baseDim, Member attrDim) associates an attribute dimension with a base dimension.
static boolean	assignAttributeMember(Representation r, Member[] baseMembers, long[] attrMemberHandles) associates an attribute member to a base member.
static boolean	assignDimensionAlternateHierarchy(Representation r, Member m, boolean value)
static boolean	assignDimensionCompression(Representation r, Member member, boolean value)
static boolean	assignDimensionHybridAnalysis(Representation r, Member m, boolean value)
static boolean	assignDimensionSolveOrder(Representation r, Member[] mbrs, short[] values)
static boolean	assignDimensionUniqueMembers(Representation r, Member m, boolean value)
static boolean	assignHierarchyType(Representation r, Member[] mbrs, short[] values)
static boolean	assignLevelWeight(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberAlias(Representation r, Member m, MemberAlias alias, java.lang.String value)
static boolean	assignMemberAlias(Representation r, Member m, java.lang.String tableName, java.lang.String value)
static boolean	assignMemberCategory(Representation r, Member[] mbrs, java.lang.String[] values)
static boolean	assignMemberComment(Representation r, Member[] mbrs, java.lang.String[] comments) assigns a comment for a member.
static boolean	assignMemberConsolidation(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberConversion(Representation r, Member[] mbrs, short[] values)
static CallError[]	assignMemberDimensionType(Representation r, Member m, DimensionCategory dimCategory, AttributeType attrType)
static boolean	assignMemberExtendedShareMember(Representation r, Member m, java.lang.String value)
static boolean	assignMemberFlowMetric(Representation r, Member[] mbrs, boolean[] values)
static boolean	assignMemberIndependent(Representation r, IndependentDimensionDefn[] dims, boolean[] values) Set/Unset members as independent.
static boolean	assignMemberIndependent(Representation r, Member[] mbrs, boolean[] values) Set/Unset members as independent
static boolean	assignMemberShare(Representation r, Member[] mbrs, short[] values)
static ExtendedShareMemberStatus	assignMemberShareNonUnique(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberSolveOrder(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberStorageType(Representation r, Member m, DimensionStorageType value)
static boolean	assignMemberTimeBalance(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberTimeBalanceSkip(Representation r, Member[] mbrs, short[] values)
static boolean	assignMemberTwoPass(Representation r, Member[] mbrs, boolean[] values) assigns a two pass calculation setting to a member.
static boolean	assignMemberVariance(Representation r, Member[] mbrs, boolean[] values)
static boolean	assignVaryingAttributeDimension(Representation r, Member baseDim, Member attrDim, IndependentDimensionDefn[] independentDimensions) Create a new Varying dimension association.
static boolean	assignVaryingAttributeMember(Representation r, long baseMemberHandle, VaryingMemberAttribute defn) Create a new varying attribute member association
static boolean	changeDTSGeneration(Representation r, java.lang.String dtsMember, short generation)
static boolean	clearAliasTable(Representation r, AliasTable t, boolean doBackupTable, AliasTableClearEvent atce) clears the entries in an alias table.
static boolean	clearAllAliasTables(Representation r, boolean doBackupTable, AliasTableClearEvent atce) clears all alias tables in the outline.
static boolean	closeOutline(Identifier ident)
static VerifyError[]	convertToASO(Identifier ident, Version version)
static boolean	copyAliasTable(Representation r, AliasTable target, AliasTable source, boolean merge, boolean doBackupTarget, AliasTableCopyEvent atce) copies an alias table.
static void	copyMembersBegin(Representation r, Member target, Member[] sourceMembers, boolean asSibling, CopyMemberStatus status, java.io.FileOutputStream theStream) Finds a member using the outline query api, using optional case sensitivity and whole word matching
static boolean	copyMembersContinue(Representation r, Member target, boolean asSibling, CopyMemberStatus status, java.io.FileOutputStream theStream)
static MemberCorrected	correctASOOutline(Identifier ident)
static boolean	createAliasTable(Representation r, java.lang.String value) attempts to create an alias table.
static void	createBooleanChildren(Representation r, Member parent)
static boolean	createGeneration(Representation r, java.lang.String dimensionName, java.lang.String generation, short genNumber, boolean genUnique)
static boolean	createLevel(Representation r, java.lang.String dimensionName, java.lang.String level, short levelNumber)
static boolean	createLevel(Representation r, java.lang.String dimensionName, java.lang.String level, short levelNumber, boolean levelUnique)
static Member	createMember(Representation r, Member parent, Member sibling, java.lang.String value)
static long	createSmartlist(Representation r, java.lang.String smartlistName)
static boolean	deleteAliasTable(Representation r, AliasTable t, boolean doBackupTable, AliasTableDeleteEvent atde) removes an alias table from the outline.
static boolean	deleteAllAliasTables(Representation r, boolean doBackupTable, AliasTableDeleteEvent atde) removes all alias tables (except the default) from the outline.
static boolean	deleteDTSMemberAlias(Representation r, java.lang.String dtsMember, java.lang.String tableName)
static boolean	deleteGeneration(Representation r, java.lang.String dimensionName, short genNumber)
static boolean	deleteLevel(Representation r, java.lang.String dimensionName, short levelNumber)
static DeleteMemberError[]	deleteMembers(Representation r, Member[] members, MemberDeleteEvent mde)
static java.io.File	deleteMembersBlock(Representation r, Member[] members)
static boolean	deleteSmartlist(Representation r, long smartlistHandle)
static boolean	deleteUDA(Representation r, Member[] mbrs, java.lang.String[] values) deletes a single UDA for a member.
static boolean	enableDTSMember(Representation r, java.lang.String dtsMember, short generation, boolean enable)
static boolean	enableTextualMeasuresSupport(Representation r, boolean value) Updates whether Textual Measures support are enabled for an outline or not.
static boolean	enableVaryingAttributesSupport(Representation r, boolean value) Updates whether varying attributes are enabled for an outline or not.
static boolean	exportAliasTable(Representation r, java.lang.String aliasTableName, java.lang.Object outputObject)
static boolean	exportDimension(Representation r, Member m, java.lang.String comment, boolean associate, boolean merge)
static java.lang.String[]	exportSmartlist(Representation r, long smartlistHandle, java.lang.String fileName)
static boolean	findMembers(Representation r, FindRequest request, java.util.Collection results)
static IndexMemberAccessFile	findMembersFile(Representation r, FindRequest request)
static boolean	findSmartlist(Representation r, java.lang.String smartlistName)
static boolean	generateCurrencyDatabase(Representation r, java.lang.String serverName, java.lang.String appName, java.lang.String dbName, boolean isNonUnique)
static SLODefinition[]	getAllSmartlists(Representation r)
static IndependentDimensionDefn[]	getAssociatedIndependentDimensions(Representation r, Member attrDim) Returns all independent dimensions and the role they play (Continuous or discrete) associated with an attribute dimension.This is the only way to find whether an attribute dimension is varying or not.An empty set is returned for non varying attribute dimensions and a valid set of independent dimensions are returned for a varying attribute dimension.
static IndependentDimensionDefn[]	getAssociatedIndependentDimensionsQuery(Representation r, Member attrDim) Returns all independent dimensions associated with an attribute dimension in Query Mode.This is the only way to find whether an attribute dimension is varying or not.An empty set is returned for non varying attribute dimensions and a valid set of independent dimensions are returned for a varying attribute dimension.
static void	getAttributeSpecs(Representation r) retrieves the attribute specs for an outline representation.
static ExtendedShareMemberStatus	getBaseMembers(Representation r, Member m)
static int	getChildMemberIndex(Representation r, java.lang.String dimension, java.lang.String parentName, java.lang.String memberName, int startSearchIndex, int endSearchIndex)
static Member[]	getChildren(Representation r, java.lang.String dimName, Member parent) retrieves the children of a member for an outline.
static MemberAccessFile	getChildrenFile(Representation r, java.lang.String dimName, Member parent, int startIndex) retrieves the children of a member and returns the file containing the results.
static MemberAccessFile	getChildrenFile(Representation r, java.lang.String dimName, Member parent, int startIndex, int count)
static Member[]	getCompressionDimension(Representation r, java.lang.String memberName)
static boolean	getDataLoaded(Representation r) retrieves a boolean object indicating whether the outline has data loaded or not.
static boolean	getDataLoadedFor(DefaultOutlineFileObject otlObject) retrieves a boolean object indicating whether the outline has data loaded or not.
static java.lang.String	getDateFormatString(Representation r)
static Member[]	getDimensions(Representation r) retrieves the dimensions for an outline.
static boolean	getDimensionsEligibleForCompression(java.lang.String serverName, java.lang.String appName, java.lang.String dbName, java.util.Collection results)
static Member[]	getDimensionsQueryOnly(Identifier identifier, Database database) retrieves the dimensions for an outline in query mode.
static java.lang.String[]	getDimensionUDAS(Representation r, Member m) retrieves the UDAs for a member.
static java.util.List	getDynamicTimeSeriesMembers(Representation r)
static java.util.List	getDynamicTimeSeriesNames(Representation r, java.lang.String dimension, java.lang.String aliastbl)
static DynamicTimeSeries[]	getEnabledDTSMembers(Representation r)
static long	getFreeMemory()
static java.util.List	getGenerationMembers(Representation r, java.lang.String dimension)
static DefinedGeneration[]	getGenerations(Representation r)
static java.util.List	getLevelMembers(Representation r, java.lang.String dimension)
static DefinedLevel[]	getLevels(Representation r)
static boolean	getLinkedAttributeAttachmentLevel(Representation r, Member m, LinkedAttributeAttachmentLevel level) Added by K.Karthik Method used to get the attachment level for a linked view attribute
static MemberAlias[]	getMemberAliases(Representation r, AliasTable t, Member[] members) retrieves the aliases for a set of members from a given table.
static Member[]	getMemberAncestors(Representation r, Member m)
static Member[]	getMemberAncestorsEx(Representation r, Member m)
static Member[]	getMemberAncestorsEx(Representation r, java.lang.String memberName, long handle)
static MemberAttribute[]	getMemberAttributes(Representation r, Member m)
static long	getMemberChildCount(Representation r, Member m) retrieves a block of members from the mid-tier.
static java.lang.String	getMemberCombinedName(Representation r, long memberHandle)
static java.lang.String	getMemberFormatString(Representation r, long memberHandle)
static short	getMemberLevel(Representation r, Member m)
static java.lang.Long[]	getMemberParentBlock(Representation r, Member[] mbrs)
static Member	getMemberProperties(Representation r, Member m)
static java.io.File	getMemberProperties(Representation r, Member[] members)
static Member	getMemberProperties(Representation r, Member m, boolean getLongName)
static long	getMemberSmartlist(Representation r, long memberHandle)
static short	getMemberType(Representation r, Member member)
static void	getOPGVersion(Representation r) retrieves the opg version of the outline and sets it into the representation
static void	getQueryHints(Representation r)
static java.lang.String[]	getServerDateFormatsForDateMeasures(Representation r)
static void	getSettings(Representation r) retrieves the settings for an outline representation.
static SLODefinition	getSmartlist(Representation r, long memberHandle)
static SLODefinition	getSmartlistFromMemberName(Representation r, Member member)
static long	getSmartlistMemberAssociationCount(Representation r, long smartlistHandle)
static MemberAttribute[]	getVaryingMemberAttributes(Representation r, Member baseMember, Member attrDim, ValiditySet[] searchPerspective, boolean needValiditySet) Returns all attribute members for a given base member.
static boolean	importAliasTable(Representation r, ImportAliasTableRequest request)
static boolean	importAliasTables(Representation r, java.lang.Object[] aliasTableFiles, boolean fileExistsInMidTier)
static boolean	importDimension(Representation r, java.lang.String dimensionName)
static SLODefinition	importSmartlist(Representation r, byte type, java.lang.String contents, java.lang.String smartlistName)
static void	initializeViewer(Representation r) retrieves the initialization settings dimensions, attribute specs, data setting and dynamic time series settings for initializing the viewer
static boolean	isMoreDescendantsExist(Representation r, Member[] members)
static boolean	isOutlineLocked(Database db) checks to determine if an outline object is locked.
static boolean	isOutlineUnicodeEnabled(Representation r)
static boolean	moveMember(Representation r, Member target, Member source, boolean asSibling)
static MoveMemberStatus	moveMembers(Representation r, Member target, Member[] sourceMembers, boolean asSibling, MoveMemberStatus status, java.io.FileOutputStream theStream)
static MoveMemberStatus	moveMembersContinue(Representation r, Member target, boolean asSibling, MoveMemberStatus status, java.io.FileOutputStream theStream)
static Identifier	openOutline(Database db) opens an outline for editing from the server.
static Identifier	openOutline(Database db, boolean incrementalEdit)
static Identifier	openOutline(Database db, boolean incrementalEdit, boolean checkAvailablememory)
static Identifier	openOutlineFile(java.io.File fileToOpen) opens an outline for editing from the server.
static Identifier	openOutlineLocalFile(java.io.File fileToOpen) opens an outline for editing from client.
static IndexMemberAccessFile	printMembersFile(Representation r, PrintRequest request)
static boolean	putSmartlist(Representation r, java.util.ArrayList pidList, java.util.ArrayList valuesList, java.lang.String missingName, java.lang.String outOfRangeName, long smartlistHandle)
static Identifier	reloadMidTierOutline(Identifier identifier)
static boolean	renameAliasTable(Representation r, java.lang.String name, java.lang.String value)
static boolean	renameMember(Representation r, Member m, java.lang.String value)
static boolean	renameMemberNonUnique(Representation r, Member m, java.lang.String value, java.util.ArrayList handles)
static boolean	renameMembers(Representation r, Member m, java.lang.Long[] handles, java.lang.String value)
static boolean	replaceMember(Representation r, ReplaceRequest request, long memberHandle, java.util.Collection results)
static IndexMemberAccessFile	replaceMembers(Representation r, ReplaceRequest request)
static boolean	restructureOutline(Representation r, RestructureOption option)
static boolean	saveOutlineAs(Representation r, DefaultOutlineFileObject otlObject, RestructureOption option, boolean unlock)
static SaveAsFileStatus	saveOutlineAsFileBegin(Representation r, java.lang.String saveFileName)
static SaveAsFileStatus	saveOutlineAsFileContinue(Representation r, SaveAsFileStatus status, java.io.FileOutputStream theStream)
static void	saveOutlineAsFileEnd(Representation r, SaveAsFileStatus status)
static VerifyError[]	setAsCompressionDimension(java.lang.String serverName, java.lang.String appName, java.lang.String dbName, java.lang.String dimensionName)
static boolean	setChildOrder(Representation r, Member m, SortChildrenResult theHandles, SortChildrenResult handles)
static boolean	setDateFormatString(Representation r, java.lang.String formatString)
static boolean	setDimensionDataMember(Representation r, java.lang.String dimName, java.lang.String memberName)
static boolean	setDTSMemberAlias(Representation r, java.lang.String dtsMember, java.lang.String tableName, java.lang.String value)
static boolean	setLinkedAttributeAttachmentLevel(Representation r, Member m, int level) Added by K.Karthik Method used to set the attachment level for a linked view attribute
static boolean	setMemberFormatString(Representation r, long memberHandle, java.lang.String formatString)
static boolean	setMemberSmartlist(Representation r, long memberHandle, long smartlistHandle)
static boolean	setMemberType(Representation r, long memberHandle, short type)
static boolean	setOPGVersion(Representation r, int version)
static boolean	setOutlineType(Identifier ident, OutlineType outlineType)
static boolean	setUDA(Representation r, Member[] mbrs, java.lang.String[] values) sets a single UDA for a member.
static boolean	sortChildrenFor(Representation r, Member m, boolean fAscending, SortChildrenResult handles)
static boolean	unassignAttributeDimension(Representation r, Member baseDim, Member attrDim) disassociates an attribute dimension with a base dimension.
static boolean	unassignAttributeMember(Representation r, Member[] baseMembers, long[] attrMemberHandles) disassociates an attribute member from a base dimension member.
static boolean	unassignVaryingAttributeDimension(Representation r, Member baseDim, Member attrDim) Disassociates an varying attribute dimension from a base dimension.
static boolean	unassignVaryingAttributeMember(Representation r, long baseMemberHandle, VaryingMemberAttribute defn) Disassociates a varying association
static MemberHandleCollection	undoDeleteMembers(Representation r, java.lang.String indexFileName, java.lang.String dataFileName, MemberDeleteEvent mde)
static MoveMemberStatus	undoMoveMembers(Representation r, java.io.File handlesFile, MoveMemberStatus status, java.io.FileOutputStream theStream)
static MoveMemberStatus	undoMoveMembersContinue(Representation r, MoveMemberStatus status, java.io.FileOutputStream theStream)
static boolean	updateAutoConfigure(Representation r, boolean value)
static boolean	updateAverageMemberName(Representation r, java.lang.String value)
static boolean	updateBooleanFalseMemberName(Representation r, java.lang.String value)
static boolean	updateBooleanTrueMemberName(Representation r, java.lang.String value)
static boolean	updateBucketingType(Representation r, BucketingType value)
static boolean	updateCalculationDimensionName(Representation r, java.lang.String value)
static boolean	updateCaseSensitivity(Representation r, boolean value) updates the case-sensitive setting for an outline.
static boolean	updateCountMemberName(Representation r, java.lang.String value)
static boolean	updateDateMemberFormat(Representation r, AttributeDateFormat value)
static boolean	updateLongNameConstructor(Representation r, LongNameConstructor value) updates the long name constructor property for an outline.
static boolean	updateLongNameDelimiter(Representation r, LongNameDelimiter value) updates the long name delimiter property for an outline.
static boolean	updateLongNameSource(Representation r, LongNameSource value) updates the long name source property for an outline.
static boolean	updateMaximumMemberName(Representation r, java.lang.String value)
static boolean	updateMemberFormula(Representation r, Member[] mbrs, java.lang.String[] formulas)
static boolean	updateMinimumMemberName(Representation r, java.lang.String value)
static boolean	updateNonUnique(Representation r, boolean value) updates the non-unique setting for an outline.
static void	updateQueryHints(Representation r)
static boolean	updateSumMemberName(Representation r, java.lang.String value)
static FormatStringVerifyError[]	verifyFormatString(Representation r, java.lang.String format, Member m)
static FormulaVerifyError[]	verifyMemberFormula(Representation r, Formula f, Member m)
static VerifyError[]	verifyOutline(Representation r)
static VerifyError[]	verifyOutlineWithoutFormula(Representation r)
static boolean	writeOutline(Representation r)

Methods inherited from class java.lang.Object

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

Constructor Detail

Transport

public Transport()

Method Detail

isOutlineLocked

public static boolean isOutlineLocked(Database db)
                               throws java.lang.Exception

checks to determine if an outline object is locked.

Throws:

java.lang.Exception

openOutline

public static Identifier openOutline(Database db)

opens an outline for editing from the server. Calls the command requestor and attempts to open the outline for the requested database.

openOutline

public static Identifier openOutline(Database db,
                                     boolean incrementalEdit)

openOutline

public static Identifier openOutline(Database db,
                                     boolean incrementalEdit,
                                     boolean checkAvailablememory)

openOutlineLocalFile

public static Identifier openOutlineLocalFile(java.io.File fileToOpen)

opens an outline for editing from client. Calls the command requestor and attempts to open the outline without transfering the outine file since the eas client and server are on the same system.

reloadMidTierOutline

public static Identifier reloadMidTierOutline(Identifier identifier)

openOutlineFile

public static Identifier openOutlineFile(java.io.File fileToOpen)

opens an outline for editing from the server. Calls the command requestor and attempts to open the outline for the requested database.

verifyOutline

public static VerifyError[] verifyOutline(Representation r)

verifyOutlineWithoutFormula

public static VerifyError[] verifyOutlineWithoutFormula(Representation r)

writeOutline

public static boolean writeOutline(Representation r)

restructureOutline

public static boolean restructureOutline(Representation r,
                                         RestructureOption option)

closeOutline

public static boolean closeOutline(Identifier ident)

convertToASO

public static VerifyError[] convertToASO(Identifier ident,
                                         Version version)

setOutlineType

public static boolean setOutlineType(Identifier ident,
                                     OutlineType outlineType)

correctASOOutline

public static MemberCorrected correctASOOutline(Identifier ident)

saveOutlineAs

public static boolean saveOutlineAs(Representation r,
                                    DefaultOutlineFileObject otlObject,
                                    RestructureOption option,
                                    boolean unlock)

saveOutlineAsFileBegin

public static SaveAsFileStatus saveOutlineAsFileBegin(Representation r,
                                                      java.lang.String saveFileName)

saveOutlineAsFileContinue

public static SaveAsFileStatus saveOutlineAsFileContinue(Representation r,
                                                         SaveAsFileStatus status,
                                                         java.io.FileOutputStream theStream)

saveOutlineAsFileEnd

public static void saveOutlineAsFileEnd(Representation r,
                                        SaveAsFileStatus status)

getDataLoaded

public static boolean getDataLoaded(Representation r)

retrieves a boolean object indicating whether the outline has data loaded or not.

getDataLoadedFor

public static boolean getDataLoadedFor(DefaultOutlineFileObject otlObject)

retrieves a boolean object indicating whether the outline has data loaded or not.

getOPGVersion

public static void getOPGVersion(Representation r)

retrieves the opg version of the outline and sets it into the representation

Parameters:

r - the representation object

getSettings

public static void getSettings(Representation r)

retrieves the settings for an outline representation. Creates a UISettings object from the Settings object that is returned from the XML layer.

getQueryHints

public static void getQueryHints(Representation r)

updateQueryHints

public static void updateQueryHints(Representation r)

getAttributeSpecs

public static void getAttributeSpecs(Representation r)

retrieves the attribute specs for an outline representation. Creates a UIAttributeSpecs object from the AttributeSpecs object that is returned from the XML layer.

initializeViewer

public static void initializeViewer(Representation r)

retrieves the initialization settings dimensions, attribute specs, data setting and dynamic time series settings for initializing the viewer

renameAliasTable

public static boolean renameAliasTable(Representation r,
                                       java.lang.String name,
                                       java.lang.String value)

createAliasTable

public static boolean createAliasTable(Representation r,
                                       java.lang.String value)

attempts to create an alias table.

Parameters:

r - a Representation object identifying the outline.

value - name for the new alias table.

deleteAliasTable

public static boolean deleteAliasTable(Representation r,
                                       AliasTable t,
                                       boolean doBackupTable,
                                       AliasTableDeleteEvent atde)

removes an alias table from the outline.

deleteAllAliasTables

public static boolean deleteAllAliasTables(Representation r,
                                           boolean doBackupTable,
                                           AliasTableDeleteEvent atde)

removes all alias tables (except the default) from the outline.

clearAliasTable

public static boolean clearAliasTable(Representation r,
                                      AliasTable t,
                                      boolean doBackupTable,
                                      AliasTableClearEvent atce)

clears the entries in an alias table.

clearAllAliasTables

public static boolean clearAllAliasTables(Representation r,
                                          boolean doBackupTable,
                                          AliasTableClearEvent atce)

clears all alias tables in the outline.

copyAliasTable

public static boolean copyAliasTable(Representation r,
                                     AliasTable target,
                                     AliasTable source,
                                     boolean merge,
                                     boolean doBackupTarget,
                                     AliasTableCopyEvent atce)

copies an alias table.

updateBucketingType

public static boolean updateBucketingType(Representation r,
                                          BucketingType value)

updateBooleanFalseMemberName

public static boolean updateBooleanFalseMemberName(Representation r,
                                                   java.lang.String value)

updateBooleanTrueMemberName

public static boolean updateBooleanTrueMemberName(Representation r,
                                                  java.lang.String value)

updateCaseSensitivity

public static boolean updateCaseSensitivity(Representation r,
                                            boolean value)

updates the case-sensitive setting for an outline.

updateAutoConfigure

public static boolean updateAutoConfigure(Representation r,
                                          boolean value)

updateDateMemberFormat

public static boolean updateDateMemberFormat(Representation r,
                                             AttributeDateFormat value)

updateLongNameSource

public static boolean updateLongNameSource(Representation r,
                                           LongNameSource value)

updates the long name source property for an outline.

updateLongNameDelimiter

public static boolean updateLongNameDelimiter(Representation r,
                                              LongNameDelimiter value)

updates the long name delimiter property for an outline.

updateLongNameConstructor

public static boolean updateLongNameConstructor(Representation r,
                                                LongNameConstructor value)

updates the long name constructor property for an outline.

updateSumMemberName

public static boolean updateSumMemberName(Representation r,
                                          java.lang.String value)

updateAverageMemberName

public static boolean updateAverageMemberName(Representation r,
                                              java.lang.String value)

updateMinimumMemberName

public static boolean updateMinimumMemberName(Representation r,
                                              java.lang.String value)

updateMaximumMemberName

public static boolean updateMaximumMemberName(Representation r,
                                              java.lang.String value)

updateCountMemberName

public static boolean updateCountMemberName(Representation r,
                                            java.lang.String value)

updateCalculationDimensionName

public static boolean updateCalculationDimensionName(Representation r,
                                                     java.lang.String value)

updateMemberFormula

public static boolean updateMemberFormula(Representation r,
                                          Member[] mbrs,
                                          java.lang.String[] formulas)

updateNonUnique

public static boolean updateNonUnique(Representation r,
                                      boolean value)

updates the non-unique setting for an outline.

getDimensionsQueryOnly

public static Member[] getDimensionsQueryOnly(Identifier identifier,
                                              Database database)

retrieves the dimensions for an outline in query mode. This method is designed to work with an outline viewer.

getDimensions

public static Member[] getDimensions(Representation r)

retrieves the dimensions for an outline. This method is designed to work both with an outline viewer and an outline editor.

getChildrenFile

public static MemberAccessFile getChildrenFile(Representation r,
                                               java.lang.String dimName,
                                               Member parent,
                                               int startIndex)

retrieves the children of a member and returns the file containing the results.

getChildrenFile

public static MemberAccessFile getChildrenFile(Representation r,
                                               java.lang.String dimName,
                                               Member parent,
                                               int startIndex,
                                               int count)

getChildren

public static Member[] getChildren(Representation r,
                                   java.lang.String dimName,
                                   Member parent)

retrieves the children of a member for an outline. This method is designed to work both with an outline viewer and an outline editor.

getMemberChildCount

public static long getMemberChildCount(Representation r,
                                       Member m)

retrieves a block of members from the mid-tier.

getMemberAncestors

public static Member[] getMemberAncestors(Representation r,
                                          Member m)

getMemberAncestorsEx

public static Member[] getMemberAncestorsEx(Representation r,
                                            java.lang.String memberName,
                                            long handle)

getMemberAncestorsEx

public static Member[] getMemberAncestorsEx(Representation r,
                                            Member m)

getMemberProperties

public static Member getMemberProperties(Representation r,
                                         Member m)

getMemberProperties

public static Member getMemberProperties(Representation r,
                                         Member m,
                                         boolean getLongName)

getMemberLevel

public static short getMemberLevel(Representation r,
                                   Member m)

getMemberAliases

public static MemberAlias[] getMemberAliases(Representation r,
                                             AliasTable t,
                                             Member[] members)

retrieves the aliases for a set of members from a given table.

getMemberAttributes

public static MemberAttribute[] getMemberAttributes(Representation r,
                                                    Member m)

assignAttributeDimension

public static boolean assignAttributeDimension(Representation r,
                                               Member baseDim,
                                               Member attrDim)

associates an attribute dimension with a base dimension.

unassignAttributeDimension

public static boolean unassignAttributeDimension(Representation r,
                                                 Member baseDim,
                                                 Member attrDim)

disassociates an attribute dimension with a base dimension.

assignAttributeMember

public static boolean assignAttributeMember(Representation r,
                                            Member[] baseMembers,
                                            long[] attrMemberHandles)

associates an attribute member to a base member.

unassignAttributeMember

public static boolean unassignAttributeMember(Representation r,
                                              Member[] baseMembers,
                                              long[] attrMemberHandles)

disassociates an attribute member from a base dimension member.

setOPGVersion

public static boolean setOPGVersion(Representation r,
                                    int version)

setUDA

public static boolean setUDA(Representation r,
                             Member[] mbrs,
                             java.lang.String[] values)

sets a single UDA for a member.

deleteUDA

public static boolean deleteUDA(Representation r,
                                Member[] mbrs,
                                java.lang.String[] values)

deletes a single UDA for a member.

getDimensionUDAS

public static java.lang.String[] getDimensionUDAS(Representation r,
                                                  Member m)

retrieves the UDAs for a member.

createGeneration

public static boolean createGeneration(Representation r,
                                       java.lang.String dimensionName,
                                       java.lang.String generation,
                                       short genNumber,
                                       boolean genUnique)

deleteGeneration

public static boolean deleteGeneration(Representation r,
                                       java.lang.String dimensionName,
                                       short genNumber)

getGenerations

public static DefinedGeneration[] getGenerations(Representation r)

createLevel

public static boolean createLevel(Representation r,
                                  java.lang.String dimensionName,
                                  java.lang.String level,
                                  short levelNumber)

createLevel

public static boolean createLevel(Representation r,
                                  java.lang.String dimensionName,
                                  java.lang.String level,
                                  short levelNumber,
                                  boolean levelUnique)

deleteLevel

public static boolean deleteLevel(Representation r,
                                  java.lang.String dimensionName,
                                  short levelNumber)

getLevels

public static DefinedLevel[] getLevels(Representation r)

assignHierarchyType

public static boolean assignHierarchyType(Representation r,
                                          Member[] mbrs,
                                          short[] values)

assignLevelWeight

public static boolean assignLevelWeight(Representation r,
                                        Member[] mbrs,
                                        short[] values)

assignMemberFlowMetric

public static boolean assignMemberFlowMetric(Representation r,
                                             Member[] mbrs,
                                             boolean[] values)

assignMemberAlias

public static boolean assignMemberAlias(Representation r,
                                        Member m,
                                        java.lang.String tableName,
                                        java.lang.String value)

assignMemberAlias

public static boolean assignMemberAlias(Representation r,
                                        Member m,
                                        MemberAlias alias,
                                        java.lang.String value)

assignMemberComment

public static boolean assignMemberComment(Representation r,
                                          Member[] mbrs,
                                          java.lang.String[] comments)

assigns a comment for a member.

assignMemberDimensionType

public static CallError[] assignMemberDimensionType(Representation r,
                                                    Member m,
                                                    DimensionCategory dimCategory,
                                                    AttributeType attrType)

assignMemberTwoPass

public static boolean assignMemberTwoPass(Representation r,
                                          Member[] mbrs,
                                          boolean[] values)

assigns a two pass calculation setting to a member.

assignMemberConsolidation

public static boolean assignMemberConsolidation(Representation r,
                                                Member[] mbrs,
                                                short[] values)

assignMemberSolveOrder

public static boolean assignMemberSolveOrder(Representation r,
                                             Member[] mbrs,
                                             short[] values)

Parameters:

r -

mbrs -

values -

Returns:

assignMemberShareNonUnique

public static ExtendedShareMemberStatus assignMemberShareNonUnique(Representation r,
                                                                   Member[] mbrs,
                                                                   short[] values)

assignMemberShare

public static boolean assignMemberShare(Representation r,
                                        Member[] mbrs,
                                        short[] values)

assignMemberExtendedShareMember

public static boolean assignMemberExtendedShareMember(Representation r,
                                                      Member m,
                                                      java.lang.String value)

getBaseMembers

public static ExtendedShareMemberStatus getBaseMembers(Representation r,
                                                       Member m)

assignMemberStorageType

public static boolean assignMemberStorageType(Representation r,
                                              Member m,
                                              DimensionStorageType value)

assignMemberTimeBalance

public static boolean assignMemberTimeBalance(Representation r,
                                              Member[] mbrs,
                                              short[] values)

assignMemberTimeBalanceSkip

public static boolean assignMemberTimeBalanceSkip(Representation r,
                                                  Member[] mbrs,
                                                  short[] values)

assignMemberVariance

public static boolean assignMemberVariance(Representation r,
                                           Member[] mbrs,
                                           boolean[] values)

assignMemberConversion

public static boolean assignMemberConversion(Representation r,
                                             Member[] mbrs,
                                             short[] values)

assignMemberCategory

public static boolean assignMemberCategory(Representation r,
                                           Member[] mbrs,
                                           java.lang.String[] values)

assignDimensionHybridAnalysis

public static boolean assignDimensionHybridAnalysis(Representation r,
                                                    Member m,
                                                    boolean value)

assignDimensionAlternateHierarchy

public static boolean assignDimensionAlternateHierarchy(Representation r,
                                                        Member m,
                                                        boolean value)

assignDimensionSolveOrder

public static boolean assignDimensionSolveOrder(Representation r,
                                                Member[] mbrs,
                                                short[] values)

Parameters:

r -

mbrs -

values -

Returns:

assignDimensionUniqueMembers

public static boolean assignDimensionUniqueMembers(Representation r,
                                                   Member m,
                                                   boolean value)

assignDimensionCompression

public static boolean assignDimensionCompression(Representation r,
                                                 Member member,
                                                 boolean value)

getCompressionDimension

public static Member[] getCompressionDimension(Representation r,
                                               java.lang.String memberName)

setAsCompressionDimension

public static VerifyError[] setAsCompressionDimension(java.lang.String serverName,
                                                      java.lang.String appName,
                                                      java.lang.String dbName,
                                                      java.lang.String dimensionName)

generateCurrencyDatabase

public static boolean generateCurrencyDatabase(Representation r,
                                               java.lang.String serverName,
                                               java.lang.String appName,
                                               java.lang.String dbName,
                                               boolean isNonUnique)

verifyMemberFormula

public static FormulaVerifyError[] verifyMemberFormula(Representation r,
                                                       Formula f,
                                                       Member m)

createBooleanChildren

public static void createBooleanChildren(Representation r,
                                         Member parent)

createMember

public static Member createMember(Representation r,
                                  Member parent,
                                  Member sibling,
                                  java.lang.String value)

setDimensionDataMember

public static boolean setDimensionDataMember(Representation r,
                                             java.lang.String dimName,
                                             java.lang.String memberName)

deleteMembers

public static DeleteMemberError[] deleteMembers(Representation r,
                                                Member[] members,
                                                MemberDeleteEvent mde)
                                         throws DeleteMembersException

Throws:

DeleteMembersException

undoDeleteMembers

public static MemberHandleCollection undoDeleteMembers(Representation r,
                                                       java.lang.String indexFileName,
                                                       java.lang.String dataFileName,
                                                       MemberDeleteEvent mde)

isMoreDescendantsExist

public static boolean isMoreDescendantsExist(Representation r,
                                             Member[] members)

deleteMembersBlock

public static java.io.File deleteMembersBlock(Representation r,
                                              Member[] members)

renameMember

public static boolean renameMember(Representation r,
                                   Member m,
                                   java.lang.String value)

renameMemberNonUnique

public static boolean renameMemberNonUnique(Representation r,
                                            Member m,
                                            java.lang.String value,
                                            java.util.ArrayList handles)

renameMembers

public static boolean renameMembers(Representation r,
                                    Member m,
                                    java.lang.Long[] handles,
                                    java.lang.String value)

setChildOrder

public static boolean setChildOrder(Representation r,
                                    Member m,
                                    SortChildrenResult theHandles,
                                    SortChildrenResult handles)

sortChildrenFor

public static boolean sortChildrenFor(Representation r,
                                      Member m,
                                      boolean fAscending,
                                      SortChildrenResult handles)

getEnabledDTSMembers

public static DynamicTimeSeries[] getEnabledDTSMembers(Representation r)

enableDTSMember

public static boolean enableDTSMember(Representation r,
                                      java.lang.String dtsMember,
                                      short generation,
                                      boolean enable)

deleteDTSMemberAlias

public static boolean deleteDTSMemberAlias(Representation r,
                                           java.lang.String dtsMember,
                                           java.lang.String tableName)

setDTSMemberAlias

public static boolean setDTSMemberAlias(Representation r,
                                        java.lang.String dtsMember,
                                        java.lang.String tableName,
                                        java.lang.String value)

changeDTSGeneration

public static boolean changeDTSGeneration(Representation r,
                                          java.lang.String dtsMember,
                                          short generation)

findMembersFile

public static IndexMemberAccessFile findMembersFile(Representation r,
                                                    FindRequest request)

findMembers

public static boolean findMembers(Representation r,
                                  FindRequest request,
                                  java.util.Collection results)

replaceMembers

public static IndexMemberAccessFile replaceMembers(Representation r,
                                                   ReplaceRequest request)

replaceMember

public static boolean replaceMember(Representation r,
                                    ReplaceRequest request,
                                    long memberHandle,
                                    java.util.Collection results)

copyMembersBegin

public static void copyMembersBegin(Representation r,
                                    Member target,
                                    Member[] sourceMembers,
                                    boolean asSibling,
                                    CopyMemberStatus status,
                                    java.io.FileOutputStream theStream)

Finds a member using the outline query api, using optional case sensitivity and whole word matching

copyMembersContinue

public static boolean copyMembersContinue(Representation r,
                                          Member target,
                                          boolean asSibling,
                                          CopyMemberStatus status,
                                          java.io.FileOutputStream theStream)

moveMember

public static boolean moveMember(Representation r,
                                 Member target,
                                 Member source,
                                 boolean asSibling)

moveMembers

public static MoveMemberStatus moveMembers(Representation r,
                                           Member target,
                                           Member[] sourceMembers,
                                           boolean asSibling,
                                           MoveMemberStatus status,
                                           java.io.FileOutputStream theStream)

moveMembersContinue

public static MoveMemberStatus moveMembersContinue(Representation r,
                                                   Member target,
                                                   boolean asSibling,
                                                   MoveMemberStatus status,
                                                   java.io.FileOutputStream theStream)

undoMoveMembers

public static MoveMemberStatus undoMoveMembers(Representation r,
                                               java.io.File handlesFile,
                                               MoveMemberStatus status,
                                               java.io.FileOutputStream theStream)

undoMoveMembersContinue

public static MoveMemberStatus undoMoveMembersContinue(Representation r,
                                                       MoveMemberStatus status,
                                                       java.io.FileOutputStream theStream)

importAliasTable

public static boolean importAliasTable(Representation r,
                                       ImportAliasTableRequest request)

importAliasTables

public static boolean importAliasTables(Representation r,
                                        java.lang.Object[] aliasTableFiles,
                                        boolean fileExistsInMidTier)

exportAliasTable

public static boolean exportAliasTable(Representation r,
                                       java.lang.String aliasTableName,
                                       java.lang.Object outputObject)

getFreeMemory

public static long getFreeMemory()

getMemberParentBlock

public static java.lang.Long[] getMemberParentBlock(Representation r,
                                                    Member[] mbrs)

getGenerationMembers

public static java.util.List getGenerationMembers(Representation r,
                                                  java.lang.String dimension)

getLevelMembers

public static java.util.List getLevelMembers(Representation r,
                                             java.lang.String dimension)

getDynamicTimeSeriesMembers

public static java.util.List getDynamicTimeSeriesMembers(Representation r)

getDynamicTimeSeriesNames

public static java.util.List getDynamicTimeSeriesNames(Representation r,
                                                       java.lang.String dimension,
                                                       java.lang.String aliastbl)

exportDimension

public static boolean exportDimension(Representation r,
                                      Member m,
                                      java.lang.String comment,
                                      boolean associate,
                                      boolean merge)

importDimension

public static boolean importDimension(Representation r,
                                      java.lang.String dimensionName)

getMemberProperties

public static java.io.File getMemberProperties(Representation r,
                                               Member[] members)

printMembersFile

public static IndexMemberAccessFile printMembersFile(Representation r,
                                                     PrintRequest request)

addTimeDimension

public static boolean addTimeDimension(Representation r,
                                       TimeDimDefn tdDefn)

getLinkedAttributeAttachmentLevel

public static boolean getLinkedAttributeAttachmentLevel(Representation r,
                                                        Member m,
                                                        LinkedAttributeAttachmentLevel level)

Added by K.Karthik Method used to get the attachment level for a linked view attribute

Parameters:

r - Representation

m - LVA member

level - Attacahement Level is returned through this object

Returns:

Success or failure

setLinkedAttributeAttachmentLevel

public static boolean setLinkedAttributeAttachmentLevel(Representation r,
                                                        Member m,
                                                        int level)

Added by K.Karthik Method used to set the attachment level for a linked view attribute

Parameters:

r - Representation

m - LVA member

level - Attacahement Level

Returns:

Success or failure

getDimensionsEligibleForCompression

public static boolean getDimensionsEligibleForCompression(java.lang.String serverName,
                                                          java.lang.String appName,
                                                          java.lang.String dbName,
                                                          java.util.Collection results)

enableVaryingAttributesSupport

public static boolean enableVaryingAttributesSupport(Representation r,
                                                     boolean value)

Updates whether varying attributes are enabled for an outline or not.

Parameters:

r - Representation

value - Boolean value (enable or disable)

assignVaryingAttributeDimension

public static boolean assignVaryingAttributeDimension(Representation r,
                                                      Member baseDim,
                                                      Member attrDim,
                                                      IndependentDimensionDefn[] independentDimensions)

Create a new Varying dimension association. i.e Associates an attribute dimension with a base dimension for the specified set of independent dimensions

Parameters:

baseDim - base dimension

attrDim - Attribute dimensions

independentDimensions - Independent dimension defintions

unassignVaryingAttributeDimension

public static boolean unassignVaryingAttributeDimension(Representation r,
                                                        Member baseDim,
                                                        Member attrDim)

Disassociates an varying attribute dimension from a base dimension.

Parameters:

baseDim - Base dimension

attrDim - Attribute dimension

getAssociatedIndependentDimensions

public static IndependentDimensionDefn[] getAssociatedIndependentDimensions(Representation r,
                                                                            Member attrDim)

Returns all independent dimensions and the role they play (Continuous or discrete) associated with an attribute dimension.This is the only way to find whether an attribute dimension is varying or not.An empty set is returned for non varying attribute dimensions and a valid set of independent dimensions are returned for a varying attribute dimension.

Parameters:

attrDim - Attribute dimension

Returns:

Set of independent dimensions and its roles

getAssociatedIndependentDimensionsQuery

public static IndependentDimensionDefn[] getAssociatedIndependentDimensionsQuery(Representation r,
                                                                                 Member attrDim)

Returns all independent dimensions associated with an attribute dimension in Query Mode.This is the only way to find whether an attribute dimension is varying or not.An empty set is returned for non varying attribute dimensions and a valid set of independent dimensions are returned for a varying attribute dimension.

Parameters:

attrDim - Attribute dimension

Returns:

Set of independent dimension

assignMemberIndependent

public static boolean assignMemberIndependent(Representation r,
                                              IndependentDimensionDefn[] dims,
                                              boolean[] values)

Set/Unset members as independent. This method is used only for providing an easy option to unset independent property when give an array Independent dimension definitions rather than member array. Please note that the type fiels in Independent dimension definition is unused.

Parameters:

r - Representation

mbrs - Array of independent dimension definitions (Type field is not used)

values - Boolean values whether the corresponding members in mbrs array are independent or not

assignMemberIndependent

public static boolean assignMemberIndependent(Representation r,
                                              Member[] mbrs,
                                              boolean[] values)

Set/Unset members as independent

Parameters:

r - Representation

mbrs - Array of members

values - Boolean values whether the corresponding members in mbrs array are independent or not

getVaryingMemberAttributes

public static MemberAttribute[] getVaryingMemberAttributes(Representation r,
                                                           Member baseMember,
                                                           Member attrDim,
                                                           ValiditySet[] searchPerspective,
                                                           boolean needValiditySet)
                                                    throws java.lang.Exception

Returns all attribute members for a given base member.

Parameters:

r - Representation

baseMember - Base member

attrDim - Attribute dimension

perspective - Search perspective array (Supported only in Query mode)

needValiditySet - Boolean to require whether validity set is required or not

Returns:

Attribute member associations

Throws:

java.lang.Exception

assignVaryingAttributeMember

public static boolean assignVaryingAttributeMember(Representation r,
                                                   long baseMemberHandle,
                                                   VaryingMemberAttribute defn)

Create a new varying attribute member association

Parameters:

r - Representation

baseMemberHandle - Base member handle

defn - Varying member attribute definition

Returns:

Success or failure

unassignVaryingAttributeMember

public static boolean unassignVaryingAttributeMember(Representation r,
                                                     long baseMemberHandle,
                                                     VaryingMemberAttribute defn)

Disassociates a varying association

Parameters:

r - Representation

baseMemberHandle - Base member handle

defn - varying attribute definition

Returns:

Success or failure

createSmartlist

public static long createSmartlist(Representation r,
                                   java.lang.String smartlistName)

putSmartlist

public static boolean putSmartlist(Representation r,
                                   java.util.ArrayList pidList,
                                   java.util.ArrayList valuesList,
                                   java.lang.String missingName,
                                   java.lang.String outOfRangeName,
                                   long smartlistHandle)

exportSmartlist

public static java.lang.String[] exportSmartlist(Representation r,
                                                 long smartlistHandle,
                                                 java.lang.String fileName)

importSmartlist

public static SLODefinition importSmartlist(Representation r,
                                            byte type,
                                            java.lang.String contents,
                                            java.lang.String smartlistName)

findSmartlist

public static boolean findSmartlist(Representation r,
                                    java.lang.String smartlistName)

deleteSmartlist

public static boolean deleteSmartlist(Representation r,
                                      long smartlistHandle)

setMemberSmartlist

public static boolean setMemberSmartlist(Representation r,
                                         long memberHandle,
                                         long smartlistHandle)

getMemberSmartlist

public static long getMemberSmartlist(Representation r,
                                      long memberHandle)

getAllSmartlists

public static SLODefinition[] getAllSmartlists(Representation r)

getSmartlist

public static SLODefinition getSmartlist(Representation r,
                                         long memberHandle)

getSmartlistFromMemberName

public static SLODefinition getSmartlistFromMemberName(Representation r,
                                                       Member member)

enableTextualMeasuresSupport

public static boolean enableTextualMeasuresSupport(Representation r,
                                                   boolean value)

Updates whether Textual Measures support are enabled for an outline or not.

Parameters:

r - Representation

value - Boolean value (enable or disable)

setMemberType

public static boolean setMemberType(Representation r,
                                    long memberHandle,
                                    short type)

getMemberType

public static short getMemberType(Representation r,
                                  Member member)

setMemberFormatString

public static boolean setMemberFormatString(Representation r,
                                            long memberHandle,
                                            java.lang.String formatString)

getMemberFormatString

public static java.lang.String getMemberFormatString(Representation r,
                                                     long memberHandle)

getServerDateFormatsForDateMeasures

public static java.lang.String[] getServerDateFormatsForDateMeasures(Representation r)

getSmartlistMemberAssociationCount

public static long getSmartlistMemberAssociationCount(Representation r,
                                                      long smartlistHandle)

setDateFormatString

public static boolean setDateFormatString(Representation r,
                                          java.lang.String formatString)

getDateFormatString

public static java.lang.String getDateFormatString(Representation r)

verifyFormatString

public static FormatStringVerifyError[] verifyFormatString(Representation r,
                                                           java.lang.String format,
                                                           Member m)

getMemberCombinedName

public static java.lang.String getMemberCombinedName(Representation r,
                                                     long memberHandle)

isOutlineUnicodeEnabled

public static boolean isOutlineUnicodeEnabled(Representation r)

getChildMemberIndex

public static int getChildMemberIndex(Representation r,
                                      java.lang.String dimension,
                                      java.lang.String parentName,
                                      java.lang.String memberName,
                                      int startSearchIndex,
                                      int endSearchIndex)

Skip navigation links