repicea.io.tools

Class ImportFieldElement

java.lang.Object

repicea.io.tools.ImportFieldElement

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, REpiceaUIObject

public final class ImportFieldElement
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, REpiceaUIObject

This class contains the field details for the importation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportFieldElement.FieldType

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
protected java.lang.Enum<?>	fieldID
ImportFieldElement.FieldType	fieldTypeClass
java.lang.String	helpDescription
boolean	isOptional
java.lang.String	propertyName

Constructor Summary

Constructors

Constructor and Description
ImportFieldElement(LevelProviderEnum fieldID, int fieldIndex, ImportFieldElement.FieldType fieldTypeClass) Short constructor for JUnit test
ImportFieldElement(LevelProviderEnum fieldID, java.lang.String description, java.lang.String propertyName, boolean isOptional, java.lang.String helpDescription, ImportFieldElement.FieldType fieldType) General constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Enum	getFieldID() This method returns the Enum variable who serves as ID for the field.
java.lang.String	getFieldName()
ImportFieldElement.FieldType	getFieldType() This method returns the type of field which can be a String, a Double or an Integer.
int	getMatchingFieldIndex()
repicea.io.tools.ImportFieldElementPanel	getUI() This method returns the GUI interface of the class that implements this interface.
boolean	isVisible() This method returns true if the GUI is visible.
void	setFieldMatch(FormatField formatField) This method sets the name and the match index of the ImportFieldElement instance.

Methods inherited from class java.lang.Object

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

Field Detail

description

public java.lang.String description

propertyName

public java.lang.String propertyName

isOptional

public boolean isOptional

helpDescription

public java.lang.String helpDescription

fieldTypeClass

public ImportFieldElement.FieldType fieldTypeClass

fieldID

protected java.lang.Enum<?> fieldID

Constructor Detail

ImportFieldElement

public ImportFieldElement(LevelProviderEnum fieldID,
                          java.lang.String description,
                          java.lang.String propertyName,
                          boolean isOptional,
                          java.lang.String helpDescription,
                          ImportFieldElement.FieldType fieldType)

General constructor

Parameters:

fieldID - the field id enum variable which implements the LevelProviderEnum

description - a String that describes the field

propertyName - the property name for saving

isOptional - a boolean that specifies whether the field is optional

helpDescription - a String that helps the user (may appear in a popup window

fieldType - an FieldType enum

ImportFieldElement

public ImportFieldElement(LevelProviderEnum fieldID,
                          int fieldIndex,
                          ImportFieldElement.FieldType fieldTypeClass)

Short constructor for JUnit test

Parameters:

fieldID - the field id enum variable

fieldIndex - the matching field index in the dbf file

fieldTypeClass - an FieldType enum

Method Detail

setFieldMatch

public void setFieldMatch(FormatField formatField)

This method sets the name and the match index of the ImportFieldElement instance.

Parameters:

formatField - a FormatField instance

getUI

public repicea.io.tools.ImportFieldElementPanel getUI()

Description copied from interface: REpiceaUIObject

This method returns the GUI interface of the class that implements this interface.

Specified by:

getUI in interface REpiceaUIObject

Returns:

a Component instance

getFieldName

public java.lang.String getFieldName()

getMatchingFieldIndex

public int getMatchingFieldIndex()

getFieldID

public java.lang.Enum getFieldID()

This method returns the Enum variable who serves as ID for the field.

Returns:

an Enum variable instance

getFieldType

public ImportFieldElement.FieldType getFieldType()

This method returns the type of field which can be a String, a Double or an Integer.

Returns:

a FieldType enum variable

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObject

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObject

Returns:

a boolean