xal.model.xml

Class ProbeXmlParser

java.lang.Object

xal.model.xml.ProbeXmlParser

public class ProbeXmlParser
extends java.lang.Object

Parses the description of a Probe from an XML file. Returns an instance of the appropriate Probe species. This class simply provides methods for opening an xml document and creating a DataAdaptor for it. It delegates the task of reading the Probe definition and instantiating the Probe to that class.

Constructor Summary

Constructors

Constructor and Description
ProbeXmlParser()

Method Summary

Modifier and Type	Method and Description
static Probe<?>	parse(java.lang.String fileUri) Parse the XML file specified by the supplied URI.
Probe<?>	parseAdaptor(DataAdaptor adaptor) Parse the given data source and build a probe object according to that described.
static Probe<?>	parseDataAdaptor(DataAdaptor adaptor) Parse the given data source and build a probe object according to that described.
Probe<?>	parseProbeFile(java.lang.String fileUri) Parse the XML file specified by the supplied URI.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbeXmlParser

public ProbeXmlParser()

Method Detail

parse

public static Probe<?> parse(java.lang.String fileUri)
                      throws ParsingException

Parse the XML file specified by the supplied URI. Return a Probe of the appropriate species.

Parameters:

fileUri - the URI specifying the XML file to parse

Returns:

the Probe object described by the XML file

Throws:

ParsingException

parseDataAdaptor

public static Probe<?> parseDataAdaptor(DataAdaptor adaptor)
                                 throws ParsingException

Parse the given data source and build a probe object according to that described. Convenience method calling parseAdaptor(DataAdaptor).

Parameters:

adaptor - data source containing probe description

Returns:

new probe object with properties specified by the data source

Throws:

ParsingException - general formating error in the data source

Since:

Apr 14, 2011

parseProbeFile

public Probe<?> parseProbeFile(java.lang.String fileUri)
                        throws ParsingException

Parse the XML file specified by the supplied URI. Return a Probe of the appropriate species.

Parameters:

fileUri - the URI specifying the XML file to parse

Returns:

the Probe object described by the XML file

Throws:

ParsingException

parseAdaptor

public Probe<?> parseAdaptor(DataAdaptor adaptor)
                      throws ParsingException

Parse the given data source and build a probe object according to that described. Calls method Probe.readFrom(DataAdaptor) to do the actual parsing.

Parameters:

adaptor - data source containing probe description

Returns:

new probe object with properties specified by the data source

Throws:

ParsingException - general formating error in the data source

Since:

Apr 14, 2011