Package org.eclipse.epsilon.emc.spreadsheets

Class SpreadsheetModel

java.lang.Object

org.eclipse.epsilon.eol.models.Model

org.eclipse.epsilon.emc.spreadsheets.SpreadsheetModel

All Implemented Interfaces:

AutoCloseable, IModel, ISearchableModel

Direct Known Subclasses:

ConcreteModel, ExcelModel, GSModel

public abstract class SpreadsheetModel
extends Model
implements ISearchableModel

This class enables spreadsheets to be viewed as models in Epsilon.

Author:

Martins Francis

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isLoaded
protected List<SpreadsheetReference>	references
protected List<SpreadsheetWorksheet>	worksheets

Fields inherited from class org.eclipse.epsilon.eol.models.Model

aliases, ENV_PREFIX, name, PROPERTY_ALIASES, PROPERTY_NAME, PROPERTY_READONLOAD, PROPERTY_READONLY, PROPERTY_STOREONDISPOSAL, propertyGetter, propertySetter, readOnLoad, storeOnDisposal

Constructor Summary

Constructors

Constructor	Description
SpreadsheetModel()

Method Summary

Modifier and Type	Method	Description
void	addReference(SpreadsheetReference reference)	Associate the given reference with this spreadsheet.
void	addWorksheet(SpreadsheetWorksheet worksheet)	The purpose of this method is to associate the given worksheet with this spreadsheet.
List<SpreadsheetRow>	allContents()	This method returns all rows of all worksheets.
Object	createInstance(String type)	This method creates a blank row in the worksheet identifiable by type.
Object	createInstance(String type, Collection<Object> parameters)	This method creates a new row in the worksheet identifiable by type.
Object	createInstance(String type, Map<String,Object> parameters)	This method creates a new row in the worksheet identifiable by type.
protected abstract SpreadsheetWorksheet	createWorksheet(ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)	The purpose of this method is to create a worksheet.
void	deleteElement(Object instance)	This method deletes the given instance (row) from the worksheet it belongs to.
protected abstract void	deleteWorksheet(SpreadsheetWorksheet worksheet)	The purpose of this method is to delete the given worksheet from this spreadsheet
void	dispose()
abstract Collection<SpreadsheetRow>	find(Variable iterator, ModuleElement ast, IEolContext context)
Object	findOne(Variable iterator, ModuleElement ast, IEolContext context)
Collection<SpreadsheetRow>	getAllOfKind(String type)
List<SpreadsheetRow>	getAllOfType(String type)	Returns every row contained by the worksheet identifiable by the given type.
Object	getElementById(String id)
String	getElementId(Object instance)
Object	getEnumerationValue(String enumeration, String label)
IPropertySetter	getPropertySetter()
List<SpreadsheetReference>	getReferences()
Set<SpreadsheetReference>	getReferencesBySource(SpreadsheetWorksheet worksheet)	The purpose of this method is to find all references where the given worksheet is a source i.e.
Set<SpreadsheetReference>	getReferencesBySource(SpreadsheetWorksheet worksheet, SpreadsheetColumn column)	The purpose of this method is to find all references where the given worksheet and column is a source i.e.
Set<SpreadsheetReference>	getReferencesByTarget(SpreadsheetWorksheet worksheet)	The purpose of this method is to find all references where the given worksheet is a target i.e.
Set<SpreadsheetReference>	getReferencesByTarget(SpreadsheetWorksheet worksheet, SpreadsheetColumn column)	The purpose of this method is to find all references where the given worksheet and column is a target i.e.
protected abstract ISpreadsheetMetadata	getSpreadsheetMetadata()	The purpose of this method is to return an instance of the ISpreadsheetMetadata implementation for retrieving metadata for this spreadsheet model
String	getTypeNameOf(Object instance)	This method returns the name of the worksheet that the instance (row) belongs to.
SpreadsheetWorksheet	getTypeOf(Object instance)	This method returns the worksheet that the given instance (row) belongs to.
SpreadsheetWorksheet	getWorksheetByType(String type)	This method returns the first worksheet of the given type as determined by SpreadsheetWorksheet.isIdentifiablyBy(String) method.
List<SpreadsheetWorksheet>	getWorksheets()
boolean	hasType(String type)
boolean	isInstantiable(String type)
boolean	isLoaded()
protected abstract boolean	isMetadataConfigurationDefined()
void	load()
protected void	loadColumnsFromMetadata(ISpreadsheetMetadata metadata, SpreadsheetWorksheet worksheet)
protected void	loadConfigurationFile()	The purpose of this method is to load the configuration file
protected void	loadReferenceFromConfigurationFile(ISpreadsheetMetadata.SpreadsheetReferenceMetadata referenceMetadata)
protected abstract void	loadSpreadsheet()	The purpose of this method is to load the spreadsheet.
protected void	loadWorksheetFromConfigurationFile(ISpreadsheetMetadata metadata, ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)
boolean	owns(Object instance)	Used to test whether an object is contained in this model.
void	setElementId(Object instance, String newId)
boolean	store()
boolean	store(String location)

