Package xal.model.xml

Class LatticeXmlParser

java.lang.Object

xal.model.xml.LatticeXmlParser

public class LatticeXmlParser
extends Object

Utility class for building an XAL Model Lattice from a corresponding XML file.

Author:

Christopher Allen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_AUTH
static final String	ATTR_DATE
static final String	ATTR_ID
static final String	ATTR_LEN
static final String	ATTR_NAME
static final String	ATTR_SEP
static final String	ATTR_TEXT
static final String	ATTR_TYPE
static final String	ATTR_VAL
static final String	ATTR_VER
static final String	ELEM_COMM
static final String	ELEM_ELEM
static final String	ELEM_LATT	Attributes for XAL/MODEL/LATTICE DTD
static final String	ELEM_PARAM
static final String	ELEM_SEQ

Constructor Summary

Constructors

Constructor	Description
LatticeXmlParser()

Method Summary

Modifier and Type	Method	Description
protected static void	addParameter(DataAdaptor dapt, String strName, String strType, String strValue)	Add a parameter child to a DataAdaptor
protected String	attrValue(DataAdaptor dapt, String strAttrName)	Returns the attribute value string from a DataAdaptor interface.
protected String	buildComment(DataAdaptor daptComm)	Return the comment string from a comment element within a sequence.
protected IElement	buildElement(DataAdaptor daptElem)	Build a IElement object according to parameters specified in a data adaptor.
protected ElementSeq	buildSequence(DataAdaptor daptSeq)	Build a sequence with its elements from a data source represented by a DataAdaptor interface.
protected void	loadComposite(IComposite secNew, DataAdaptor daptSeq)	Load an ElementSeq object with it's components
protected void	loadElement(IElement elem, DataAdaptor daptElem)	Load an IElement object with its parameters specified in the data adaptor.
static Lattice	parse(String fileUri, boolean bolValidate)	Parses the XML file specified by the supplied URI.
Lattice	parseAdaptor(DataAdaptor adaptor)	Parses the given data source for modeling lattice information and creates the corresponding lattice.
static Lattice	parseDataAdaptor(DataAdaptor adaptor)	Parses the supplied DataAdaptor and return a Lattice object configured according to the Adaptor.
Lattice	parseUrl(String strFile, boolean bolValidate)	Parse an XAL Model lattice file and build the corresponding Lattice object.

Methods inherited from class java.lang.Object

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

Field Details

ELEM_LATT

public static final String ELEM_LATT

Attributes for XAL/MODEL/LATTICE DTD

See Also:

• Constant Field Values

ELEM_SEQ

public static final String ELEM_SEQ

See Also:

• Constant Field Values

ELEM_ELEM

public static final String ELEM_ELEM

See Also:

• Constant Field Values

ELEM_PARAM

public static final String ELEM_PARAM

See Also:

• Constant Field Values

ELEM_COMM

public static final String ELEM_COMM

See Also:

• Constant Field Values

ATTR_ID

public static final String ATTR_ID

See Also:

• Constant Field Values

ATTR_LEN

public static final String ATTR_LEN

See Also:

• Constant Field Values

ATTR_VER

public static final String ATTR_VER

See Also:

• Constant Field Values

ATTR_AUTH

public static final String ATTR_AUTH

See Also:

• Constant Field Values

ATTR_DATE

public static final String ATTR_DATE

See Also:

• Constant Field Values

ATTR_TEXT

public static final String ATTR_TEXT

See Also:

• Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

See Also:

• Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

• Constant Field Values

ATTR_VAL

public static final String ATTR_VAL

See Also:

• Constant Field Values

ATTR_SEP

public static final String ATTR_SEP

See Also:

• Constant Field Values

Constructor Details

LatticeXmlParser

public LatticeXmlParser()

Method Details

parse

public static Lattice parse(String fileUri,
 boolean bolValidate)
                     throws ParsingException

Parses the XML file specified by the supplied URI. Return a Lattice object configured according to the file.

Parameters:

fileUri - the URI specifying the XML file to parse

bolValidate - apply XML DTD validation

Returns:

the lattice object described by the XML file

Throws:

ParsingException - An exception was encountered in parsing

parseDataAdaptor

public static Lattice parseDataAdaptor(DataAdaptor adaptor)
                                throws ParsingException

Parses the supplied DataAdaptor and return a Lattice object configured according to the Adaptor.

