SonarVis

Class SonarModelOutputParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

SonarVis.SonarModelOutputParser

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class SonarModelOutputParser
extends DefaultHandler

This class parses output files generated by a sonar model engine into lists of RadialBlades and DepthBlades.

Version:

$Revision: 1.12 $

Author:

Scott Rosetti, LT USN

Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

See Also:

DepthBlade, BullsEyePlot, IsoSurfaceBlockPlot, CoverageArea, LineOfBearingPlot, RadialBlade, SLOBChart, SignalExcessPoint, SignalExcessZone, StackScene3D

Constructor Summary

Constructors

Constructor and Description
SonarModelOutputParser(String[] files) Creates a new instance of SonarModelOutputParser

Method Summary

Modifier and Type	Method and Description
void	characters(char[] buf, int offset, int len) Writes pending text (characters inside elements) to the writer.
double	convertToSignalExcess(double ratio) Converts sound pressure ratio to signal excess
void	endDocument() Flushes debugging output.
void	endElement(String namespaceURI, String sName, String qName) Receives notification of the end of an element.
void	generateAllSonarPlots() Generates all sonar plots.
String	generateBullsEyePlot(double depth) Generates BullsEyePlot instance.
String	generateFullFieldPlot(double bearing) Generates full field plot.
String	generateIsoSurfaceExample() This method generates an IsoSurface example scene.
String	generateIsoSurfacePlot() Generates isosurface plot.
void	generateSLOBChart(double bearing, double depth, int counter) Generates single line of bearing plot.
String	generateStackScenePlot() This method generates stack scene.
String	generateVRMLBullPlot(double depth) Generates Xj3D-friendly version.
LinkedList[]	getBlades() Returns generated LinkedList.
int	getRadialIndex(double bearing) Generates radial indices - assumes radials are in order.
String	getVRMLSLOBChart(double bearing, double depth, int counter) Temporary class generates Xj3D-friendly version single line of bearing plot
LinkedList[]	parseDocuments(String[] files) Parses properly formatted files passed in and return array of Lists (RadialBlades and DepthBlades).
void	processData() Processs the data to set 'true' to parsing done boolean variable.
void	setEnvironmentalData(EnvironmentalData data) Sets environmental data.
void	startDocument() Generates output header.
void	startElement(String namespaceURI, String sName, String qName, Attributes attrs) Receives notification of the start of an element.
String[]	trimToMaxEntrySize(String[] files) To keep visualization managable, number of BullsEye plots are limited to amount specified in MAX_ENTRY_SIZE.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

SonarModelOutputParser

public SonarModelOutputParser(String[] files)

Creates a new instance of SonarModelOutputParser

Parameters:

files - The array of filenames (sonar model output) to be parsed.

Method Detail

startDocument

public void startDocument()
                   throws SAXException

Generates output header.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException - The error of warning message.

endDocument

public void endDocument()
                 throws SAXException

Flushes debugging output.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException - The I/O error of warning message.

startElement

public void startElement(String namespaceURI,
                         String sName,
                         String qName,
                         Attributes attrs)
                  throws SAXException

Receives notification of the start of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string.

sName - The local name (without prefix)

qName - The qualified name (with prefix), or the empty string.

attrs - The attributes attached to the element.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

endElement

public void endElement(String namespaceURI,
                       String sName,
                       String qName)
                throws SAXException

Receives notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string

sName - The local name (without prefix), or the empty string

qName - The qualified name (with prefix), or the empty string.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

characters

public void characters(char[] buf,
                       int offset,
                       int len)
                throws SAXException

Writes pending text (characters inside elements) to the writer.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

buf - The characters.

offset - The start position in the character array.

len - The number of characters to use from the character array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

processData

public void processData()

Processs the data to set 'true' to parsing done boolean variable.

parseDocuments

public LinkedList[] parseDocuments(String[] files)

Parses properly formatted files passed in and return array of Lists (RadialBlades and DepthBlades).

Parameters:

files - The array of filenames (sonar model output) to be parsed.

Returns:

The array of new generated LinkedList.

convertToSignalExcess

public double convertToSignalExcess(double ratio)

Converts sound pressure ratio to signal excess

Parameters:

ratio - The ratio of the sound pressure.

Returns:

The signal excess.

setEnvironmentalData

public void setEnvironmentalData(EnvironmentalData data)

Sets environmental data.

Parameters:

data - EnvironmentalData object includes bathymetric data, ssp, and wind.

generateAllSonarPlots

public void generateAllSonarPlots()

Generates all sonar plots.

generateBullsEyePlot

public String generateBullsEyePlot(double depth)

Generates BullsEyePlot instance.

Parameters:

depth - The depths (in KM).

Returns:

The String value of formatted .x3d file name.

generateStackScenePlot

public String generateStackScenePlot()

This method generates stack scene.

Returns:

the String value of formatted .x3d file name.

generateIsoSurfaceExample

public String generateIsoSurfaceExample()

This method generates an IsoSurface example scene.

Returns:

the String value of formatted .x3d file name.

generateIsoSurfacePlot

public String generateIsoSurfacePlot()

Generates isosurface plot.

Returns:

The String value of formatted .x3d file name.

generateSLOBChart

public void generateSLOBChart(double bearing,
                              double depth,
                              int counter)

Generates single line of bearing plot.

Parameters:

bearing - The bearing of closest radial blade.

depth - The depths (in KM).

counter - The counter to determine number of image to be created.

generateFullFieldPlot

public String generateFullFieldPlot(double bearing)

Generates full field plot.

Parameters:

bearing - The bearing of closest radial blade.

Returns:

The String value of formatted .x3d file name.

trimToMaxEntrySize

public String[] trimToMaxEntrySize(String[] files)

To keep visualization managable, number of BullsEye plots are limited to amount specified in MAX_ENTRY_SIZE.

Parameters:

files - The array of filenames (sonar model output) to be parsed.

Returns:

The array of filenames limited by max entry size.

getRadialIndex

public int getRadialIndex(double bearing)

Generates radial indices - assumes radials are in order.

Parameters:

bearing - The bearing of closest radial blade.

Returns:

The number of radial indices.

getBlades

public LinkedList[] getBlades()

Returns generated LinkedList.

Returns:

The new generated LinkedList.

generateVRMLBullPlot

public String generateVRMLBullPlot(double depth)

Generates Xj3D-friendly version.

Parameters:

depth - The depths (in KM).

Returns:

The VRML node such as Header, Viewpoints, Transform for the sonar model engine.

getVRMLSLOBChart

public String getVRMLSLOBChart(double bearing,
                               double depth,
                               int counter)

Temporary class generates Xj3D-friendly version single line of bearing plot

Parameters:

bearing - The bearing of closest radial blade.

depth - The depths (in KM).

counter - The counter to determine number of image to be created.

Returns:

The String value of X3D for single line of bearing plot.