org.optimizationservices.oscommon.representationparser
Class OSbLReader

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

public class OSbLReader
extends OSgLReader

The OSbLReader class parses an OSbL 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

OSbLReader()
Default constructor.

OSbLReader(boolean validate)
constructor.

Method Summary

java.lang.String	getBenchmarkMessage() Get the benchmark message.
BenchmarkScores	getBenchmarkScores() Get the benchmark scores.
BenchmarkStatistics	getBenchmarkStatistics() Get the benchmark statistics.
java.util.GregorianCalendar	getBenchmarkTime() Get time of the last benchmark.
OptimizationBenchmark	getOptimizationBenchmark() Get the optimization benchmark information.
OSBenchmark	getOSBenchmark() get the standard OSBenchmark, a local interface for storing Optimization Services benchmark result.
java.lang.String	getOtherBenchmarkDescriptionByName(java.lang.String name) Get the String value from the other benchmark hash map.
java.lang.String[]	getOtherBenchmarkDescriptions() Get the descriptions of all other benchmarks.
java.lang.String[]	getOtherBenchmarkNames() Get the names of all other benchmarks.
int	getOtherBenchmarkNumber() Get the number of other benchmarks.
java.util.HashMap<java.lang.String,java.lang.String>	getOtherBenchmarks() Get the hash map of other benchmarks.
java.lang.String	getOtherBenchmarkValueByName(java.lang.String name) Get the String value from the other benchmark hash map.
java.lang.String[]	getOtherBenchmarkValues() Get the values of all other benchmarks.
java.lang.String	getServiceName() Get the service name.
java.lang.String	getServiceURI() Get the service uri.
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

OSbLReader

public OSbLReader(boolean validate)

constructor.

Parameters:

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

OSbLReader

public OSbLReader()

Default constructor.

Method Detail

getOSBenchmark

public OSBenchmark getOSBenchmark()
                           throws java.lang.Exception

get the standard OSBenchmark, a local interface for storing Optimization Services benchmark result.

Returns:

the OSBenchmark.

Throws:

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

getServiceURI

public java.lang.String getServiceURI()

Get the service uri.

Returns:

the service uri

getServiceName

public java.lang.String getServiceName()

Get the service name.

Returns:

the service name

getBenchmarkTime

public java.util.GregorianCalendar getBenchmarkTime()

Get time of the last benchmark.

Returns:

the time of the last benchmark.

getBenchmarkMessage

public java.lang.String getBenchmarkMessage()

Get the benchmark message.

Returns:

the benchmark message.

getBenchmarkScores

public BenchmarkScores getBenchmarkScores()

Get the benchmark scores.

Returns:

the benchmark scores.

getBenchmarkStatistics

public BenchmarkStatistics getBenchmarkStatistics()

Get the benchmark statistics.

Returns:

the benchmark statistics.

getOptimizationBenchmark

public OptimizationBenchmark getOptimizationBenchmark()

Get the optimization benchmark information.

Returns:

the optimization benchmark information.

getOtherBenchmarks

public java.util.HashMap<java.lang.String,java.lang.String> getOtherBenchmarks()

Get the hash map of other benchmarks.

Returns:

the hash map of other benchmarks.

getOtherBenchmarkNumber

public int getOtherBenchmarkNumber()

Get the number of other benchmarks.

Returns:

the number of other benchmarks.

getOtherBenchmarkValueByName

public java.lang.String getOtherBenchmarkValueByName(java.lang.String name)

Get the String value from the other benchmark hash map.

Parameters:

name - holds the name of benchmark to get.

Returns:

String value from the other benchmark hash map, null if none.

getOtherBenchmarkDescriptionByName

public java.lang.String getOtherBenchmarkDescriptionByName(java.lang.String name)

Get the String value from the other benchmark hash map.

Parameters:

name - holds the name of benchmark to get.

Returns:

String value from the other benchmark hash map, null if none.

getOtherBenchmarkNames

public java.lang.String[] getOtherBenchmarkNames()

Get the names of all other benchmarks.

Returns:

the names of all other benchmarks.

getOtherBenchmarkValues

public java.lang.String[] getOtherBenchmarkValues()

Get the values of all other benchmarks.

Returns:

the values of all other benchmarks.

getOtherBenchmarkDescriptions

public java.lang.String[] getOtherBenchmarkDescriptions()

Get the descriptions of all other benchmarks.

Returns:

the descriptions of all other benchmarks.

main

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

main for test purposes.

Parameters:

argv - command line arguments.