Package org.eclipse.epsilon.emc.spreadsheets

Class SpreadsheetReference

java.lang.Object

org.eclipse.epsilon.emc.spreadsheets.SpreadsheetReference

public class SpreadsheetReference
extends java.lang.Object

This class represents a reference between two worksheets and two columns. Reference has multiplicity one-to-one or one-to-many meaning that either the first referenced row is relevant or all of them. This is most important when reading spreadsheet data. Reference may also cascade updates - this means that any changes to the referenced cell would be cascaded to all referencing rows.

Author:

Martins Francis

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cascadingUpdates
protected boolean	many
protected SpreadsheetModel	model
protected SpreadsheetColumn	referencedColumn
protected SpreadsheetWorksheet	referencedWorksheet
protected SpreadsheetColumn	referencingColumn
protected SpreadsheetWorksheet	referencingWorksheet

Constructor Summary

Constructors

Constructor	Description
SpreadsheetReference(SpreadsheetModel model, ISpreadsheetMetadata.SpreadsheetReferenceMetadata reference)	Constructs an object representing a reference between two worksheets and two columns as specified in the provided reference metadata.

Method Summary

Modifier and Type	Method	Description
SpreadsheetModel	getModel()
SpreadsheetColumn	getReferencedColumn()
SpreadsheetWorksheet	getReferencedWorksheet()
SpreadsheetColumn	getReferencingColumn()
SpreadsheetWorksheet	getReferencingWorksheet()
boolean	isCascadingUpdates()
boolean	isMany()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

model

protected SpreadsheetModel model

referencingWorksheet

protected SpreadsheetWorksheet referencingWorksheet

referencedWorksheet

protected SpreadsheetWorksheet referencedWorksheet

referencingColumn

protected SpreadsheetColumn referencingColumn

referencedColumn

protected SpreadsheetColumn referencedColumn

many

protected boolean many

cascadingUpdates

protected boolean cascadingUpdates

Constructor Detail

SpreadsheetReference

public SpreadsheetReference(SpreadsheetModel model,
                            ISpreadsheetMetadata.SpreadsheetReferenceMetadata reference)

Constructs an object representing a reference between two worksheets and two columns as specified in the provided reference metadata.

Parameters:

model -

reference -

Method Detail

getModel

public SpreadsheetModel getModel()

getReferencingWorksheet

public SpreadsheetWorksheet getReferencingWorksheet()

getReferencedWorksheet

public SpreadsheetWorksheet getReferencedWorksheet()

getReferencingColumn

public SpreadsheetColumn getReferencingColumn()

getReferencedColumn

public SpreadsheetColumn getReferencedColumn()

isMany

public boolean isMany()

isCascadingUpdates

public boolean isCascadingUpdates()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object