Skip navigation links

com.essbase.eas.essbase.ui.outline
Class Representation

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

public class Representation

extends java.lang.Object

provides a generic representation of an outline. This class is a reworking of the myriad representations that existed before.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

Field Summary

static short	OPERATION_COPY
static short	OPERATION_CUT
static short	OPERATION_NONE
static int	OPG_VERSION_1112
static int	OPG_VERSION_71
static int	OPG_VERSION_72
static int	OPG_VERSION_74
static int	OPG_VERSION_900
static int	OPG_VERSION_930
static int	OPG_VERSION_9311
static int	OPG_VERSION_950
static int	OPG_VERSION_CURRENT
static short	REQUEST_ALIASES
static short	REQUEST_ATTRS
static short	REQUEST_FORMULA
static short	REQUEST_UDAS
protected static Identifier	sourceIdentifier indicates the source outline for copy
static OutlineType	sourceType indicates the source outline type for copy

Constructor Summary

Representation()
constructs an outline Representation that is editable

Representation(Database db, boolean setEditable)
constructs an outline Representation for a database and for editing/viewing as requested.

Representation(Database db, boolean setEditable, boolean rolapCheck)
Special constructor to only initialize the outline type

Representation(Database db, Identifier id, boolean setEditable)
constructs an outline Representation for a database and for editing/viewing as requested.

Representation(Database db, Identifier id, boolean setEditable, boolean forQueryHints, java.lang.String selectedColumn, Member[] allDimensions)

Representation(java.io.File f, Identifier id, boolean setEditable)
constructs an outline Representation for a file and for editing/viewing as requested.

Representation(java.io.File f, Identifier id, boolean setEditable, boolean forQueryHints, java.lang.String selectedColumn, Member[] allDimensions)

Method Summary

