TmXmlWriter (Fiji Javadocs 0-SNAPSHOT API)

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

```
public class TmXmlWriter
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

protected Logger logger

protected org.jdom2.Element root

Fields
Modifier and Type	Field and Description
`protected Logger`	`logger`
`protected org.jdom2.Element`	`root`

Constructor Summary

Constructors
Constructor and Description
`TmXmlWriter(File file)` Creates a new XML file writer for TrackMate.
`TmXmlWriter(File file, Logger logger)` Creates a new XML file writer for TrackMate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendDisplaySettings(DisplaySettings ds)`
`void`	`appendGUIState(String currentPanelIdentifier)` Appends the current GUI state as a state string to the document.
`void`	`appendLog(String log)` Appends the log content to the document.
`void`	`appendModel(Model model)` Appends the content of a `Model` to the file generated by this writer.
`void`	`appendSettings(Settings settings)` Appends the content of a `Settings` object to the document.
`protected org.jdom2.Element`	`echoAnalyzers(Settings settings)`
`protected org.jdom2.Element`	`echoDetectorSettings(Settings settings)`
`protected org.jdom2.Element`	`echoImageInfo(Settings settings)`
`protected org.jdom2.Element`	`echoInitialSpotFilter(Settings settings)`
`protected org.jdom2.Element`	`echoSpotFilters(Settings settings)`
`protected org.jdom2.Element`	`echoTrackerSettings(Settings settings)`
`protected org.jdom2.Element`	`echoTrackFilters(Settings settings)`
`String`	`toString()`
`void`	`writeToFile()` Writes the document to the file.

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

- Field Detail
  - root
```
protected final org.jdom2.Element root
```
  - logger
```
protected final Logger logger
```
- Constructor Detail
  - TmXmlWriter
```
public TmXmlWriter(File file)
```
    Creates a new XML file writer for TrackMate.
    
    Parameters:
    
    file - the xml file to write to, will be overwritten.
  - TmXmlWriter
```
public TmXmlWriter(File file,
                   Logger logger)
```
    Creates a new XML file writer for TrackMate.
    
    Parameters:
    
    file - the xml file to write to, will be overwritten.
- Method Detail
  - writeToFile
```
public void writeToFile()
                 throws FileNotFoundException,
                        IOException
```
    Writes the document to the file. Content must be appended first.
    
    Throws:
    
    FileNotFoundException
    
    IOException
    
    See Also:
    
    appendLog(String), appendModel(Model), appendSettings(Settings)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - appendModel
```
public void appendModel(Model model)
```
    Appends the content of a Model to the file generated by this writer.
    
    Parameters:
    
    model - the Model to write.
  - appendSettings
```
public void appendSettings(Settings settings)
```
    Appends the content of a Settings object to the document.
    
    Parameters:
    
    settings - the Settings to write.
  - appendLog
```
public void appendLog(String log)
```
    Appends the log content to the document.
    
    Parameters:
    
    log - the log content, as a String.
  - appendGUIState
```
public void appendGUIState(String currentPanelIdentifier)
```
    Appends the current GUI state as a state string to the document.
    
    Parameters:
    
    currentPanelIdentifier - the key to the panel currently displaying.
  - appendDisplaySettings
```
public void appendDisplaySettings(DisplaySettings ds)
```
  - echoDetectorSettings
```
protected org.jdom2.Element echoDetectorSettings(Settings settings)
```
  - echoTrackerSettings
```
protected org.jdom2.Element echoTrackerSettings(Settings settings)
```
  - echoImageInfo
```
protected org.jdom2.Element echoImageInfo(Settings settings)
```
  - echoInitialSpotFilter
```
protected org.jdom2.Element echoInitialSpotFilter(Settings settings)
```
  - echoSpotFilters
```
protected org.jdom2.Element echoSpotFilters(Settings settings)
```
  - echoTrackFilters
```
protected org.jdom2.Element echoTrackFilters(Settings settings)
```
  - echoAnalyzers
```
protected org.jdom2.Element echoAnalyzers(Settings settings)
```

Class TmXmlWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

root

logger

Constructor Detail

TmXmlWriter

TmXmlWriter

Method Detail

writeToFile

toString

appendModel

appendSettings

appendLog

appendGUIState

appendDisplaySettings

echoDetectorSettings

echoTrackerSettings

echoImageInfo

echoInitialSpotFilter

echoSpotFilters

echoTrackFilters

echoAnalyzers