com.edgeti.VisibilityServer.Excel

Class ExcelIngestorBase

java.lang.Object

com.edgeti.VisibilityServer.Excel.ExcelIngestorBase

Direct Known Subclasses:

AsciiIngestor, ExcelIngestor, SolrXMLIngestor

public abstract class ExcelIngestorBase
extends java.lang.Object

The Class ExcelIngestorBase. Returned by the ingestFile method to describe the ingest results.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	illegalChars The illegal chars.
protected org.apache.log4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ExcelIngestorBase() Instantiates a new excel ingestor base.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.ArrayList<java.lang.String>	checkForDups(java.util.ArrayList<Column> columns) check for duplicate column names.
java.lang.String	echo(java.lang.String string) Method for debugging remote object calls.
protected java.lang.String	fixString(java.lang.String str) Replace all "illegal" characters with an underscore "_".
abstract java.util.ArrayList<java.lang.String>	getColumnHeaders(java.lang.String fileName) When given the name of an existing file, returns the columns which exist in the top sheet of that excel file.
abstract IngestResult	ingestFile(java.lang.String tableName, java.lang.String fileName, boolean merge) Ingests the requested columns in to tableName from the provided file.
abstract java.util.ArrayList<Column>	listColumns(java.lang.String fileName) When given the name of an existing file, returns the columns which exist in the top sheet of that excel file.
protected void	trace(java.lang.String message) Debug statement method.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.apache.log4j.Logger logger

illegalChars

protected static java.lang.String[] illegalChars

The illegal chars.

Constructor Detail

ExcelIngestorBase

public ExcelIngestorBase()

Instantiates a new excel ingestor base.

Method Detail

trace

protected void trace(java.lang.String message)

Debug statement method.

Parameters:

message - the message to log and print

echo

public java.lang.String echo(java.lang.String string)

Method for debugging remote object calls. Who wrote this? Were they high?

Parameters:

string - the string to return

Returns:

string - see above

fixString

protected java.lang.String fixString(java.lang.String str)

Replace all "illegal" characters with an underscore "_".

Parameters:

str - the String to 'fix'

Returns:

the string with all {" ", ",", "-", ";", "\'", "\t", "\\."} replaced by "_"

listColumns

public abstract java.util.ArrayList<Column> listColumns(java.lang.String fileName)

When given the name of an existing file, returns the columns which exist in the top sheet of that excel file.

Parameters:

fileName - the file name

Returns:

the array list

getColumnHeaders

public abstract java.util.ArrayList<java.lang.String> getColumnHeaders(java.lang.String fileName)

When given the name of an existing file, returns the columns which exist in the top sheet of that excel file. Same as above, but returning as ArrayList

Parameters:

fileName - the file name

Returns:

the column headers as ArrayList

checkForDups

protected java.util.ArrayList<java.lang.String> checkForDups(java.util.ArrayList<Column> columns)

check for duplicate column names.

Parameters:

columns - the columns

Returns:

true if exists, false otherwise

ingestFile

public abstract IngestResult ingestFile(java.lang.String tableName,
                      java.lang.String fileName,
                      boolean merge)

Ingests the requested columns in to tableName from the provided file. If tableName exists, it will be dropped and recreated.

Parameters:

tableName - the table name

fileName - the file name

merge - flag to merge with existing data in the table (true = merge, false = replace)

Returns:

the ingest result