Methods inherited from class org.eclipse.epsilon.eol.models.Model

allInstances, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, getPropertyGetter, getTransactionSupport, isModelElement, isOfKind, isOfType, isPropertySet, isReadOnLoad, isStoredOnDisposal, knowsAboutProperty, load, load, load, setName, setReadOnLoad, setStoredOnDisposal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.epsilon.eol.models.IModel

close

Field Detail

worksheets

protected List<SpreadsheetWorksheet> worksheets

references

protected List<SpreadsheetReference> references

isLoaded

protected boolean isLoaded

Constructor Detail

SpreadsheetModel

public SpreadsheetModel()

Method Detail

getPropertySetter

public IPropertySetter getPropertySetter()

Specified by:

getPropertySetter in interface IModel

Overrides:

getPropertySetter in class Model

getWorksheets

public List<SpreadsheetWorksheet> getWorksheets()

addWorksheet

public void addWorksheet(SpreadsheetWorksheet worksheet)

The purpose of this method is to associate the given worksheet with this spreadsheet. Any worksheet that starts with SpreadsheetConstants.WSH_IGNORE_CHARS is ignored.

Parameters:

worksheet -

getReferences

public List<SpreadsheetReference> getReferences()

addReference

public void addReference(SpreadsheetReference reference)

Associate the given reference with this spreadsheet.

Parameters:

reference -

load

public void load()
          throws EolModelLoadingException

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

isLoaded

public boolean isLoaded()

Since:

1.6

dispose

public void dispose()

Specified by:

dispose in interface IModel

Overrides:

dispose in class Model

loadSpreadsheet

protected abstract void loadSpreadsheet()
                                 throws Exception

The purpose of this method is to load the spreadsheet.

Throws:

Exception

getSpreadsheetMetadata

protected abstract ISpreadsheetMetadata getSpreadsheetMetadata()

The purpose of this method is to return an instance of the ISpreadsheetMetadata implementation for retrieving metadata for this spreadsheet model

loadConfigurationFile

protected void loadConfigurationFile()
                              throws Exception

The purpose of this method is to load the configuration file

Throws:

Exception

isMetadataConfigurationDefined

protected abstract boolean isMetadataConfigurationDefined()

Returns:

true if metadata has been provided, false otherwise

loadWorksheetFromConfigurationFile

protected void loadWorksheetFromConfigurationFile(ISpreadsheetMetadata metadata,
                                                  ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)
                                           throws Exception

Throws:

Exception

createWorksheet

protected abstract SpreadsheetWorksheet createWorksheet(ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)
                                                 throws Exception

The purpose of this method is to create a worksheet.

Parameters:

worksheetMetadata -

Returns:

newly created worksheet

Throws:

Exception

loadColumnsFromMetadata

protected void loadColumnsFromMetadata(ISpreadsheetMetadata metadata,
                                       SpreadsheetWorksheet worksheet)

loadReferenceFromConfigurationFile

protected void loadReferenceFromConfigurationFile(ISpreadsheetMetadata.SpreadsheetReferenceMetadata referenceMetadata)

getEnumerationValue

public Object getEnumerationValue(String enumeration,
                                  String label)

Specified by:

getEnumerationValue in interface IModel

allContents

public List<SpreadsheetRow> allContents()

This method returns all rows of all worksheets.

Specified by:

allContents in interface IModel

Returns:

all of the objects contained in this model.

getAllOfType

public List<SpreadsheetRow> getAllOfType(String type)
                                  throws EolModelElementTypeNotFoundException

Returns every row contained by the worksheet identifiable by the given type.

Specified by:

getAllOfType in interface IModel

Throws:

EolModelElementTypeNotFoundException

getAllOfKind

public Collection<SpreadsheetRow> getAllOfKind(String type)
                                        throws EolModelElementTypeNotFoundException

Specified by:

getAllOfKind in interface IModel

Throws:

EolModelElementTypeNotFoundException

getTypeOf

public SpreadsheetWorksheet getTypeOf(Object instance)

This method returns the worksheet that the given instance (row) belongs to. If the instance is not a SpreadsheetRow object then null is returned.

Specified by:

getTypeOf in interface IModel

Overrides:

getTypeOf in class Model

getTypeNameOf

public String getTypeNameOf(Object instance)