void	addEventListener(RepresentationListener l)
void	addFile(java.lang.Object file)
void	addOutlineModfiedListener(javax.swing.JTabbedPane tabbedPane)
void	addSLODefinition(SLODefinition sloDefn)
void	addToOpenedAccessFileList(MemberAccessFile file)
void	cancelPendingOperation() cancels any pending operation.
void	clearAllModified() clears all the modified list for this representation.
void	clearModified() clears the modified state for this representation.
boolean	doesServerVersionSupportNonUnique()
boolean	doesServerVersionSupportQueryHints()
boolean	doesServerVersionSupportSmartlist()
void	eventTaken(EditEvent ev) adds an event to the set of transactions taken on this outline.
protected void	eventUndone(EditEvent ev)
protected void	fireActiveAliasTableChangedEvent() fires an event when the active alias table is changed.
protected void	fireEventTakenEvent(EditEvent e) fires an event when the database has changed.
protected void	fireEventUndone(EditEvent e) fires an event when another event has been undone.
java.lang.String	getActiveAliasTable() retrieves the name of the active alias table.
AttributeSpecs	getAttributeSpecs() retrieves the attribute specifications.
Database	getDatabase() retrieves the representation's database.
boolean	getDataPresentAtOpen() returns the value indicating that data was loaded when the outline was opened.
Member	getDimensionFor(java.lang.String value) returns the dimension for a string name.
Member[]	getDimensions()
DynamicTimeSeries[]	getDynamicTimeSeries()
boolean	getEditable() retrieves the editable/viewable property.
java.io.File	getFileSource() retrieves the representation's file source.
java.util.List	getFormulaFunctionList() Return the list of functions available for the formula editor for this outline
DefinedGeneration[]	getGenerations()
Identifier	getIdentifier() retrieves the representation's identifier.
DefinedLevel[]	getLevels()
int	getMaxAliasTableSize()
static Member[]	getMembersForOperation() retrives the member if a pending operation is of the correct type.
boolean	getModelForQueryHints()
EditEvent	getNotifyingEvent() retrieves the event currently being broadcast as taken or undone.
int	getOPGCurrentVersion()
int	getOPGVersion()
DefaultOutlineModel	getOutlineModel() retrieves the outline model.
DefaultOutlineModel	getOutlineModelForQueryHints(java.lang.String selectedColumn, Member[] allDimensions)
short	getPendingOperation() retrieves the type of pending operation
QueryHint[][]	getQueryHints() retrieves the query hints for this representation
int	getServerOPGVersion() Return the OPG version based on the server version
Version	getServerVersion() return the server version that this outline is opened from
Settings	getSettings() retrieves the representation's settings.
java.lang.String	getShortValueForMemberName(Member member)
java.lang.String	getShortValueForMemberName(Member dimension, Member member)
java.lang.String	getShortValueForMemberName(java.lang.String longname) returns a short name for a member based on the current outline settings.
java.util.ArrayList	getSmartListDefinitions()
EditEvent[]	getTransactions() retrieves the transactions.
protected void	handleAliasTableClearEventUndo(AliasTableClearEvent atce)
protected void	handleAliasTableCopyEvent(AliasTableCopyEvent event)
protected void	handleAliasTableCopyEventUndo(AliasTableCopyEvent atce)
protected void	handleAliasTableCreateEvent(AliasTableCreateEvent event)
protected void	handleAliasTableCreateEventUndo(AliasTableCreateEvent event)
protected void	handleAliasTableDeleteEvent(AliasTableDeleteEvent event)
protected void	handleAliasTableDeleteEventUndo(AliasTableDeleteEvent atde)
protected void	handleAliasTableImportEvent(AliasTableImportEvent event)
protected void	handleAliasTableImportEventUndo(AliasTableImportEvent atie)
protected void	handleAliasTableRenameEvent(AliasTableRenameEvent event)
protected void	handleAliasTableRenameEventUndo(AliasTableRenameEvent event)
boolean	hasQueryOpenError()
void	initiateMemberOperation(Member[] members, short operation)
void	initiateMemberOperation(Member m, short operation) sets a pending operation for a specific member.
boolean	isASO()
boolean	isClearAllDataDone(boolean verifyDataLoaded) indicates whether clear all data is done when this outline is saved.
boolean	isDataLoaded()
boolean	isDim_NumOrder_changed() indicates whether the number or order of dimensions is changed when the outline is saved.
boolean	isMigrationNeeded(boolean saveToFileSystem) Is OPG Version migration needed?
boolean	isModified() returns information about this representation's modified state.
boolean	isOPGVersion1112orLater()
boolean	isOPGVersion71()
boolean	isOPGVersion72()
boolean	isOPGVersion900()
boolean	isOPGVersion930() Returns true if the outline belongs to Beckett version(9.3.0)
boolean	isOPGVersion93OrLater()
boolean	isOPGVersion950OrLater()
boolean	isOPGVersionAfter72()
boolean	isOPGVersionBefore950()
boolean	isOutlineEmpty()
boolean	isQueryHintsModified()
boolean	isRestructureRequired() indicates whether a restructure operation is needed when this outline is saved.
boolean	isRestructureRequiredFromEvents()
boolean	isUndoAvailable()
java.lang.String	modifyMemberName(java.lang.String name, java.lang.String dimName)
void	performUndo()
void	release()
void	removeEventListener(RepresentationListener l)
void	removeFromOpenedAccessFileList(MemberAccessFile file)
void	removeOutlineModifiedListener(javax.swing.JTabbedPane tabbedPane)
void	removeSLODefinition(SLODefinition sloDefn)
void	resetModified() Madhavi: resets the modified state for this representation.
void	resetQueryHintsModified()
void	retrieveQueryHints()
void	setActiveAliasTable(java.lang.String value) sets the active alias table and fires an event.
void	setAttributeSpecs(AttributeSpecs value) sets the representation's attribute specs.
void	setDataPresentAtOpen(boolean dataPresentAtOpen)
void	setDefaultAsActiveTable() sets the default table as the active table.
boolean	setDimensionDataMembers()
void	setDimensions(Member[] dims)
void	setDynamicTimeSeries(DynamicTimeSeries[] series)
void	setFormulaFunctionList(java.util.List list) Set the list of functions available for the formula editor for this outline
void	setGenerations(DefinedGeneration[] definedGenerations)
void	setIdentifier(Identifier value) set's the representation identifier.
void	setLevels(DefinedLevel[] definedLevels)
void	setModified()
void	setOPGVersion(int version)
void	setOutlineEmpty(boolean value)
static void	setPendingOperation(short op)
void	setQueryHints(QueryHint[][] queryHints) sets the representation's query hints
void	setQueryHintsModified() Added to find if Query Hints are modified for this representation.
void	setQueryOpenError(boolean value)
void	setSettings(Settings value) sets the representation's settings.
void	updateUndoItem(javax.swing.JMenuItem undoItem)

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NONE

public static final short OPERATION_NONE

