OverlayIO (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.overlays.OverlayIO

```
public final class OverlayIO
extends Object
```
Utility methods for saving and loading overlays to and from disk.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`BARF`
`protected static int`	`IGNORE`
`protected static int`	`INIT`
`protected static int`	`NODES`
`protected static String`	`NOT_APPLICABLE` String indicating a given field is not applicable to an overlay.
`protected static int`	`PARSE`
`protected static int`	`TABLE`
`protected static int`	`WAIT`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static OverlayObject`	`createOverlay(String className, OverlayTransform trans)` Instantiates an overlay object of the given class.
`static OverlayObject`	`createOverlay(String className, OverlayTransform trans, int lineNum)` Instantiates an overlay object of the given class.
`static loci.poi.hssf.usermodel.HSSFWorkbook`	`exportOverlays(OverlayTransform overlay)` Saves overlays to a .xls workbook.
`static Vector<OverlayObject>[]`	`loadOverlays(BufferedReader in, OverlayTransform trans)` Reads the overlays from the given reader.
`static void`	`saveOverlays(PrintWriter out, OverlayTransform trans)` Writes the overlays to the given writer.

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

Field Detail
- WAIT
```
protected static final int WAIT
```
  See Also:
  
  Constant Field Values
- TABLE
```
protected static final int TABLE
```
  See Also:
  
  Constant Field Values
- NODES
```
protected static final int NODES
```
  See Also:
  
  Constant Field Values
- BARF
```
protected static final int BARF
```
  See Also:
  
  Constant Field Values
- IGNORE
```
protected static final int IGNORE
```
  See Also:
  
  Constant Field Values
- PARSE
```
protected static final int PARSE
```
  See Also:
  
  Constant Field Values
- INIT
```
protected static final int INIT
```
  See Also:
  
  Constant Field Values
- NOT_APPLICABLE
```
protected static final String NOT_APPLICABLE
```
  String indicating a given field is not applicable to an overlay.
  
  See Also:
  
  Constant Field Values

Method Detail

loadOverlays

public static Vector<OverlayObject>[] loadOverlays(BufferedReader in,
                                                   OverlayTransform trans)
                                            throws IOException

Reads the overlays from the given reader.

Throws:: IOException

saveOverlays

public static void saveOverlays(PrintWriter out,
                                OverlayTransform trans)

Writes the overlays to the given writer.

exportOverlays

public static loci.poi.hssf.usermodel.HSSFWorkbook exportOverlays(OverlayTransform overlay)

Saves overlays to a .xls workbook.

createOverlay

public static OverlayObject createOverlay(String className,
                                          OverlayTransform trans)

Instantiates an overlay object of the given class.

createOverlay

public static OverlayObject createOverlay(String className,
                                          OverlayTransform trans,
                                          int lineNum)

Instantiates an overlay object of the given class.

Class OverlayIO

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WAIT

TABLE

NODES

BARF

IGNORE

PARSE

INIT

NOT_APPLICABLE

Method Detail

loadOverlays

saveOverlays

exportOverlays

createOverlay

createOverlay