This method returns the name of the worksheet that the instance (row) belongs to.

Specified by:

getTypeNameOf in interface IModel

Parameters:

instance - The model object whose type is to be determined.

Returns:

the name of the type of the model object, instance.

createInstance

public Object createInstance(String type)
                      throws EolModelElementTypeNotFoundException

This method creates a blank row in the worksheet identifiable by type. The newly created SpreadsheetRow is returned.

Specified by:

createInstance in interface IModel

Throws:

EolModelElementTypeNotFoundException

createInstance

public Object createInstance(String type,
                             Collection<Object> parameters)
                      throws EolModelElementTypeNotFoundException

This method creates a new row in the worksheet identifiable by type. The given collection is expected to contain one instance of map. Every cell is assigned a value from the map in the order in which the values are returned by the collections framework. If the worksheet does not exist in the spreadsheet then an attempt is made to create it.

Specified by:

createInstance in interface IModel

Overrides:

createInstance in class Model

Throws:

EolModelElementTypeNotFoundException

createInstance

public Object createInstance(String type,
                             Map<String,Object> parameters)
                      throws EolModelElementTypeNotFoundException

This method creates a new row in the worksheet identifiable by type. Every cell is assigned a value from the map in the order in which the values are returned by the collections framework. If the worksheet does not exist in the spreadsheet then an attempt is made to create it.

Parameters:

type -

parameters -

Returns:

newly created SpreadsheetRow

Throws:

EolModelElementTypeNotFoundException - if worksheet cannot be found

getElementById

public Object getElementById(String id)

Specified by:

getElementById in interface IModel

getElementId

public String getElementId(Object instance)

Specified by:

getElementId in interface IModel

setElementId

public void setElementId(Object instance,
                         String newId)

Specified by:

setElementId in interface IModel

deleteElement

public void deleteElement(Object instance)
                   throws EolRuntimeException

This method deletes the given instance (row) from the worksheet it belongs to.

Specified by:

deleteElement in interface IModel

Throws:

EolRuntimeException

owns

public boolean owns(Object instance)

Description copied from interface: IModel

Used to test whether an object is contained in this model.

Specified by:

owns in interface IModel

Parameters:

instance - the Java object to test.

Returns:

true if and only if instance is contained by this model.

hasType

public boolean hasType(String type)

Specified by:

hasType in interface IModel

isInstantiable

public boolean isInstantiable(String type)

Specified by:

isInstantiable in interface IModel

store

public boolean store(String location)

Specified by:

store in interface IModel

store

public boolean store()

Specified by:

store in interface IModel

getWorksheetByType

public SpreadsheetWorksheet getWorksheetByType(String type)

This method returns the first worksheet of the given type as determined by SpreadsheetWorksheet.isIdentifiablyBy(String) method.

Parameters:

type -

Returns:

worksheet identifiable by type or null if none found

getReferencesBySource

public Set<SpreadsheetReference> getReferencesBySource(SpreadsheetWorksheet worksheet)

The purpose of this method is to find all references where the given worksheet is a source i.e. is referencing.

Parameters:

worksheet -

Returns:

Set

getReferencesBySource

public Set<SpreadsheetReference> getReferencesBySource(SpreadsheetWorksheet worksheet,
                                                       SpreadsheetColumn column)

The purpose of this method is to find all references where the given worksheet and column is a source i.e. are referencing.

Parameters:

worksheet -

column -

Returns:

Set

getReferencesByTarget

public Set<SpreadsheetReference> getReferencesByTarget(SpreadsheetWorksheet worksheet)

The purpose of this method is to find all references where the given worksheet is a target i.e. being referenced.

Parameters:

worksheet -

Returns:

Set

getReferencesByTarget

public Set<SpreadsheetReference> getReferencesByTarget(SpreadsheetWorksheet worksheet,
                                                       SpreadsheetColumn column)

The purpose of this method is to find all references where the given worksheet and column is a target i.e. being referenced.

Parameters:

worksheet -

column -

Returns:

Set

findOne

public Object findOne(Variable iterator,
                      ModuleElement ast,
                      IEolContext context)
               throws EolRuntimeException

Specified by:

findOne in interface ISearchableModel

Throws:

EolRuntimeException

find

public abstract Collection<SpreadsheetRow> find(Variable iterator,
                                                ModuleElement ast,
                                                IEolContext context)
                                         throws EolRuntimeException

Specified by:

find in interface ISearchableModel

Throws:

EolRuntimeException

deleteWorksheet

protected abstract void deleteWorksheet(SpreadsheetWorksheet worksheet)

The purpose of this method is to delete the given worksheet from this spreadsheet

Parameters:

worksheet -