Parameters:

adaptor - the DataAdaptor containing the Lattice definition

Returns:

the lattice object described by the XML file

Throws:

ParsingException - An exception was encountered in parsing

parseUrl

public Lattice parseUrl(String strFile,
 boolean bolValidate)
                 throws ParsingException

Parse an XAL Model lattice file and build the corresponding Lattice object. The lattice file can be validated by setting the DTD validation flag. The file indicated must be a properly formated XML file.

Parameters:

strFile - URL of lattice description file

bolValidate - apply XML DTD validation

Returns:

Lattice object built according to file contents

Throws:

ParsingException - An exception was encountered in parsing

parseAdaptor

public Lattice parseAdaptor(DataAdaptor adaptor)
                     throws ParsingException

Parses the given data source for modeling lattice information and creates the corresponding lattice.

Parameters:

adaptor - data source containing the modeling lattice

Returns:

model lattice object created from the given data source

Throws:

ParsingException - general format exception

Since:

Apr 13, 2011

buildSequence

protected ElementSeq buildSequence(DataAdaptor daptSeq)
                            throws DataFormatException,
NumberFormatException,
ClassNotFoundException,
InstantiationException,
NoSuchMethodException

Build a sequence with its elements from a data source represented by a DataAdaptor interface. The data adaptor should be configured according to the XAL_MODEL.DTD definition. Therefore, the elements and sub-sequences contained in this sequence need to be represented as child adaptors.

Parameters:

daptSeq - data source containing sequence structure

Returns:

new ElementSeq object built according to data adaptor

Throws:

DataFormatException - data does not conform to XAL_MODEL.DTD specification

NumberFormatException - numeric parameter is malformed and unparsable

ClassNotFoundException - an unknown Element type was encountered

InstantiationException - unable to instantiate an IElement instance

NoSuchMethodException - unknown or invalid Parameter for an Element was encountered

buildComment

protected String buildComment(DataAdaptor daptComm)

Return the comment string from a comment element within a sequence.

Parameters:

daptComm - data adaptor containing comment element

Returns:

comment string

Throws:

MissingDataException - an attribute was missing from the comment

buildElement

protected IElement buildElement(DataAdaptor daptElem)
                         throws InstantiationException,
ClassNotFoundException,
DataFormatException,
NoSuchMethodException

Build a IElement object according to parameters specified in a data adaptor.

Parameters:

daptElem - data adaptor containing element parameters

Returns:

new IElement instance specified by the data adaptor

Throws:

InstantiationException - unable to instantiate an IElement instance

ClassNotFoundException - an unknown IElement type was encountered

DataFormatException - bad parameter format encountered

NoSuchMethodException - unknown or invalid Parameter for an IElement was encountered

loadComposite

protected void loadComposite(IComposite secNew,
 DataAdaptor daptSeq)
                      throws DataFormatException,
NumberFormatException,
ClassNotFoundException,
NoSuchMethodException,
InstantiationException

Load an ElementSeq object with it's components

Parameters:

secNew - ElementSeq object to be loaded

daptSeq - data adaptor containing sequence information

Throws:

ClassNotFoundException - an unknown Element type was encountered

DataFormatException - bad parameter format

NumberFormatException - bad number format in parameter value

NoSuchMethodException - unknown or invalid Parameter for an Element was encountered

InstantiationException

loadElement

protected void loadElement(IElement elem,
 DataAdaptor daptElem)
                    throws DataFormatException,
NoSuchMethodException,
NumberFormatException

Load an IElement object with its parameters specified in the data adaptor.

Parameters:

elem - IElement object to have parameter assigned

daptElem - data adaptor containing all parameter information for element

Throws:

DataFormatException - bad parameter format

NumberFormatException - numeric value was malformed and unparseable

NoSuchMethodException - unknown or invalid Parameter for an Element was encountered

attrValue

protected String attrValue(DataAdaptor dapt,
 String strAttrName)
                    throws MissingDataException

Returns the attribute value string from a DataAdaptor interface. Performs error checking in that a MissingDataException is thrown if attribute does not exist.

Parameters:

strAttrName - attribute name

Returns:

string value of attribute

Throws:

MissingDataException - specified attribute not present in DataAdaptor

addParameter

protected static void addParameter(DataAdaptor dapt,
 String strName,
 String strType,
 String strValue)

Add a parameter child to a DataAdaptor