See Also:

Constant Field Values

OPERATION_CUT

public static final short OPERATION_CUT

See Also:

Constant Field Values

OPERATION_COPY

public static final short OPERATION_COPY

See Also:

Constant Field Values

REQUEST_UDAS

public static final short REQUEST_UDAS

See Also:

Constant Field Values

REQUEST_FORMULA

public static final short REQUEST_FORMULA

See Also:

Constant Field Values

REQUEST_ATTRS

public static final short REQUEST_ATTRS

See Also:

Constant Field Values

REQUEST_ALIASES

public static final short REQUEST_ALIASES

See Also:

Constant Field Values

OPG_VERSION_71

public static final int OPG_VERSION_71

See Also:

Constant Field Values

OPG_VERSION_72

public static final int OPG_VERSION_72

See Also:

Constant Field Values

OPG_VERSION_74

public static final int OPG_VERSION_74

See Also:

Constant Field Values

OPG_VERSION_900

public static final int OPG_VERSION_900

See Also:

Constant Field Values

OPG_VERSION_930

public static final int OPG_VERSION_930

See Also:

Constant Field Values

OPG_VERSION_9311

public static final int OPG_VERSION_9311

See Also:

Constant Field Values

OPG_VERSION_950

public static final int OPG_VERSION_950

See Also:

Constant Field Values

OPG_VERSION_1112

public static final int OPG_VERSION_1112

See Also:

Constant Field Values

OPG_VERSION_CURRENT

public static final int OPG_VERSION_CURRENT

See Also:

Constant Field Values

sourceIdentifier

protected static Identifier sourceIdentifier

indicates the source outline for copy

sourceType

public static OutlineType sourceType

indicates the source outline type for copy

Constructor Detail

Representation

public Representation()

constructs an outline Representation that is editable

Representation

public Representation(Database db,
                      boolean setEditable)

constructs an outline Representation for a database and for editing/viewing as requested.

Representation

public Representation(Database db,
                      boolean setEditable,
                      boolean rolapCheck)

Special constructor to only initialize the outline type

Parameters:

db -

setEditable -

rolapCheck -

Representation

public Representation(Database db,
                      Identifier id,
                      boolean setEditable)

constructs an outline Representation for a database and for editing/viewing as requested.

Representation

public Representation(java.io.File f,
                      Identifier id,
                      boolean setEditable)

constructs an outline Representation for a file and for editing/viewing as requested.

Representation

public Representation(java.io.File f,
                      Identifier id,
                      boolean setEditable,
                      boolean forQueryHints,
                      java.lang.String selectedColumn,
                      Member[] allDimensions)

Representation

public Representation(Database db,
                      Identifier id,
                      boolean setEditable,
                      boolean forQueryHints,
                      java.lang.String selectedColumn,
                      Member[] allDimensions)

Method Detail

isDim_NumOrder_changed

public boolean isDim_NumOrder_changed()

indicates whether the number or order of dimensions is changed when the outline is saved.

isDataLoaded

public boolean isDataLoaded()

retrieveQueryHints

public void retrieveQueryHints()

getModelForQueryHints

public boolean getModelForQueryHints()

addOutlineModfiedListener

public void addOutlineModfiedListener(javax.swing.JTabbedPane tabbedPane)

removeOutlineModifiedListener

public void removeOutlineModifiedListener(javax.swing.JTabbedPane tabbedPane)

getTransactions

public EditEvent[] getTransactions()

retrieves the transactions.

getEditable

public boolean getEditable()

retrieves the editable/viewable property.

getDatabase

public Database getDatabase()

retrieves the representation's database.

getFileSource

public java.io.File getFileSource()

retrieves the representation's file source.

getIdentifier

public Identifier getIdentifier()

retrieves the representation's identifier.

setIdentifier

public void setIdentifier(Identifier value)

set's the representation identifier.

getOutlineModel

public DefaultOutlineModel getOutlineModel()

retrieves the outline model.

getOutlineModelForQueryHints

public DefaultOutlineModel getOutlineModelForQueryHints(java.lang.String selectedColumn,
                                                        Member[] allDimensions)

getPendingOperation

public short getPendingOperation()

retrieves the type of pending operation

setPendingOperation

public static void setPendingOperation(short op)

initiateMemberOperation

public void initiateMemberOperation(Member m,
                                    short operation)

sets a pending operation for a specific member.

