repicea.io.tools

Class ImportFieldManager

java.lang.Object

repicea.io.tools.ImportFieldManager

All Implemented Interfaces:

java.io.Serializable, REpiceaShowableUIWithParent, REpiceaUIObjectWithParent, IOUserInterfaceableObject, Loadable, Saveable

public class ImportFieldManager
extends java.lang.Object
implements java.io.Serializable, IOUserInterfaceableObject, REpiceaShowableUIWithParent

This class manages a list of ImportFieldElement.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImportFieldManager(java.util.List<ImportFieldElement> vector, java.lang.String... fileSpec) General constructor.

Method Summary

Modifier and Type	Method and Description
protected ImportFieldElement	checkFields()
static ImportFieldManager	createImportFieldManager(java.lang.String ifeFilename, java.lang.String... fileSpec) This method returns an ImportFieldManager loaded from the filename parameter.
ImportFieldElement	getField(java.lang.Enum fieldID) This method returns the ImportFieldElement object corresponding to the FieldID parameter.
java.util.List<ImportFieldElement>	getFields() This method provides the vector of ImportFieldElement objects.
javax.swing.filechooser.FileFilter	getFileFilter() This method returns the appropriate FileFilter instance for this class.
java.lang.String	getFilename() This method returns the filename of the parameters.
java.lang.String[]	getFileSpecifications() The file specification is an array of strings that first contains the filename.
protected java.util.Vector<FormatField>	getFormatFields()
int	getIndexOfThisField(java.lang.Enum fieldID) This method returns the index of the field within the vector of ImportFieldElement objects
protected java.lang.Enum	getStratumFieldEnum()
ImportFieldManagerDialog	getUI(java.awt.Container parent) This method returns the GUI interface of the class that implements this interface.
protected boolean	isPopupInGuiInterfaceEnabled()
protected boolean	isUserValidated()
boolean	isVisible() This method returns true if the GUI is visible.
void	load(java.lang.String filename) This method makes it possible to load information from a file.
void	save(java.lang.String filename) This method saves the records in a file denominated by the filename parameter.
protected void	saveDefaultValues() This method saves the values of the properties.
void	setFileSpecifications(java.lang.String... fileSpec) This method sets the name of the DBF file and reads the fields of this file
void	setImportElementIndex() This method sets the index of the fields.
void	setPopupInGuiInterfaceEnabled(boolean popupInGuiInterfaceEnabled)
protected void	setStratumFieldEnum(java.lang.Enum<?> stratumFieldEnum)
protected void	setUserValidated(boolean userValidated)
void	showUI(java.awt.Window parent) This method shows the GUI interface of the class that implements this interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportFieldManager

public ImportFieldManager(java.util.List<ImportFieldElement> vector,
                          java.lang.String... fileSpec)
                   throws java.lang.Exception

General constructor.

Parameters:

vector - a vector defining the fields requested (i.e. ImportFieldElement instances)

fileSpec - the filename of the file to be read and the other specifications such as the table for instance

Throws:

java.lang.Exception

Method Detail

setImportElementIndex

public void setImportElementIndex()

This method sets the index of the fields.

isPopupInGuiInterfaceEnabled

protected boolean isPopupInGuiInterfaceEnabled()

setPopupInGuiInterfaceEnabled

public void setPopupInGuiInterfaceEnabled(boolean popupInGuiInterfaceEnabled)

getFileSpecifications

public java.lang.String[] getFileSpecifications()

The file specification is an array of strings that first contains the filename. With AccessDataBase file, the second String is the table name.

Returns:

an Array of String intances

isUserValidated

protected boolean isUserValidated()

setUserValidated

protected void setUserValidated(boolean userValidated)

checkFields

protected ImportFieldElement checkFields()

setFileSpecifications

public void setFileSpecifications(java.lang.String... fileSpec)
                           throws java.io.IOException

This method sets the name of the DBF file and reads the fields of this file

Parameters:

fileSpec - the DBF file

Throws:

java.lang.Exception

java.io.IOException

getFields

public java.util.List<ImportFieldElement> getFields()

This method provides the vector of ImportFieldElement objects.

getFormatFields

protected java.util.Vector<FormatField> getFormatFields()

getIndexOfThisField

public int getIndexOfThisField(java.lang.Enum fieldID)

This method returns the index of the field within the vector of ImportFieldElement objects

Parameters:

fieldID - = is the id of the field

Returns:

an integer that is index

saveDefaultValues

protected void saveDefaultValues()

This method saves the values of the properties.

getField

public ImportFieldElement getField(java.lang.Enum fieldID)

This method returns the ImportFieldElement object corresponding to the FieldID parameter.

Parameters:

fieldID - a FieldID enum variable

Returns:

the ImportFieldElement instance that corresponds to the FieldID variable

createImportFieldManager

public static ImportFieldManager createImportFieldManager(java.lang.String ifeFilename,
                                                          java.lang.String... fileSpec)
                                                   throws java.io.IOException,
                                                          XmlMarshallException

This method returns an ImportFieldManager loaded from the filename parameter.

Parameters:

ifeFilename - the file that contains the vector of ImportFieldElement

fileSpec - the file to be read and all the required specifications such as the table for instance

Throws:

XmlMarshallException

java.io.FileNotFoundException

java.io.IOException

getUI

public ImportFieldManagerDialog getUI(java.awt.Container parent)

Description copied from interface: REpiceaUIObjectWithParent

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

Specified by:

getUI in interface REpiceaUIObjectWithParent

Parameters:

parent - a parent Container instance (can be null)

Returns:

a Component instance

showUI

public void showUI(java.awt.Window parent)

Description copied from interface: REpiceaShowableUIWithParent

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

Specified by:

showUI in interface REpiceaShowableUIWithParent

Parameters:

parent - the parent Window instance (can be null)

setStratumFieldEnum

protected void setStratumFieldEnum(java.lang.Enum<?> stratumFieldEnum)

getStratumFieldEnum

protected java.lang.Enum getStratumFieldEnum()

save

public void save(java.lang.String filename)
          throws java.io.IOException

Description copied from interface: Saveable

This method saves the records in a file denominated by the filename parameter.

Specified by:

save in interface Saveable

Parameters:

filename - the name of the file

Throws:

java.io.IOException

load

public void load(java.lang.String filename)
          throws java.io.IOException

Description copied from interface: Loadable

This method makes it possible to load information from a file.

Specified by:

load in interface Loadable

Parameters:

filename - the name of the file

Throws:

java.io.IOException - if the file cannot be read

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Description copied from interface: IOUserInterfaceableObject

This method returns the appropriate FileFilter instance for this class.

Specified by:

getFileFilter in interface IOUserInterfaceableObject

Returns:

a FileFilter instance

getFilename

public java.lang.String getFilename()

Description copied from interface: IOUserInterfaceableObject

This method returns the filename of the parameters.

Specified by:

getFilename in interface IOUserInterfaceableObject

Returns:

a String

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObjectWithParent

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObjectWithParent

Returns:

a boolean