AbstractFileLoader (original) (raw)

• java.lang.Object

• • weka.core.converters.AbstractLoader
  • • weka.core.converters.AbstractFileLoader

• All Implemented Interfaces:
  java.io.Serializable, FileSourcedConverter, Loader, EnvironmentHandler, RevisionHandler
  Direct Known Subclasses:
  ArffLoader, C45Loader, CSVLoader, LibSVMLoader, SerializedInstancesLoader, SVMLightLoader, XRFFLoader

public abstract class AbstractFileLoader
extends AbstractLoader
implements FileSourcedConverter, EnvironmentHandler
Abstract superclass for all file loaders.
Version: Revision:7391Revision: 7391 Revision:7391
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field and Description
  static java.lang.String	FILE_EXTENSION_COMPRESSED the extension for compressed files

     * ### Fields inherited from interface weka.core.converters.[Loader](../../../weka/core/converters/Loader.html "interface in weka.core.converters")  
     `[BATCH](../../../weka/core/converters/Loader.html#BATCH), [INCREMENTAL](../../../weka/core/converters/Loader.html#INCREMENTAL), [NONE](../../../weka/core/converters/Loader.html#NONE)`  

  • Constructor Summary

  Constructors

  Constructor and Description
  AbstractFileLoader()

  • Method Summary

  All Methods Static Methods Instance Methods Concrete Methods

  Modifier and Type	Method and Description
  boolean	getUseRelativePath() Gets whether relative paths are to be used
  void	reset() Resets the loader ready to read a new data set
  java.io.File	retrieveFile() get the File specified as the source
  static void	runFileLoader(AbstractFileLoader loader, java.lang.String[] options) runs the given loader with the provided options
  void	setEnvironment(Environment env) Set the environment variables to use.
  void	setFile(java.io.File file) sets the source File
  void	setSource(java.io.File file) Resets the Loader object and sets the source of the data set to be the supplied File object.
  void	setUseRelativePath(boolean rp) Set whether to use relative rather than absolute paths
  java.lang.String	useRelativePathTipText() Tip text suitable for displaying int the GUI

     * ### Methods inherited from class weka.core.converters.[AbstractLoader](../../../weka/core/converters/AbstractLoader.html "class in weka.core.converters")  
     `[getDataSet](../../../weka/core/converters/AbstractLoader.html#getDataSet--), [getNextInstance](../../../weka/core/converters/AbstractLoader.html#getNextInstance-weka.core.Instances-), [getStructure](../../../weka/core/converters/AbstractLoader.html#getStructure--), [setRetrieval](../../../weka/core/converters/AbstractLoader.html#setRetrieval-int-), [setSource](../../../weka/core/converters/AbstractLoader.html#setSource-java.io.InputStream-)`  
     * ### Methods inherited from class java.lang.Object  
     `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`  
     * ### Methods inherited from interface weka.core.converters.[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")  
     `[getFileDescription](../../../weka/core/converters/FileSourcedConverter.html#getFileDescription--), [getFileExtension](../../../weka/core/converters/FileSourcedConverter.html#getFileExtension--), [getFileExtensions](../../../weka/core/converters/FileSourcedConverter.html#getFileExtensions--)`  
     * ### Methods inherited from interface weka.core.[RevisionHandler](../../../weka/core/RevisionHandler.html "interface in weka.core")  
     `[getRevision](../../../weka/core/RevisionHandler.html#getRevision--)`

• • Field Detail

     * #### FILE\_EXTENSION\_COMPRESSED  
     public static java.lang.String FILE_EXTENSION_COMPRESSED  
     the extension for compressed files  

  • Constructor Detail

    * #### AbstractFileLoader  
    public AbstractFileLoader()  

  • Method Detail

    * #### retrieveFile  
    public java.io.File retrieveFile()  
    get the File specified as the source  
    Specified by:  
    `[retrieveFile](../../../weka/core/converters/FileSourcedConverter.html#retrieveFile--)` in interface `[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")`  
    Returns:  
    the source file  
    * #### setFile  
    public void setFile(java.io.File file)  
                 throws java.io.IOException  
    sets the source File  
    Specified by:  
    `[setFile](../../../weka/core/converters/FileSourcedConverter.html#setFile-java.io.File-)` in interface `[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")`  
    Parameters:  
    `file` \- the source file  
    Throws:  
    `java.io.IOException` \- if an error occurs  
    * #### setEnvironment  
    public void setEnvironment([Environment](../../../weka/core/Environment.html "class in weka.core") env)  
    Set the environment variables to use.  
    Specified by:  
    `[setEnvironment](../../../weka/core/EnvironmentHandler.html#setEnvironment-weka.core.Environment-)` in interface `[EnvironmentHandler](../../../weka/core/EnvironmentHandler.html "interface in weka.core")`  
    Parameters:  
    `env` \- the environment variables to use  
    * #### reset  
    public void reset()  
               throws java.io.IOException  
    Resets the loader ready to read a new data set  
    Specified by:  
    `[reset](../../../weka/core/converters/Loader.html#reset--)` in interface `[Loader](../../../weka/core/converters/Loader.html "interface in weka.core.converters")`  
    Overrides:  
    `[reset](../../../weka/core/converters/AbstractLoader.html#reset--)` in class `[AbstractLoader](../../../weka/core/converters/AbstractLoader.html "class in weka.core.converters")`  
    Throws:  
    `java.io.IOException` \- if something goes wrong  
    * #### setSource  
    public void setSource(java.io.File file)  
                   throws java.io.IOException  
    Resets the Loader object and sets the source of the data set to be the supplied File object.  
    Specified by:  
    `[setSource](../../../weka/core/converters/Loader.html#setSource-java.io.File-)` in interface `[Loader](../../../weka/core/converters/Loader.html "interface in weka.core.converters")`  
    Overrides:  
    `[setSource](../../../weka/core/converters/AbstractLoader.html#setSource-java.io.File-)` in class `[AbstractLoader](../../../weka/core/converters/AbstractLoader.html "class in weka.core.converters")`  
    Parameters:  
    `file` \- the source file.  
    Throws:  
    `java.io.IOException` \- if an error occurs  
    * #### useRelativePathTipText  
    public java.lang.String useRelativePathTipText()  
    Tip text suitable for displaying int the GUI  
    Returns:  
    a description of this property as a String  
    * #### setUseRelativePath  
    public void setUseRelativePath(boolean rp)  
    Set whether to use relative rather than absolute paths  
    Specified by:  
    `[setUseRelativePath](../../../weka/core/converters/FileSourcedConverter.html#setUseRelativePath-boolean-)` in interface `[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")`  
    Parameters:  
    `rp` \- true if relative paths are to be used  
    * #### getUseRelativePath  
    public boolean getUseRelativePath()  
    Gets whether relative paths are to be used  
    Specified by:  
    `[getUseRelativePath](../../../weka/core/converters/FileSourcedConverter.html#getUseRelativePath--)` in interface `[FileSourcedConverter](../../../weka/core/converters/FileSourcedConverter.html "interface in weka.core.converters")`  
    Returns:  
    true if relative paths are to be used  
    * #### runFileLoader  
    public static void runFileLoader([AbstractFileLoader](../../../weka/core/converters/AbstractFileLoader.html "class in weka.core.converters") loader,  
                                     java.lang.String[] options)  
    runs the given loader with the provided options  
    Parameters:  
    `loader` \- the loader to run  
    `options` \- the commandline options, first argument must be the file to load