IOUtils (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- fiji.plugin.trackmate.io.IOUtils

```
public class IOUtils
extends Object
```
A collection of static utilities for the input/output of xml files.

Author:

Jean-Yves Tinevez

Constructor Summary

Constructors
Constructor and Description

IOUtils()

Constructors
Constructor and Description
`IOUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static File`	`askForFileForLoading(File file, String title, Frame parent, Logger logger)` Prompts the user for a xml file to load from.
`static File`	`askForFileForSaving(File file, Frame parent, Logger logger)` Prompts the user for a xml file to save to.
`static File`	`askForFolder(File file, String title, Frame parent, Logger logger)` Prompts the user for a target folder.
`static boolean`	`canReadFile(String path, StringBuilder errorHolder)`
`static void`	`marshallMap(Map<String,Double> map, org.jdom2.Element element)` Stores the given mapping in a given JDom element, using attributes in a KEY="VALUE" fashion.
`static boolean`	`readBooleanAttribute(org.jdom2.Element element, Map<String,Object> settings, String parameterKey, StringBuilder errorHolder)`
`static boolean`	`readBooleanAttribute(org.jdom2.Element element, String name, Logger logger)`
`static boolean`	`readBooleanAttribute(org.jdom2.Element element, String name, Logger logger, boolean defaultValue)`
`static boolean`	`readDoubleAttribute(org.jdom2.Element element, Map<String,Object> settings, String parameterKey, StringBuilder errorHolder)`
`static double`	`readDoubleAttribute(org.jdom2.Element element, String name, Logger logger)`
`static double`	`readDoubleAttribute(org.jdom2.Element element, String name, Logger logger, double defaultValue)`
`static double`	`readFloatAttribute(org.jdom2.Element element, String name, Logger logger)`
`static int`	`readIntAttribute(org.jdom2.Element element, String name, Logger logger)` Read and return an integer attribute from a JDom `Element`, and substitute a default value of 0 if the attribute is not found or of the wrong type.
`static int`	`readIntAttribute(org.jdom2.Element element, String name, Logger logger, int defaultValue)`
`static boolean`	`readIntegerAttribute(org.jdom2.Element element, Map<String,Object> settings, String parameterKey, StringBuilder errorHolder)`
`static boolean`	`readStringAttribute(org.jdom2.Element element, Map<String,Object> settings, String parameterKey, StringBuilder errorHolder)`
`static boolean`	`unmarshallMap(org.jdom2.Element element, Map<String,Double> map, StringBuilder errorHolder)` Unmarshall the attributes of a JDom element in a map of doubles.
`static boolean`	`writeAttribute(Map<String,Object> settings, org.jdom2.Element element, String parameterKey, Class<?> expectedClass, StringBuilder errorHolder)` Add a parameter attribute to the given element, taken from the given settings map.
`static boolean`	`writeDoMedian(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`
`static boolean`	`writeDoSubPixel(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`
`static boolean`	`writeDownsamplingFactor(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`
`static boolean`	`writeRadius(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`
`static boolean`	`writeTargetChannel(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`
`static boolean`	`writeThreshold(Map<String,Object> settings, org.jdom2.Element element, StringBuilder errorHolder)`

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

Constructor Detail
- IOUtils
```
public IOUtils()
```

Method Detail

canReadFile

public static final boolean canReadFile(String path,
                                        StringBuilder errorHolder)

askForFileForSaving
```
public static File askForFileForSaving(File file,
                                       Frame parent,
                                       Logger logger)
```
Prompts the user for a xml file to save to.

Parameters:

file - a default file, will be used to display a default choice in the file chooser.

parent - the Frame to lock on this dialog. It can be null; in that case, native dialogs will not be used on Macs.

logger - a Logger to report what is happening.

Returns:

the selected file, or null if the user pressed the "cancel" button.

askForFileForLoading
```
public static File askForFileForLoading(File file,
                                        String title,
                                        Frame parent,
                                        Logger logger)
```
Prompts the user for a xml file to load from.

Parameters:

file - a default file, will be used to display a default choice in the file chooser.

title - the title to display on the file chooser window

parent - the Frame to lock on this dialog.

logger - a Logger to report what is happening.

Returns:

the selected file, or null if the user pressed the "cancel" button.

askForFolder
```
public static File askForFolder(File file,
                                String title,
                                Frame parent,
                                Logger logger)
```
Prompts the user for a target folder.

Parameters:

file - a default file, will be used to display a default choice in the file chooser.

title - the title to display on the file chooser window

parent - the Frame to lock on this dialog.

logger - a Logger to report what is happening.

Returns:

the selected file, or null if the user pressed the "cancel" button.

readIntAttribute

public static final int readIntAttribute(org.jdom2.Element element,
                                         String name,
                                         Logger logger)

Read and return an integer attribute from a JDom Element, and substitute a default value of 0 if the attribute is not found or of the wrong type.

readIntAttribute

public static final int readIntAttribute(org.jdom2.Element element,
                                         String name,
                                         Logger logger,
                                         int defaultValue)

readFloatAttribute

public static final double readFloatAttribute(org.jdom2.Element element,
                                              String name,
                                              Logger logger)

readDoubleAttribute

public static final double readDoubleAttribute(org.jdom2.Element element,
                                               String name,
                                               Logger logger)

readDoubleAttribute

public static final double readDoubleAttribute(org.jdom2.Element element,
                                               String name,
                                               Logger logger,
                                               double defaultValue)

readBooleanAttribute

public static final boolean readBooleanAttribute(org.jdom2.Element element,
                                                 String name,
                                                 Logger logger)

readBooleanAttribute

public static final boolean readBooleanAttribute(org.jdom2.Element element,
                                                 String name,
                                                 Logger logger,
                                                 boolean defaultValue)

readDoubleAttribute

public static final boolean readDoubleAttribute(org.jdom2.Element element,
                                                Map<String,Object> settings,
                                                String parameterKey,
                                                StringBuilder errorHolder)

readIntegerAttribute

public static final boolean readIntegerAttribute(org.jdom2.Element element,
                                                 Map<String,Object> settings,
                                                 String parameterKey,
                                                 StringBuilder errorHolder)

readBooleanAttribute

public static final boolean readBooleanAttribute(org.jdom2.Element element,
                                                 Map<String,Object> settings,
                                                 String parameterKey,
                                                 StringBuilder errorHolder)

readStringAttribute

public static final boolean readStringAttribute(org.jdom2.Element element,
                                                Map<String,Object> settings,
                                                String parameterKey,
                                                StringBuilder errorHolder)

unmarshallMap
```
public static boolean unmarshallMap(org.jdom2.Element element,
                                    Map<String,Double> map,
                                    StringBuilder errorHolder)
```
Unmarshall the attributes of a JDom element in a map of doubles. Mappings are added to the specified map. If a value is found not to be a double, an error is returned.

Returns:

true if all values were found and mapped as doubles, false otherwise and the error holder is updated.

writeTargetChannel

public static final boolean writeTargetChannel(Map<String,Object> settings,
                                               org.jdom2.Element element,
                                               StringBuilder errorHolder)

writeRadius

public static final boolean writeRadius(Map<String,Object> settings,
                                        org.jdom2.Element element,
                                        StringBuilder errorHolder)

writeThreshold

public static final boolean writeThreshold(Map<String,Object> settings,
                                           org.jdom2.Element element,
                                           StringBuilder errorHolder)

writeDoMedian

public static final boolean writeDoMedian(Map<String,Object> settings,
                                          org.jdom2.Element element,
                                          StringBuilder errorHolder)

writeDoSubPixel

public static final boolean writeDoSubPixel(Map<String,Object> settings,
                                            org.jdom2.Element element,
                                            StringBuilder errorHolder)

writeDownsamplingFactor

public static final boolean writeDownsamplingFactor(Map<String,Object> settings,
                                                    org.jdom2.Element element,
                                                    StringBuilder errorHolder)

writeAttribute
```
public static final boolean writeAttribute(Map<String,Object> settings,
                                           org.jdom2.Element element,
                                           String parameterKey,
                                           Class<?> expectedClass,
                                           StringBuilder errorHolder)
```
Add a parameter attribute to the given element, taken from the given settings map. Basic checks are made to ensure that the parameter value can be found and is of the right class.

Parameters:

settings - the map to take the parameter value from

element - the JDom element to update

parameterKey - the key to the parameter value in the map

expectedClass - the expected class for the value

Returns:

true if the parameter was found, of the right class, and was successfully added to the element, false if not, and updated the specified error holder.

marshallMap

public static void marshallMap(Map<String,Double> map,
                               org.jdom2.Element element)

Stores the given mapping in a given JDom element, using attributes in a KEY="VALUE" fashion.

Class IOUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IOUtils

Method Detail

canReadFile

askForFileForSaving

askForFileForLoading

askForFolder

readIntAttribute

readIntAttribute

readFloatAttribute

readDoubleAttribute

readDoubleAttribute

readBooleanAttribute

readBooleanAttribute

readDoubleAttribute

readIntegerAttribute

readBooleanAttribute

readStringAttribute

unmarshallMap

writeTargetChannel

writeRadius

writeThreshold

writeDoMedian

writeDoSubPixel

writeDownsamplingFactor

writeAttribute

marshallMap