Class SpreadsheetWorksheetHeader
- java.lang.Object
-
- org.eclipse.epsilon.emc.spreadsheets.SpreadsheetWorksheetHeader
-
public class SpreadsheetWorksheetHeader extends Object
This class represents a worksheet header and consists of a number of ordered columns. The ordering of columns is enforced bySpreadsheetColumnComparator
.- Author:
- Martins Francis
-
-
Constructor Summary
Constructors Constructor Description SpreadsheetWorksheetHeader(SpreadsheetWorksheet worksheet)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addColumn(SpreadsheetColumn column)
Adds the given column to the header.boolean
contains(SpreadsheetColumn column)
This method returns true if the given columns is part of the worksheet's header.SpreadsheetColumn
getColumn(String identifier)
This method returns the first header column identifiable by the given identifier.SortedSet<SpreadsheetColumn>
getColumns()
This method provides the columns that make up the header of the worksheet.SpreadsheetWorksheet
getWorksheet()
This method returns the worksheet this header is for.String
toString()
-
-
-
Constructor Detail
-
SpreadsheetWorksheetHeader
public SpreadsheetWorksheetHeader(SpreadsheetWorksheet worksheet)
-
-
Method Detail
-
getWorksheet
public SpreadsheetWorksheet getWorksheet()
This method returns the worksheet this header is for.- Returns:
- worksheet
-
addColumn
public void addColumn(SpreadsheetColumn column)
Adds the given column to the header.- Parameters:
column
-
-
getColumn
public SpreadsheetColumn getColumn(String identifier)
This method returns the first header column identifiable by the given identifier. If there is no such column then null is returned instead.- Parameters:
identifier
-- Returns:
- header column or null
-
getColumns
public SortedSet<SpreadsheetColumn> getColumns()
This method provides the columns that make up the header of the worksheet.- Returns:
- header columns
-
contains
public boolean contains(SpreadsheetColumn column)
This method returns true if the given columns is part of the worksheet's header.- Parameters:
column
-- Returns:
- true if column is part of the header, false otherwise
-
-