C# Class Smrf.NodeXL.ExcelTemplate.WorksheetReaderBase

Base class for classes that know how to read an Excel worksheet containing graph data.
There is one derived class for each worksheet in a NodeXL workbook that contains graph data. There are additional derived classes for reading tables contained in the hidden Miscellaneous worksheet.
Inheritance: Smrf.NodeXL.Core.NodeXLBase
Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Public Properties

Property Type Description
EmptyIDArray System.Int32[]

Protected Properties

Property Type Description
m_oAlphaConverter AlphaConverter

Public Methods

Method Description
AssertValid ( ) : void
VertexNameToVertex ( String vertexName, IVertexCollection vertices, IVertex>.Dictionary vertexNameDictionary ) : IVertex
WorksheetReaderBase ( ) : System

Initializes a new instance of the WorksheetReaderBase class.

Protected Methods

Method Description
CreateVertex ( String sVertexName, IVertexCollection oVertices, IVertex>.Dictionary oVertexNameDictionary ) : IVertex
FillIDColumn ( ListObject oTable ) : void
FilterColumnNames ( ExcelTableReader oExcelTableReader, HashSet oColumnNamesToExclude ) : String[]
GetTableColumnIndex ( ListObject oTable, String sColumnName, System.Boolean bColumnIsRequired ) : Int32
HideVertex ( IVertex oVertex ) : void
OnInvalidVisibility ( ExcelTableReader oRow ) : void
OnWorkbookFormatError ( String sMessage ) : void
OnWorkbookFormatError ( String sMessage, Range oRangeToSelect ) : void
OnWorkbookFormatErrorWithDropDown ( ExcelTableReader oRow, String sColumnName, String sInvalidCellDescription ) : void
ReadAllColumns ( ExcelTableReader oExcelTableReader, ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex, HashSet oColumnNamesToExclude ) : void
ReadAlpha ( ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex ) : System.Boolean
ReadCellAndSetMetadata ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sKeyName ) : System.Boolean
ReadColor ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sColorKey, ColorConverter2 oColorConverter2 ) : void
RemoveVertex ( IVertex oVertex, ReadWorkbookContext oReadWorkbookContext, IGraph oGraph ) : void
TryGetBoolean ( ExcelTableReader oRow, String sColumnName, BooleanConverter oBooleanConverter, System.Boolean &bBoolean ) : System.Boolean
TryGetColor ( ExcelTableReader oRow, String sColumnName, ColorConverter2 oColorConverter2, Color &oColor ) : System.Boolean
TryGetLocation ( ExcelTableReader oRow, String sXColumnName, String sYColumnName, VertexLocationConverter oVertexLocationConverter, PointF &oLocation ) : System.Boolean
TryGetVertexShape ( ExcelTableReader oRow, String sColumnName, VertexShape &eShape ) : System.Boolean

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

CreateVertex() protected static method

protected static CreateVertex ( String sVertexName, IVertexCollection oVertices, IVertex>.Dictionary oVertexNameDictionary ) : IVertex
sVertexName String
oVertices IVertexCollection
oVertexNameDictionary IVertex>.Dictionary
return IVertex

FillIDColumn() protected method

protected FillIDColumn ( ListObject oTable ) : void
oTable ListObject
return void

FilterColumnNames() protected method

protected FilterColumnNames ( ExcelTableReader oExcelTableReader, HashSet oColumnNamesToExclude ) : String[]
oExcelTableReader Smrf.AppLib.ExcelTableReader
oColumnNamesToExclude HashSet
return String[]

GetTableColumnIndex() protected method

protected GetTableColumnIndex ( ListObject oTable, String sColumnName, System.Boolean bColumnIsRequired ) : Int32
oTable ListObject
sColumnName String
bColumnIsRequired System.Boolean
return System.Int32

HideVertex() protected method

protected HideVertex ( IVertex oVertex ) : void
oVertex IVertex
return void

OnInvalidVisibility() protected method

protected OnInvalidVisibility ( ExcelTableReader oRow ) : void
oRow Smrf.AppLib.ExcelTableReader
return void

OnWorkbookFormatError() protected method

protected OnWorkbookFormatError ( String sMessage ) : void
sMessage String
return void

OnWorkbookFormatError() protected method

protected OnWorkbookFormatError ( String sMessage, Range oRangeToSelect ) : void
sMessage String
oRangeToSelect Range
return void

OnWorkbookFormatErrorWithDropDown() protected method

protected OnWorkbookFormatErrorWithDropDown ( ExcelTableReader oRow, String sColumnName, String sInvalidCellDescription ) : void
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
sInvalidCellDescription String
return void

ReadAllColumns() protected method

protected ReadAllColumns ( ExcelTableReader oExcelTableReader, ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex, HashSet oColumnNamesToExclude ) : void
oExcelTableReader Smrf.AppLib.ExcelTableReader
oRow Smrf.AppLib.ExcelTableReader
oEdgeOrVertex IMetadataProvider
oColumnNamesToExclude HashSet
return void

ReadAlpha() protected method

protected ReadAlpha ( ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
oEdgeOrVertex IMetadataProvider
return System.Boolean

ReadCellAndSetMetadata() protected method

protected ReadCellAndSetMetadata ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sKeyName ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oEdgeOrVertex IMetadataProvider
sKeyName String
return System.Boolean

ReadColor() protected method

protected ReadColor ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sColorKey, ColorConverter2 oColorConverter2 ) : void
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oEdgeOrVertex IMetadataProvider
sColorKey String
oColorConverter2 ColorConverter2
return void

RemoveVertex() protected method

protected RemoveVertex ( IVertex oVertex, ReadWorkbookContext oReadWorkbookContext, IGraph oGraph ) : void
oVertex IVertex
oReadWorkbookContext ReadWorkbookContext
oGraph IGraph
return void

TryGetBoolean() protected method

protected TryGetBoolean ( ExcelTableReader oRow, String sColumnName, BooleanConverter oBooleanConverter, System.Boolean &bBoolean ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oBooleanConverter BooleanConverter
bBoolean System.Boolean
return System.Boolean

TryGetColor() protected method

protected TryGetColor ( ExcelTableReader oRow, String sColumnName, ColorConverter2 oColorConverter2, Color &oColor ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oColorConverter2 ColorConverter2
oColor Color
return System.Boolean

TryGetLocation() protected method

protected TryGetLocation ( ExcelTableReader oRow, String sXColumnName, String sYColumnName, VertexLocationConverter oVertexLocationConverter, PointF &oLocation ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sXColumnName String
sYColumnName String
oVertexLocationConverter VertexLocationConverter
oLocation System.Drawing.PointF
return System.Boolean

TryGetVertexShape() protected method

protected TryGetVertexShape ( ExcelTableReader oRow, String sColumnName, VertexShape &eShape ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
eShape VertexShape
return System.Boolean

VertexNameToVertex() public static method

public static VertexNameToVertex ( String vertexName, IVertexCollection vertices, IVertex>.Dictionary vertexNameDictionary ) : IVertex
vertexName String
vertices IVertexCollection
vertexNameDictionary IVertex>.Dictionary
return IVertex

WorksheetReaderBase() public method

Initializes a new instance of the WorksheetReaderBase class.
public WorksheetReaderBase ( ) : System
return System

Property Details

EmptyIDArray public static property

public static Int32[],System EmptyIDArray
return System.Int32[]

m_oAlphaConverter protected property

protected AlphaConverter,Smrf.NodeXL.ExcelTemplate m_oAlphaConverter
return AlphaConverter