XmlHelpers (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.spim.data.XmlHelpers

```
public class XmlHelpers
extends Object
```

Constructor Summary

Constructors
Constructor and Description

XmlHelpers()

Constructors
Constructor and Description
`XmlHelpers()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static org.jdom2.Element`	`affineTransform3DElement(String name, AffineGet value)`
`static org.jdom2.Element`	`booleanElement(String name, boolean value)`
`static org.jdom2.Element`	`dimensionsElement(String name, Dimensions size)`
`static org.jdom2.Element`	`doubleArrayElement(String name, double[] value)` Append a double array as space-separated list of values
`static org.jdom2.Element`	`doubleElement(String name, double value)`
`static AffineTransform3D`	`getAffineTransform3D(org.jdom2.Element parent, String name)`
`static AffineTransform3D`	`getAffineTransform3D(org.jdom2.Element parent, String name, AffineTransform3D defaultValue)`
`static boolean`	`getBoolean(org.jdom2.Element parent, String name)`
`static boolean`	`getBoolean(org.jdom2.Element parent, String name, boolean defaultValue)`
`static Dimensions`	`getDimensions(org.jdom2.Element parent, String name)`
`static Dimensions`	`getDimensions(org.jdom2.Element parent, String name, Dimensions defaultValue)`
`static double`	`getDouble(org.jdom2.Element parent, String name)`
`static double`	`getDouble(org.jdom2.Element parent, String name, double defaultValue)`
`static double[]`	`getDoubleArray(org.jdom2.Element parent, String name)`
`static double[]`	`getDoubleArray(org.jdom2.Element parent, String name, double[] defaultValue)`
`static double[]`	`getDoubleArrayAttribute(org.jdom2.Element parent, String name)`
`static double`	`getDoubleAttribute(org.jdom2.Element parent, String name)`
`static int`	`getInt(org.jdom2.Element parent, String name)`
`static int`	`getInt(org.jdom2.Element parent, String name, int defaultValue)`
`static int[]`	`getIntArray(org.jdom2.Element parent, String name)`
`static int[]`	`getIntArray(org.jdom2.Element parent, String name, int[] defaultValue)`
`static int`	`getIntAttribute(org.jdom2.Element parent, String name)`
`static long[]`	`getLongArray(org.jdom2.Element parent, String name)`
`static long[]`	`getLongArray(org.jdom2.Element parent, String name, long[] defaultValue)`
`static File`	`getRelativePath(File file, File relativeToThis)`
`static String`	`getText(org.jdom2.Element parent, String name)`
`static String`	`getText(org.jdom2.Element parent, String name, String defaultValue)`
`static org.jdom2.Element`	`intArrayElement(String name, int[] value)`
`static org.jdom2.Element`	`intElement(String name, int value)`
`static boolean`	`isPathRelative(org.jdom2.Element parent, String name)`
`static File`	`loadPath(org.jdom2.Element parent, String name, File basePath)`
`static File`	`loadPath(org.jdom2.Element parent, String name, String defaultRelativePath, File basePath)`
`static org.jdom2.Element`	`longArrayElement(String name, long[] value)`
`static org.jdom2.Element`	`pathElement(String name, File path, File basePath)`
`static org.jdom2.Element`	`textElement(String name, String text)`

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

Constructor Detail
- XmlHelpers
```
public XmlHelpers()
```

Method Detail

textElement

public static org.jdom2.Element textElement(String name,
                                            String text)

getText

public static String getText(org.jdom2.Element parent,
                             String name)

getText

public static String getText(org.jdom2.Element parent,
                             String name,
                             String defaultValue)

intElement

public static org.jdom2.Element intElement(String name,
                                           int value)

getInt

public static int getInt(org.jdom2.Element parent,
                         String name)

getInt

public static int getInt(org.jdom2.Element parent,
                         String name,
                         int defaultValue)

booleanElement

public static org.jdom2.Element booleanElement(String name,
                                               boolean value)

getBoolean

public static boolean getBoolean(org.jdom2.Element parent,
                                 String name)

getBoolean

public static boolean getBoolean(org.jdom2.Element parent,
                                 String name,
                                 boolean defaultValue)

doubleElement

public static org.jdom2.Element doubleElement(String name,
                                              double value)

getDouble

public static double getDouble(org.jdom2.Element parent,
                               String name)

getDouble

public static double getDouble(org.jdom2.Element parent,
                               String name,
                               double defaultValue)

getDoubleAttribute

public static double getDoubleAttribute(org.jdom2.Element parent,
                                        String name)

doubleArrayElement

public static org.jdom2.Element doubleArrayElement(String name,
                                                   double[] value)

Append a double array as space-separated list of values

getDoubleArray

public static double[] getDoubleArray(org.jdom2.Element parent,
                                      String name)

getDoubleArray

public static double[] getDoubleArray(org.jdom2.Element parent,
                                      String name,
                                      double[] defaultValue)

getDoubleArrayAttribute

public static double[] getDoubleArrayAttribute(org.jdom2.Element parent,
                                               String name)

getIntAttribute

public static int getIntAttribute(org.jdom2.Element parent,
                                  String name)

intArrayElement

public static org.jdom2.Element intArrayElement(String name,
                                                int[] value)

getIntArray

public static int[] getIntArray(org.jdom2.Element parent,
                                String name)

getIntArray

public static int[] getIntArray(org.jdom2.Element parent,
                                String name,
                                int[] defaultValue)

longArrayElement

public static org.jdom2.Element longArrayElement(String name,
                                                 long[] value)

getLongArray

public static long[] getLongArray(org.jdom2.Element parent,
                                  String name)

getLongArray

public static long[] getLongArray(org.jdom2.Element parent,
                                  String name,
                                  long[] defaultValue)

dimensionsElement

public static org.jdom2.Element dimensionsElement(String name,
                                                  Dimensions size)

getDimensions

public static Dimensions getDimensions(org.jdom2.Element parent,
                                       String name)

getDimensions

public static Dimensions getDimensions(org.jdom2.Element parent,
                                       String name,
                                       Dimensions defaultValue)

affineTransform3DElement

public static org.jdom2.Element affineTransform3DElement(String name,
                                                         AffineGet value)

getAffineTransform3D

public static AffineTransform3D getAffineTransform3D(org.jdom2.Element parent,
                                                     String name)

getAffineTransform3D

public static AffineTransform3D getAffineTransform3D(org.jdom2.Element parent,
                                                     String name,
                                                     AffineTransform3D defaultValue)

loadPath

public static File loadPath(org.jdom2.Element parent,
                            String name,
                            String defaultRelativePath,
                            File basePath)

loadPath

public static File loadPath(org.jdom2.Element parent,
                            String name,
                            File basePath)

isPathRelative

public static boolean isPathRelative(org.jdom2.Element parent,
                                     String name)

Returns:: true if the path under parent/name is stored relative, false if absolute.

pathElement

public static org.jdom2.Element pathElement(String name,
                                            File path,
                                            File basePath)

Parameters:: basePath - if null put the absolute path, otherwise relative to this

getRelativePath

public static File getRelativePath(File file,
                                   File relativeToThis)

Class XmlHelpers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XmlHelpers

Method Detail

textElement

getText

getText

intElement

getInt

getInt

booleanElement

getBoolean

getBoolean

doubleElement

getDouble

getDouble

getDoubleAttribute

doubleArrayElement

getDoubleArray

getDoubleArray

getDoubleArrayAttribute

getIntAttribute

intArrayElement

getIntArray

getIntArray

longArrayElement

getLongArray

getLongArray

dimensionsElement

getDimensions

getDimensions

affineTransform3DElement

getAffineTransform3D

getAffineTransform3D

loadPath

loadPath

isPathRelative

pathElement

getRelativePath