Package org.teiid.translator.excel

Class ExcelMetadataProcessor

java.lang.Object

org.teiid.translator.excel.ExcelMetadataProcessor

All Implemented Interfaces:

MetadataProcessor<VirtualFileConnection>

public class ExcelMetadataProcessor
extends Object
implements MetadataProcessor<VirtualFileConnection>

Field Summary

Fields

Modifier and Type	Field	Description
static String	CELL_NUMBER
static String	FILE
static String	FIRST_DATA_ROW_NUMBER
static String	ROW_ID

Fields inherited from interface org.teiid.translator.MetadataProcessor

FQN, SOURCE_PREFIX

Constructor Summary

Constructors

Constructor	Description
ExcelMetadataProcessor()

Method Summary

Modifier and Type	Method	Description
int	getDataRowNumber()
String	getExcelFileName()
int	getHeaderRowNumber()
boolean	getIgnoreEmptyHeaderCells()
void	process(MetadataFactory mf, VirtualFileConnection conn)
void	setDataRowNumber(int dataRowNumber)
void	setExcelFileName(String fileName)
void	setHeaderRowNumber(int headerRowNumber)
void	setIgnoreEmptyHeaderCells(boolean ignoreEmpty)

Methods inherited from class java.lang.Object

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

Field Detail

FILE

@ExtensionMetadataProperty(applicable=org.teiid.metadata.Table.class,
                           datatype=java.lang.String.class,
                           display="Excel File Name",
                           description="Excel File name, use file name pattern if one than one file in the parent directory",
                           required=true)
public static final String FILE

See Also:

Constant Field Values

CELL_NUMBER

@ExtensionMetadataProperty(applicable=org.teiid.metadata.Column.class,
                           datatype=java.lang.Integer.class,
                           display="Cell Number",
                           description="Cell number, where the column information is defined. If column name is ROW_ID, define it as -1",
                           required=true)
public static final String CELL_NUMBER

See Also:

Constant Field Values

FIRST_DATA_ROW_NUMBER

@ExtensionMetadataProperty(applicable=org.teiid.metadata.Table.class,
                           datatype=java.lang.Integer.class,
                           display="First Data Number",
                           description="First Row Number, where data rows start")
public static final String FIRST_DATA_ROW_NUMBER

See Also:

Constant Field Values

ROW_ID

public static final String ROW_ID

See Also:

Constant Field Values

Constructor Detail

ExcelMetadataProcessor

public ExcelMetadataProcessor()

Method Detail

process

public void process(MetadataFactory mf,
                    VirtualFileConnection conn)
             throws TranslatorException

Specified by:

process in interface MetadataProcessor<VirtualFileConnection>

Throws:

TranslatorException

setExcelFileName

public void setExcelFileName(String fileName)

getHeaderRowNumber

@TranslatorProperty(display="Header Row Number",
                    category=IMPORT,
                    description="Row number that contains the header information")
public int getHeaderRowNumber()

setHeaderRowNumber

public void setHeaderRowNumber(int headerRowNumber)

getIgnoreEmptyHeaderCells

@TranslatorProperty(display="Ignore Empty Header Cells",
                    category=IMPORT,
                    description="When true any cells with empty value for header row are ignored, otherwise an empty header row cell indicates end of columns.")
public boolean getIgnoreEmptyHeaderCells()

setIgnoreEmptyHeaderCells

public void setIgnoreEmptyHeaderCells(boolean ignoreEmpty)

getDataRowNumber

@TranslatorProperty(display="Data Row Number",
                    category=IMPORT,
                    description="Row number from which data rows start from")
public int getDataRowNumber()

setDataRowNumber

public void setDataRowNumber(int dataRowNumber)

getExcelFileName

@TranslatorProperty(display="Excel File",
                    category=IMPORT,
                    description="Name of the Excel file to read metadata from",
                    required=true)
public String getExcelFileName()