initiateMemberOperation

public void initiateMemberOperation(Member[] members,
                                    short operation)

getMembersForOperation

public static Member[] getMembersForOperation()

retrives the member if a pending operation is of the correct type.

getNotifyingEvent

public EditEvent getNotifyingEvent()

retrieves the event currently being broadcast as taken or undone.

cancelPendingOperation

public void cancelPendingOperation()

cancels any pending operation.

getActiveAliasTable

public java.lang.String getActiveAliasTable()

retrieves the name of the active alias table.

setActiveAliasTable

public void setActiveAliasTable(java.lang.String value)

sets the active alias table and fires an event.

setDefaultAsActiveTable

public void setDefaultAsActiveTable()

sets the default table as the active table.

getSettings

public Settings getSettings()

retrieves the representation's settings.

getQueryHints

public QueryHint[][] getQueryHints()

retrieves the query hints for this representation

setSettings

public void setSettings(Settings value)

sets the representation's settings.

setQueryHints

public void setQueryHints(QueryHint[][] queryHints)

sets the representation's query hints

getAttributeSpecs

public AttributeSpecs getAttributeSpecs()

retrieves the attribute specifications.

setAttributeSpecs

public void setAttributeSpecs(AttributeSpecs value)

sets the representation's attribute specs.

setDynamicTimeSeries

public void setDynamicTimeSeries(DynamicTimeSeries[] series)

getDynamicTimeSeries

public DynamicTimeSeries[] getDynamicTimeSeries()

setGenerations

public void setGenerations(DefinedGeneration[] definedGenerations)

getGenerations

public DefinedGeneration[] getGenerations()

setDimensions

public void setDimensions(Member[] dims)

getDimensions

public Member[] getDimensions()

setLevels

public void setLevels(DefinedLevel[] definedLevels)

getLevels

public DefinedLevel[] getLevels()

getDimensionFor

public Member getDimensionFor(java.lang.String value)

returns the dimension for a string name. If the string represents a member, returns the dimension for that member; if the string represents a dimension, returns that object.

eventTaken

public void eventTaken(EditEvent ev)

adds an event to the set of transactions taken on this outline. If the event can be undone, adds it to the undoStack as well; if not, the undoStack is cleared.

eventUndone

protected void eventUndone(EditEvent ev)

isModified

public boolean isModified()

returns information about this representation's modified state.

setDataPresentAtOpen

public void setDataPresentAtOpen(boolean dataPresentAtOpen)

getDataPresentAtOpen

public boolean getDataPresentAtOpen()

returns the value indicating that data was loaded when the outline was opened.

setDimensionDataMembers

public boolean setDimensionDataMembers()

isRestructureRequired

public boolean isRestructureRequired()

indicates whether a restructure operation is needed when this outline is saved.

isClearAllDataDone

public boolean isClearAllDataDone(boolean verifyDataLoaded)

indicates whether clear all data is done when this outline is saved.

isRestructureRequiredFromEvents

public boolean isRestructureRequiredFromEvents()

clearModified

public void clearModified()

clears the modified state for this representation.

clearAllModified

public void clearAllModified()

clears all the modified list for this representation.

resetModified

public void resetModified()

Madhavi: resets the modified state for this representation.

setModified

public void setModified()

setQueryHintsModified

public void setQueryHintsModified()

Added to find if Query Hints are modified for this representation.

resetQueryHintsModified

public void resetQueryHintsModified()

isQueryHintsModified

public boolean isQueryHintsModified()

addEventListener

public void addEventListener(RepresentationListener l)

removeEventListener

public void removeEventListener(RepresentationListener l)

getShortValueForMemberName

public java.lang.String getShortValueForMemberName(Member dimension,
                                                   Member member)

getShortValueForMemberName

public java.lang.String getShortValueForMemberName(Member member)

getShortValueForMemberName

public java.lang.String getShortValueForMemberName(java.lang.String longname)

returns a short name for a member based on the current outline settings. Warning: this isn't guaranteed to be perfect.

modifyMemberName

public java.lang.String modifyMemberName(java.lang.String name,
                                         java.lang.String dimName)

performUndo

public void performUndo()

isUndoAvailable

public boolean isUndoAvailable()

updateUndoItem

public void updateUndoItem(javax.swing.JMenuItem undoItem)

handleAliasTableDeleteEventUndo

protected void handleAliasTableDeleteEventUndo(AliasTableDeleteEvent atde)

