Package org.apache.metamodel.excel

Class ExcelConfiguration

java.lang.Object

org.apache.metamodel.util.BaseObject

org.apache.metamodel.excel.ExcelConfiguration

All Implemented Interfaces:

Serializable

public final class ExcelConfiguration
extends org.apache.metamodel.util.BaseObject
implements Serializable

Represents the configuration for reading/parsing Excel spreadsheets.

See Also:

ExcelDataContext, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_COLUMN_NAME_LINE
static int	NO_COLUMN_NAME_LINE

Constructor Summary

Constructors

Constructor	Description
ExcelConfiguration()
ExcelConfiguration(int columnNameLineNumber, boolean skipEmptyLines, boolean skipEmptyColumns)
ExcelConfiguration(int columnNameLineNumber, org.apache.metamodel.schema.naming.ColumnNamingStrategy columnNamingStrategy, boolean skipEmptyLines, boolean skipEmptyColumns)

Method Summary

Modifier and Type	Method	Description
protected void	decorateIdentity(List<Object> identifiers)
int	getColumnNameLineNumber()	The line number (1 based) from which to get the names of the columns.
org.apache.metamodel.schema.naming.ColumnNamingStrategy	getColumnNamingStrategy()	Gets a ColumnNamingStrategy to use if needed.
boolean	isSkipEmptyColumns()	Defines if empty columns in the excel spreadsheet should be skipped while reading the spreadsheet.
boolean	isSkipEmptyLines()	Defines if empty lines in the excel spreadsheet should be skipped while reading the spreadsheet.
String	toString()

Methods inherited from class org.apache.metamodel.util.BaseObject

classEquals, equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_COLUMN_NAME_LINE

public static final int NO_COLUMN_NAME_LINE

See Also:

Constant Field Values

DEFAULT_COLUMN_NAME_LINE

public static final int DEFAULT_COLUMN_NAME_LINE

See Also:

Constant Field Values

Constructor Detail

ExcelConfiguration

public ExcelConfiguration()

ExcelConfiguration

public ExcelConfiguration(int columnNameLineNumber,
                          boolean skipEmptyLines,
                          boolean skipEmptyColumns)

ExcelConfiguration

public ExcelConfiguration(int columnNameLineNumber,
                          org.apache.metamodel.schema.naming.ColumnNamingStrategy columnNamingStrategy,
                          boolean skipEmptyLines,
                          boolean skipEmptyColumns)

Method Detail

getColumnNamingStrategy

public org.apache.metamodel.schema.naming.ColumnNamingStrategy getColumnNamingStrategy()

Gets a ColumnNamingStrategy to use if needed.

Returns:

getColumnNameLineNumber

public int getColumnNameLineNumber()

The line number (1 based) from which to get the names of the columns. Note that this line number is affected by the skipEmptyLines property! If skipEmptyLines is set to true, the line numbers will begin from the first non-empty line.

Returns:

the line number of the column headers/names.

isSkipEmptyLines

public boolean isSkipEmptyLines()

Defines if empty lines in the excel spreadsheet should be skipped while reading the spreadsheet.

Returns:

a boolean indicating whether or not to skip empty lines.

isSkipEmptyColumns

public boolean isSkipEmptyColumns()

Defines if empty columns in the excel spreadsheet should be skipped while reading the spreadsheet.

Returns:

a boolean indicating whether or not to skip empty columns.

decorateIdentity

protected void decorateIdentity(List<Object> identifiers)

Specified by:

decorateIdentity in class org.apache.metamodel.util.BaseObject

toString

public String toString()

Overrides:

toString in class org.apache.metamodel.util.BaseObject