com.jstatcom.io
Enum DataHandlerTypes

java.lang.Object
  extended by java.lang.Enum<DataHandlerTypes>
      extended by com.jstatcom.io.DataHandlerTypes
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DataHandlerTypes>

public enum DataHandlerTypes
extends java.lang.Enum<DataHandlerTypes>

Enumeration of all data handler types.

Author:
Markus Kraetzig

Enum Constant Summary
DAT
          DAT files.
EXCEL
          XLS files.
GAUSS_DAT
          Gauss .dat files.
GAUSS_FMT
          Gauss .fmt files.
MATLAB
          Matlab .m files version 5.
 
Method Summary
abstract  boolean canWriteFormat()
          Gets whether it is possible to write files in the represented type.
abstract  java.lang.String getFileExtension()
          Gets a string with the file extension associated with files that are handled by this, for example "xls" for Excel files, or "mat" for Matlab files.
abstract  javax.swing.filechooser.FileFilter getFileFilter()
          Gets the file filer associated with this type.
abstract  DataHandler getHandler()
          Gets the import handler of this type.
static DataHandlerTypes getTypeFromFileName(java.lang.String fName)
          Gets the handler type from the filename.
static DataHandlerTypes valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DataHandlerTypes[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DAT

public static final DataHandlerTypes DAT
DAT files.


EXCEL

public static final DataHandlerTypes EXCEL
XLS files.


GAUSS_FMT

public static final DataHandlerTypes GAUSS_FMT
Gauss .fmt files.


GAUSS_DAT

public static final DataHandlerTypes GAUSS_DAT
Gauss .dat files.


MATLAB

public static final DataHandlerTypes MATLAB
Matlab .m files version 5.

Method Detail

values

public static DataHandlerTypes[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (DataHandlerTypes c : DataHandlerTypes.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataHandlerTypes valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getHandler

public abstract DataHandler getHandler()
Gets the import handler of this type.

Returns:
handler instance

getFileFilter

public abstract javax.swing.filechooser.FileFilter getFileFilter()
Gets the file filer associated with this type. Each type should have a unique filter, even if the filename suffixes are the same.

Returns:
file filter

getFileExtension

public abstract java.lang.String getFileExtension()
Gets a string with the file extension associated with files that are handled by this, for example "xls" for Excel files, or "mat" for Matlab files.

Returns:
extension string

canWriteFormat

public abstract boolean canWriteFormat()
Gets whether it is possible to write files in the represented type.

Returns:
true if files can be written, false otherwise

getTypeFromFileName

public static DataHandlerTypes getTypeFromFileName(java.lang.String fName)
Gets the handler type from the filename. DAT is returned as default.

Parameters:
fName - the filename with a descriptive suffix
Returns:
handler type
Throws:
java.lang.IllegalArgumentException - if (fName == null)