handleAliasTableClearEventUndo

protected void handleAliasTableClearEventUndo(AliasTableClearEvent atce)

handleAliasTableCopyEventUndo

protected void handleAliasTableCopyEventUndo(AliasTableCopyEvent atce)

handleAliasTableImportEventUndo

protected void handleAliasTableImportEventUndo(AliasTableImportEvent atie)

handleAliasTableCopyEvent

protected void handleAliasTableCopyEvent(AliasTableCopyEvent event)

handleAliasTableCreateEvent

protected void handleAliasTableCreateEvent(AliasTableCreateEvent event)

handleAliasTableCreateEventUndo

protected void handleAliasTableCreateEventUndo(AliasTableCreateEvent event)

handleAliasTableDeleteEvent

protected void handleAliasTableDeleteEvent(AliasTableDeleteEvent event)

handleAliasTableRenameEvent

protected void handleAliasTableRenameEvent(AliasTableRenameEvent event)

handleAliasTableRenameEventUndo

protected void handleAliasTableRenameEventUndo(AliasTableRenameEvent event)

handleAliasTableImportEvent

protected void handleAliasTableImportEvent(AliasTableImportEvent event)

fireActiveAliasTableChangedEvent

protected void fireActiveAliasTableChangedEvent()

fires an event when the active alias table is changed.

fireEventTakenEvent

protected void fireEventTakenEvent(EditEvent e)

fires an event when the database has changed.

fireEventUndone

protected void fireEventUndone(EditEvent e)

fires an event when another event has been undone.

getFormulaFunctionList

public java.util.List getFormulaFunctionList()

Return the list of functions available for the formula editor for this outline

Returns:

setFormulaFunctionList

public void setFormulaFunctionList(java.util.List list)

Set the list of functions available for the formula editor for this outline

Parameters:

list - - the list of FunctionCategory

addFile

public void addFile(java.lang.Object file)

release

public void release()

addToOpenedAccessFileList

public void addToOpenedAccessFileList(MemberAccessFile file)

removeFromOpenedAccessFileList

public void removeFromOpenedAccessFileList(MemberAccessFile file)

getServerVersion

public Version getServerVersion()

return the server version that this outline is opened from

Returns:

getServerOPGVersion

public int getServerOPGVersion()

Return the OPG version based on the server version

Returns:

setOPGVersion

public void setOPGVersion(int version)

Parameters:

version -

getOPGVersion

public int getOPGVersion()

Returns:

isOPGVersion71

public boolean isOPGVersion71()

Returns:

isOPGVersion72

public boolean isOPGVersion72()

Returns:

isOPGVersionAfter72

public boolean isOPGVersionAfter72()

Returns:

isOPGVersion930

public boolean isOPGVersion930()

Returns true if the outline belongs to Beckett version(9.3.0)

isOPGVersion1112orLater

public boolean isOPGVersion1112orLater()

isOPGVersion950OrLater

public boolean isOPGVersion950OrLater()

isOPGVersionBefore950

public boolean isOPGVersionBefore950()

isOPGVersion93OrLater

public boolean isOPGVersion93OrLater()

isOPGVersion900

public boolean isOPGVersion900()

getOPGCurrentVersion

public int getOPGCurrentVersion()

isMigrationNeeded

public boolean isMigrationNeeded(boolean saveToFileSystem)

Is OPG Version migration needed?

Parameters:

isFileSystemTarget - true if saving to file system and ignore current representation setting

Returns:

true if outline must be versioned to current

doesServerVersionSupportNonUnique

public boolean doesServerVersionSupportNonUnique()

doesServerVersionSupportQueryHints

public boolean doesServerVersionSupportQueryHints()

doesServerVersionSupportSmartlist

public boolean doesServerVersionSupportSmartlist()

isOutlineEmpty

public boolean isOutlineEmpty()

setOutlineEmpty

public void setOutlineEmpty(boolean value)

hasQueryOpenError

public boolean hasQueryOpenError()

setQueryOpenError

public void setQueryOpenError(boolean value)

getSmartListDefinitions

public java.util.ArrayList getSmartListDefinitions()

addSLODefinition

public void addSLODefinition(SLODefinition sloDefn)

removeSLODefinition

public void removeSLODefinition(SLODefinition sloDefn)

isASO

public boolean isASO()

getMaxAliasTableSize

public int getMaxAliasTableSize()