Package com.easy_model.webservice.xlhandler

Class XLInstance

java.lang.Object

com.easy_model.webservice.xlhandler.XLInstance

All Implemented Interfaces:

ScenarioDataProvider

public class XLInstance
extends Object
implements ScenarioDataProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INPUT
static final String	PERCENT
static final int	YTD_PERIOD

Constructor Summary

Constructors

Constructor	Description
XLInstance(Model attachedModel, CalcDocument calcDocument, ModelChangeNotifier modelChangeNotifier)	Connects the XLManager to a new Calc document

Method Summary

Modifier and Type	Method	Description
void	cleanAndUpdateAdditionalSheets()	Removes all sheets apart from the "main" sheet (renamed in the constructor of this class)
void	clearCacheAndReloadAndUpdateClients()
String[]	generateVariableArray(Variable variable)	Generates an array containing the metadata, the historical and projection values, including the variableValues
CalculationData	getContent(SCENARIO scenario)
boolean	isUnusedFor(Duration inactivityThreshold)
void	refreshValue(Variable myVariable, VariableValue myVariableValue)	Use this function to refresh a single variableValue (efficiency optimization)
void	reloadAndUpdateClients()
void	reloadVariableAndUpdateCache(Variable variable)
void	reloadWholeBaseContentIfNoCache()	Use this function to refresh the content Loads the metadata and the variable logic which is replicated for each segment (including "main" segment)
void	runSensitivities(List<Sensitivity> sensitivities, SCENARIO scenario)
InputStream	saveAs()
void	setAttachedModel(Model attachedModel)
void	setSingleValue(VariableValue variableValue)	Loads data from VariableValue and override manually the formula for a single variable value Also applied for historical values
void	sleep()
void	updateCacheValues(SCENARIO scenario)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.easy_model.webservice.xlhandler.ScenarioDataProvider

getSensitivityResults

Field Details

INPUT

public static final String INPUT

See Also:

• Constant Field Values

PERCENT

public static final String PERCENT

See Also:

• Constant Field Values

YTD_PERIOD

public static final int YTD_PERIOD

See Also:

• Constant Field Values

Constructor Details

XLInstance

public XLInstance(Model attachedModel,
 CalcDocument calcDocument,
 ModelChangeNotifier modelChangeNotifier)

Connects the XLManager to a new Calc document

Method Details

saveAs

public InputStream saveAs()

Specified by:

saveAs in interface ScenarioDataProvider

reloadAndUpdateClients

public void reloadAndUpdateClients()

Specified by:

reloadAndUpdateClients in interface ScenarioDataProvider

setSingleValue

public void setSingleValue(VariableValue variableValue)

Loads data from VariableValue and override manually the formula for a single variable value Also applied for historical values

runSensitivities

public void runSensitivities(List<Sensitivity> sensitivities,
 SCENARIO scenario)

Specified by:

runSensitivities in interface ScenarioDataProvider

updateCacheValues

public void updateCacheValues(SCENARIO scenario)

getContent

public CalculationData getContent(SCENARIO scenario)

Specified by:

getContent in interface ScenarioDataProvider

Returns:

the content of the XL file for a certain scenario

generateVariableArray

public String[] generateVariableArray(Variable variable)

Generates an array containing the metadata, the historical and projection values, including the variableValues

Parameters:

variable - the variable to generate array for

Returns:

an array containing all calculates values without variable values

cleanAndUpdateAdditionalSheets

public void cleanAndUpdateAdditionalSheets()

Removes all sheets apart from the "main" sheet (renamed in the constructor of this class)

refreshValue

public void refreshValue(Variable myVariable,
 VariableValue myVariableValue)

Use this function to refresh a single variableValue (efficiency optimization)

Specified by:

refreshValue in interface ScenarioDataProvider

reloadVariableAndUpdateCache

public void reloadVariableAndUpdateCache(Variable variable)

Specified by:

reloadVariableAndUpdateCache in interface ScenarioDataProvider

reloadWholeBaseContentIfNoCache

public void reloadWholeBaseContentIfNoCache()

Use this function to refresh the content Loads the metadata and the variable logic which is replicated for each segment (including "main" segment)

return list of open sheets before reload

setAttachedModel

public void setAttachedModel(Model attachedModel)

isUnusedFor

public boolean isUnusedFor(Duration inactivityThreshold)

Specified by:

isUnusedFor in interface ScenarioDataProvider

sleep

public void sleep()

Specified by:

sleep in interface ScenarioDataProvider

clearCacheAndReloadAndUpdateClients

public void clearCacheAndReloadAndUpdateClients()

Specified by:

clearCacheAndReloadAndUpdateClients in interface ScenarioDataProvider