org.optimizationservices.oscommon.representationparser
Class OSqLReader

java.lang.Object
  org.optimizationservices.oscommon.representationparser.OSgLReader
      org.optimizationservices.oscommon.representationparser.OSqLReader

public class OSqLReader
extends OSgLReader

The OSqLReader class parses an OSqL instance into a DOM tree and provides a set of "get" methods that can be used to retrieve different pieces of information of the instance.

Since:

OS 1.0

Version:

1.0, 03/14/2004

Author:

Robert Fourer, Jun Ma, Kipp Martin

Field Summary

Fields inherited from class org.optimizationservices.oscommon.representationparser.OSgLReader

m_document

Constructor Summary

OSqLReader()
Default constructor.

OSqLReader(boolean validate)
constructor.

Method Summary

OSQuery	getOSQuery() get the standard OSQuery, a local interface for storing Optimization Services query.
StandardQuery	getStandardQuery() get the standard query data structure.
java.lang.String	getXQuery() Get the xQuery in a string.
static void	main(java.lang.String[] argv) main for test purposes.

Methods inherited from class org.optimizationservices.oscommon.representationparser.OSgLReader

getDocument, getRootElement, isValidate, readFile, readString, setDocument, setRootElement, setValidate, writeToFile, writeToSring, writeToStandardOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

OSqLReader

public OSqLReader(boolean validate)

constructor.

Parameters:

validate - holds whether the reader should be validating against the schema or not.

OSqLReader

public OSqLReader()

Default constructor.

Method Detail

getOSQuery

public OSQuery getOSQuery()
                   throws java.lang.Exception

get the standard OSQuery, a local interface for storing Optimization Services query.

Returns:

the OSQuery.

Throws:

java.lang.Exception - if there are errors getting the OSQuery.

getStandardQuery

public StandardQuery getStandardQuery()

get the standard query data structure.

Returns:

standard query in the StandardQuery data structure; null if none.

See Also:

StandardQuery

getXQuery

public java.lang.String getXQuery()

Get the xQuery in a string.

Returns:

the xQuery, null or empty string if none.

main

public static void main(java.lang.String[] argv)

main for test purposes.

Parameters:

argv - command line arguments.