org.nanes.slideset.dm.write

Class AbstractOverlaysToSVGFileWriter

java.lang.Object

org.nanes.slideset.dm.write.AbstractOverlaysToSVGFileWriter

All Implemented Interfaces:

ElementWriter<FileLinkElement,net.imagej.overlay.AbstractOverlay[]>

@ElementWriterMetadata(name="SVG file",
                       elementType=FileLinkElement.class,
                       mimeType="image/svg+xml",
                       processedType=AbstractOverlaysAlias.class,
                       linkExt="svg")
public class AbstractOverlaysToSVGFileWriter
extends Object
implements ElementWriter<FileLinkElement,net.imagej.overlay.AbstractOverlay[]>

Author:

Benjamin Nanes

Field Summary

Fields

Modifier and Type	Field and Description
private String	errorMessages
private FileOutputStream	fos

Constructor Summary

Constructors

Constructor and Description
AbstractOverlaysToSVGFileWriter()

Method Summary

Modifier and Type	Method and Description
private void	applyDefaultStyles(XMLStreamWriter xsw) Default SVG styling attributes for overlays
private void	closeFile(XMLStreamWriter xsw) End the SVG file and do cleanup
private void	getPlanarAxes(net.imagej.overlay.AbstractOverlay overlay, int[] axes) Get the X and Y axis indeces for an overlay
private XMLStreamWriter	setupFile(String path, int width, int height, String img) Start the SVG file
void	write(net.imagej.overlay.AbstractOverlay[] data, FileLinkElement elementToWrite) Convert "processed" data to "underlying" data.
void	write(net.imagej.overlay.AbstractOverlay[] data, String path)
void	write(net.imagej.overlay.AbstractOverlay[] data, String path, int width, int height)
void	write(net.imagej.overlay.AbstractOverlay[] data, String path, int width, int height, String imgPath)
private void	writeEllipseOverlay(XMLStreamWriter xsw, net.imagej.overlay.EllipseOverlay overlay) Write an ellipse overlay
private void	writeFile(String path, net.imagej.overlay.AbstractOverlay[] overlays, int width, int height, String img) Write the SVG file to path
private void	writeGeneralPathOverlay(XMLStreamWriter xsw, net.imagej.overlay.GeneralPathOverlay overlay) Write a general path overlay
private void	writeLineOverlay(XMLStreamWriter xsw, net.imagej.overlay.LineOverlay overlay) Write a line overlay
private void	writeOverlay(XMLStreamWriter xsw, net.imagej.overlay.AbstractOverlay overlay) Write an overlay, if supported
private void	writePointOverlay(XMLStreamWriter xsw, net.imagej.overlay.PointOverlay overlay) Write a point overlay.
private void	writePolygonOverlay(XMLStreamWriter xsw, net.imagej.overlay.PolygonOverlay overlay) Write a polygon overlay
private void	writeRectangleOverlay(XMLStreamWriter xsw, net.imagej.overlay.RectangleOverlay overlay) Write a rectangle overlay

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fos

private FileOutputStream fos

errorMessages

private String errorMessages

Constructor Detail

AbstractOverlaysToSVGFileWriter

public AbstractOverlaysToSVGFileWriter()

Method Detail

write

public void write(net.imagej.overlay.AbstractOverlay[] data,
                  FileLinkElement elementToWrite)
           throws SlideSetException

Description copied from interface: ElementWriter

Convert "processed" data to "underlying" data.

Specified by:

write in interface ElementWriter<FileLinkElement,net.imagej.overlay.AbstractOverlay[]>

Parameters:

data - The "processed" data.

elementToWrite - The DataElement to to which the data will be written.

Throws:

SlideSetException

write

public void write(net.imagej.overlay.AbstractOverlay[] data,
                  String path)
           throws SlideSetException

Throws:

SlideSetException

write

public void write(net.imagej.overlay.AbstractOverlay[] data,
                  String path,
                  int width,
                  int height)
           throws SlideSetException

Throws:

SlideSetException

write

public void write(net.imagej.overlay.AbstractOverlay[] data,
                  String path,
                  int width,
                  int height,
                  String imgPath)
           throws SlideSetException

Throws:

SlideSetException

writeFile

private void writeFile(String path,
                       net.imagej.overlay.AbstractOverlay[] overlays,
                       int width,
                       int height,
                       String img)
                throws SlideSetException

Write the SVG file to path

Throws:

SlideSetException

setupFile

private XMLStreamWriter setupFile(String path,
                                  int width,
                                  int height,
                                  String img)
                           throws SlideSetException

Start the SVG file

Throws:

SlideSetException

closeFile

private void closeFile(XMLStreamWriter xsw)
                throws SlideSetException

End the SVG file and do cleanup

Throws:

SlideSetException

writeOverlay

private void writeOverlay(XMLStreamWriter xsw,
                          net.imagej.overlay.AbstractOverlay overlay)
                   throws SlideSetException

Write an overlay, if supported

Throws:

SlideSetException

writePointOverlay

private void writePointOverlay(XMLStreamWriter xsw,
                               net.imagej.overlay.PointOverlay overlay)
                        throws SlideSetException

Write a point overlay.

As it turns out, SVG doesn't actually support point elements, so we'll draw a line with identical start and end points.

Throws:

SlideSetException

writeLineOverlay

private void writeLineOverlay(XMLStreamWriter xsw,
                              net.imagej.overlay.LineOverlay overlay)
                       throws SlideSetException

Write a line overlay

Throws:

SlideSetException

writeRectangleOverlay

private void writeRectangleOverlay(XMLStreamWriter xsw,
                                   net.imagej.overlay.RectangleOverlay overlay)
                            throws SlideSetException

Write a rectangle overlay

Throws:

SlideSetException

writeEllipseOverlay

private void writeEllipseOverlay(XMLStreamWriter xsw,
                                 net.imagej.overlay.EllipseOverlay overlay)
                          throws SlideSetException

Write an ellipse overlay

Throws:

SlideSetException

writePolygonOverlay

private void writePolygonOverlay(XMLStreamWriter xsw,
                                 net.imagej.overlay.PolygonOverlay overlay)
                          throws SlideSetException

Write a polygon overlay

Throws:

SlideSetException

writeGeneralPathOverlay

private void writeGeneralPathOverlay(XMLStreamWriter xsw,
                                     net.imagej.overlay.GeneralPathOverlay overlay)
                              throws SlideSetException

Write a general path overlay

Throws:

SlideSetException

getPlanarAxes

private void getPlanarAxes(net.imagej.overlay.AbstractOverlay overlay,
                           int[] axes)
                    throws SlideSetException

Get the X and Y axis indeces for an overlay

Parameters:

axes - A 2-element int array that will be filled with the X and Y axis indeces, in that order.

Throws:

SlideSetException

applyDefaultStyles

private void applyDefaultStyles(XMLStreamWriter xsw)
                         throws SlideSetException

Default SVG styling attributes for overlays

Throws:

SlideSetException