Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.basex.build.fs
Class FSParser

    java.lang.Object
      org.basex.build.Parser
          org.basex.build.fs.FSParser

    public final class FSParser

extends Parser

Imports/shreds/parses a file hierarchy into a BaseX database. The overall process of importing a file hierarchy can be described as follows:

1. The import is invoked by the `CreateFS` command. To import on the command line type: `$ create fs [path] [dbname]`
2. This class `FSParser` instantiates the needed components for the import process in its `parse(Builder)` method.

Author:
  Workgroup DBIS, University of Konstanz 2005-09, ISC License, Alexander Holupirek, alex@holupirek.de

Field Summary
`java.lang.String` | `mountpoint` Path to FUSE mountpoint.
`java.lang.String` | `mybackingpath` Path to root of the backing store for this import.
`static int` | `SIZEOFFSET` Offset of the size value, as stored in `atts(File, boolean)`.

Fields inherited from class org.basex.build.Parser
`doc, io`

Constructor Summary
`FSParser(java.lang.String path)` Constructor to parse single file nodes.
`FSParser(java.lang.String path, java.lang.String mp, java.lang.String bs)` Constructor.

Method Summary
`java.lang.String` | `det()` Returns detailed progress information.
`java.lang.String` | `head()` Returns a compact description of the current progress.
`void` | `parse(Builder build)` Main entry point for the import of a file hierarchy.
`double` | `prog()` Returns a value from 0 to 1, representing the current progress.

Methods inherited from class org.basex.build.Parser
`getXMLParser`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### SIZEOFFSET

    public static final int SIZEOFFSET

  Offset of the size value, as stored in `atts(File, boolean)`.

  See Also:
    Constant Field Values

### mybackingpath

    public java.lang.String mybackingpath

  Path to root of the backing store for this import.

### mountpoint

    public java.lang.String mountpoint

  Path to FUSE mountpoint.

Constructor Detail

### FSParser

    public FSParser(java.lang.String path,
                    java.lang.String mp,
                    java.lang.String bs)

  Constructor.

  Parameters:
    `path` - the traversal starts from
    `mp` - mount point for fuse
    `bs` - path to root of backing store for BLOBs on Windows systems. If set to true, the path reference is ignored

### FSParser

    public FSParser(java.lang.String path)

  Constructor to parse single file nodes.

  Parameters:
    `path` - String to file node to parse

Method Detail

### parse

    public void parse(Builder build)
               throws java.io.IOException

  Main entry point for the import of a file hierarchy. Instantiates the engine and starts the traversal.

  Specified by:
    `parse` in class `Parser`
  Parameters:
    `build` - instance passed by `CreateFS`.
  Throws:
    `java.io.IOException` - I/O exception

### head

    public java.lang.String head()

  Description copied from class: `Parser`
  Returns a compact description of the current progress.

  Overrides:
    `head` in class `Parser`
  Returns:
    progress information

### det

    public java.lang.String det()

  Description copied from class: `Parser`
  Returns detailed progress information.

  Overrides:
    `det` in class `Parser`
  Returns:
    position info

### prog

    public double prog()

  Description copied from class: `Parser`
  Returns a value from 0 to 1, representing the current progress.

  Overrides:
    `prog` in class `Parser`
  Returns:
    progress information

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD