Top Description Inners Fields Constructors Methods

org.apache.poi.ss.formula

public final Class CollaboratingWorkbooksEnvironment

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment

Annotations

@Internal

Imports

java.util.Collections, .HashMap, .HashSet, .IdentityHashMap, .Iterator, .Map, .Set, org.apache.poi.ss.usermodel.FormulaEvaluator, org.apache.poi.util.Internal

Manages a collection of WorkbookEvaluators, in order to support evaluation of formulas across spreadsheets.

For POI internal use only - use

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	CollaboratingWorkbooksEnvironment.WorkbookNotFoundException

Field Summary

Modifier and Type	Field and Description
private final WorkbookEvaluator[]	_evaluators
private final Map<String, WorkbookEvaluator>	_evaluatorsByName
private boolean	_unhooked
public static final CollaboratingWorkbooksEnvironment	EMPTY

Constructor Summary

Access	Constructor and Description
private	CollaboratingWorkbooksEnvironment()
private	CollaboratingWorkbooksEnvironment(String[] workbookNames, WorkbookEvaluator[] evaluators, int nItems)
private	CollaboratingWorkbooksEnvironment(Map<String, WorkbookEvaluator> evaluatorsByName, WorkbookEvaluator[] evaluators)

Method Summary

Modifier and Type	Method and Description
public WorkbookEvaluator	getWorkbookEvaluator(String workbookName)
private static void	hookNewEnvironment(WorkbookEvaluator[] evaluators, CollaboratingWorkbooksEnvironment env)
public static void	setup(String[] workbookNames, WorkbookEvaluator[] evaluators)
public static void	setup(Map<String, WorkbookEvaluator> evaluatorsByName)
public static void	setupFormulaEvaluator(Map<String, FormulaEvaluator> evaluators)
private static Map<String, WorkbookEvaluator>	toUniqueMap(String[] workbookNames, WorkbookEvaluator[] evaluators, int nItems)
private void	unhook() Tell all contained evaluators that this environment should be discarded
private void	unhookOldEnvironments(WorkbookEvaluator[] evaluators) Completely dismantles all workbook environments that the supplied evaluators are part of

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_evaluators	back to summary
private final WorkbookEvaluator[] _evaluators

_evaluatorsByName	back to summary
private final Map<String, WorkbookEvaluator> _evaluatorsByName

_unhooked	back to summary
private boolean _unhooked

EMPTY	back to summary
public static final CollaboratingWorkbooksEnvironment EMPTY

Constructor Detail

CollaboratingWorkbooksEnvironment	back to summary
private CollaboratingWorkbooksEnvironment()

CollaboratingWorkbooksEnvironment	back to summary
private CollaboratingWorkbooksEnvironment(String[] workbookNames, WorkbookEvaluator[] evaluators, int nItems)

CollaboratingWorkbooksEnvironment	back to summary
private CollaboratingWorkbooksEnvironment(Map<String, WorkbookEvaluator> evaluatorsByName, WorkbookEvaluator[] evaluators)

Method Detail

getWorkbookEvaluator	back to summary
public WorkbookEvaluator getWorkbookEvaluator(String workbookName) throws WorkbookNotFoundException

hookNewEnvironment	back to summary
private static void hookNewEnvironment(WorkbookEvaluator[] evaluators, CollaboratingWorkbooksEnvironment env)

setup	back to summary
public static void setup(String[] workbookNames, WorkbookEvaluator[] evaluators)

setup	back to summary
public static void setup(Map<String, WorkbookEvaluator> evaluatorsByName)

setupFormulaEvaluator	back to summary
public static void setupFormulaEvaluator(Map<String, FormulaEvaluator> evaluators)

toUniqueMap	back to summary
private static Map<String, WorkbookEvaluator> toUniqueMap(String[] workbookNames, WorkbookEvaluator[] evaluators, int nItems)

unhook	back to summary
private void unhook() Tell all contained evaluators that this environment should be discarded

unhookOldEnvironments	back to summary
private void unhookOldEnvironments(WorkbookEvaluator[] evaluators) Completely dismantles all workbook environments that the supplied evaluators are part of

org.apache.poi.ss.formula back to summary

public final Class CollaboratingWorkbooksEnvironment.WorkbookNotFoundException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	WorkbookNotFoundException(String msg)

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

WorkbookNotFoundException	back to summary
pack-priv WorkbookNotFoundException(String msg)