DataPathWanderer (OpenMap API)
Date: 2016-12-09

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

## com.bbn.openmap.util.wanderer
Class DataPathWanderer

    java.lang.Object
      com.bbn.openmap.util.wanderer.Wanderer
          com.bbn.openmap.util.wanderer.DataPathWanderer

All Implemented Interfaces:
  WandererCallback

Direct Known Subclasses:
  RpfDataPathWanderer

    public abstract class DataPathWanderer

extends Wanderer
implements WandererCallback

A DataPathWanderer provides a list of valid data paths found from a parent directory. This class is intended to be provided by a layer to report which data files or directories can be used for that layer, given some parent directory or file.

Author:
  dfdietrick

Field Summary
`protected java.util.List<java.lang.String>` | `dataPaths`

Fields inherited from class com.bbn.openmap.util.wanderer.Wanderer
`exhaustiveSearch, topToBottom`

Constructor Summary
`DataPathWanderer()`

Method Summary
`protected void` | `addDataPath(java.lang.String path)` Adds a data path to the path repository.
`java.util.List<java.lang.String>` | `getDataPaths()` Returns a list of file/directory paths.
`abstract java.lang.Class<?>` | `getDataUserClass()` Which component class, like a specific layer type, will be using the data path.
`abstract java.lang.String` | `getPrettyName()`
`boolean` | `isMultiPathLayer()` True if layer being described can handle more than one data path, i.e.

Methods inherited from class com.bbn.openmap.util.wanderer.Wanderer
`getCallback, handleDirectory, handleEntry, isExhaustiveSearch, isTopToBottom, main, setCallback, setExhaustiveSearch, setTopToBottom`

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

Methods inherited from interface com.bbn.openmap.util.wanderer.WandererCallback
`handleDirectory, handleFile`

Field Detail

### dataPaths

    protected java.util.List<java.lang.String> dataPaths

Constructor Detail

### DataPathWanderer

    public DataPathWanderer()

Method Detail

### getDataUserClass

    public abstract java.lang.Class<?> getDataUserClass()

  Which component class, like a specific layer type, will be using the data path.

  Returns:
    Class of using component.

### getPrettyName

    public abstract java.lang.String getPrettyName()

  Returns:
    pretty name of the using component.x

### getDataPaths

    public java.util.List<java.lang.String> getDataPaths()

  Returns a list of file/directory paths.

  Returns:
    a list of file/directory paths. If null, no required data paths were found and the layer is indicating that it needs paths. If a list is returned and its empty, then the layer doesn't require a data file.

### addDataPath

    protected void addDataPath(java.lang.String path)

  Adds a data path to the path repository. Creates the repository list if it doesn't yet exist. A call with a null path will get the repository list created.

  Parameters:
    `path` -

### isMultiPathLayer

    public boolean isMultiPathLayer()

  True if layer being described can handle more than one data path, i.e. all the data paths found can be added to a single layer.

  Returns:
    false by default

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

Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details