eu.wiegandt.nicklas.simpleexcelimexporter

Class ExcelTableManager

java.lang.Object

eu.wiegandt.nicklas.simpleexcelimexporter.ExcelTableManager

public class ExcelTableManager
extends Object

A Class to manage a class which is annotated with ExcelTable.

Author:

Nicklas Wiegandt (Nicklas2751)
Mail: nicklas@wiegandt.eu
Jabber: nicklas2751@elaon.de
Skype: Nicklas2751

Constructor Summary

Constructors

Constructor and Description

ExcelTableManager(Class<? extends DataClass> aExcelTable) A constructor which calls some methods to check if the given class is valid for im-/exporting. Warning: The validation methods will call IllegalStateExceptions if the class is not valid. The class must accomplish the following conditions: The class can't be null. The class must be annotated with ExcelTable If a mapping file is listed it must exist. The listed DataController must be able to handle the class. The class must contain a setter method for every importable field (a field with ExcelField.importable() == true). The class must contain a getter method for every exportable field (a field with ExcelField.exportable() == true). The setter methods must look like this: public void set[FieldName]([Type] ...) The getter methods must look like this: public [Type] get[FieldName]

Method Summary

Modifier and Type	Method and Description
Class<? extends DataController<? extends DataClass>>	getDataController()
Optional<Field>	getExcelField(String aFieldName) Searches for a ExcelField with the given field name.
Collection<Field>	getExcelFields()
Class<? extends DataClass>	getExcelTableClass()
Collection<Field>	getExportableExcelFields()
Collection<Field>	getImportableExcelFields()
Collection<Field>	getImportableRequiredExcelFields()
Path	getMappingFilePath()
String	getTableName() Determines the table name.
boolean	hasImportableField(String aFieldName) Checks if a ExcelField with the given name exists for the dataclass of this manager.
boolean	hasMappingFilePath() Checks if a mapping file path is listed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelTableManager

public ExcelTableManager(Class<? extends DataClass> aExcelTable)

A constructor which calls some methods to check if the given class is valid for im-/exporting.
Warning: The validation methods will call IllegalStateExceptions if the class is not valid.

The class must accomplish the following conditions:

• The class can't be null.
• The class must be annotated with ExcelTable
• If a mapping file is listed it must exist.
• The listed DataController must be able to handle the class.
• The class must contain a setter method for every importable field (a field with ExcelField.importable() == true).
• The class must contain a getter method for every exportable field (a field with ExcelField.exportable() == true).

The setter methods must look like this:
public void set[FieldName]([Type] ...)

The getter methods must look like this:
public [Type] get[FieldName]

Parameters:

aExcelTable - The with ExcelTable annotated class.

Method Detail

getDataController

public Class<? extends DataController<? extends DataClass>> getDataController()

getExcelField

public Optional<Field> getExcelField(String aFieldName)

Searches for a ExcelField with the given field name.

Parameters:

aFieldName - The field name.

Returns:

A Optional with the search result.

getExcelFields

public Collection<Field> getExcelFields()

getExcelTableClass

public Class<? extends DataClass> getExcelTableClass()

getExportableExcelFields

public Collection<Field> getExportableExcelFields()

getImportableExcelFields

public Collection<Field> getImportableExcelFields()

getImportableRequiredExcelFields

public Collection<Field> getImportableRequiredExcelFields()

getMappingFilePath

public Path getMappingFilePath()

getTableName

public String getTableName()

Determines the table name. Uses the data class name as table name if the optional annotation parameter ExcelTable.tableName() is not set.

Returns:

The determined table name.

hasImportableField

public boolean hasImportableField(String aFieldName)

Checks if a ExcelField with the given name exists for the dataclass of this manager.

Parameters:

aFieldName - The field name.

Returns:

true if it exists.

hasMappingFilePath

public boolean hasMappingFilePath()

Checks if a mapping file path is listed.

Returns:

true if a mapping file path is listed.