Package org.eclipse.epsilon.emc.spreadsheets.excel

Class ExcelModel

java.lang.Object

org.eclipse.epsilon.eol.models.Model

org.eclipse.epsilon.emc.spreadsheets.SpreadsheetModel

org.eclipse.epsilon.emc.spreadsheets.excel.ExcelModel

All Implemented Interfaces:

java.lang.AutoCloseable, IModel, ISearchableModel

Direct Known Subclasses:

SecureExcelModel

public class ExcelModel
extends SpreadsheetModel

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIGURATION_FILE
static java.lang.String	SPREADSHEET_FILE
static java.lang.String	SPREADSHEET_PASSWORD
protected org.apache.poi.ss.usermodel.Workbook	workbook

Fields inherited from class org.eclipse.epsilon.emc.spreadsheets.SpreadsheetModel

isLoaded, references, 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
ExcelModel()

Method Summary

Modifier and Type	Method	Description
protected ExcelWorksheet	createWorksheet(ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)	The purpose of this method is to create a worksheet.
void	deleteWorksheet(SpreadsheetWorksheet worksheet)	The purpose of this method is to delete the given worksheet from this spreadsheet
java.util.Collection<SpreadsheetRow>	find(Variable iterator, ModuleElement ast, IEolContext context)
protected ISpreadsheetMetadata	getSpreadsheetMetadata()	The purpose of this method is to return an instance of the ISpreadsheetMetadata implementation for retrieving metadata for this spreadsheet model
protected boolean	isMetadataConfigurationDefined()
void	load(StringProperties properties, IRelativePathResolver resolver)
protected void	loadSpreadsheet()	The purpose of this method is to load the spreadsheet.
static void	main(java.lang.String[] args)
void	setConfigurationFile(java.lang.String configurationFilePath)
void	setPassword(java.lang.String password)
void	setSpreadsheetFile(java.lang.String pathToSpreadsheet)
boolean	store()
boolean	store(java.lang.String location)

Methods inherited from class org.eclipse.epsilon.emc.spreadsheets.SpreadsheetModel

addReference, addWorksheet, allContents, createInstance, createInstance, createInstance, deleteElement, dispose, findOne, getAllOfKind, getAllOfType, getElementById, getElementId, getEnumerationValue, getPropertySetter, getReferences, getReferencesBySource, getReferencesBySource, getReferencesByTarget, getReferencesByTarget, getTypeNameOf, getTypeOf, getWorksheetByType, getWorksheets, hasType, isInstantiable, isLoaded, load, loadColumnsFromMetadata, loadConfigurationFile, loadReferenceFromConfigurationFile, loadWorksheetFromConfigurationFile, owns, setElementId

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, 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

SPREADSHEET_FILE

public static final java.lang.String SPREADSHEET_FILE

See Also:

Constant Field Values

CONFIGURATION_FILE

public static final java.lang.String CONFIGURATION_FILE

See Also:

Constant Field Values

SPREADSHEET_PASSWORD

public static final java.lang.String SPREADSHEET_PASSWORD

See Also:

Constant Field Values

workbook

protected org.apache.poi.ss.usermodel.Workbook workbook

Constructor Detail

ExcelModel

public ExcelModel()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

setSpreadsheetFile

public void setSpreadsheetFile(java.lang.String pathToSpreadsheet)

setConfigurationFile

public void setConfigurationFile(java.lang.String configurationFilePath)
                          throws javax.xml.parsers.ParserConfigurationException,
                                 org.xml.sax.SAXException,
                                 java.io.IOException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

setPassword

public void setPassword(java.lang.String password)

load

public void load(StringProperties properties,
                 IRelativePathResolver resolver)
          throws EolModelLoadingException

Specified by:

load in interface IModel

Overrides:

load in class Model

Throws:

EolModelLoadingException

loadSpreadsheet

protected void loadSpreadsheet()
                        throws java.lang.Exception

Description copied from class: SpreadsheetModel

The purpose of this method is to load the spreadsheet.

Specified by:

loadSpreadsheet in class SpreadsheetModel

Throws:

java.lang.Exception

getSpreadsheetMetadata

protected ISpreadsheetMetadata getSpreadsheetMetadata()

Description copied from class: SpreadsheetModel

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

Specified by:

getSpreadsheetMetadata in class SpreadsheetModel

isMetadataConfigurationDefined

protected boolean isMetadataConfigurationDefined()

Specified by:

isMetadataConfigurationDefined in class SpreadsheetModel

Returns:

true if metadata has been provided, false otherwise

createWorksheet

protected ExcelWorksheet createWorksheet(ISpreadsheetMetadata.SpreadsheetWorksheetMetadata worksheetMetadata)

Description copied from class: SpreadsheetModel

The purpose of this method is to create a worksheet.

Specified by:

createWorksheet in class SpreadsheetModel

Returns:

newly created worksheet

store

public boolean store(java.lang.String location)

Specified by:

store in interface IModel

Overrides:

store in class SpreadsheetModel

store

public boolean store()

Specified by:

store in interface IModel

Overrides:

store in class SpreadsheetModel

deleteWorksheet

public void deleteWorksheet(SpreadsheetWorksheet worksheet)

Description copied from class: SpreadsheetModel

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

Specified by:

deleteWorksheet in class SpreadsheetModel

find

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

Specified by:

find in interface ISearchableModel

Specified by:

find in class SpreadsheetModel

Throws:

EolRuntimeException