org.protempa.xml

Class XMLConfiguration

java.lang.Object

org.protempa.xml.XMLConfiguration

All Implemented Interfaces:

QueryBuilder

public class XMLConfiguration
extends Object
implements QueryBuilder

This class takes a Protempa configuration information such as a query and generates equivalent XML that conforms to the schema in protempa_query.xsd.

There are two ways to use this class to create queries from XML.

• You can create a query directly from an XML file by calling the static method #readQueryAsXML(File).
• You can instantiate this class and then use its build(KnowledgeSource, AlgorithmSource) method to create a query.

Author:

mgrand

Constructor Summary

Constructors

Constructor and Description
XMLConfiguration(File file) Call this constructor to use this class as a QueryBuilder.

Method Summary

Modifier and Type	Method and Description
Query	build(KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Builds a Query.
static Query	readQueryAsXML(File file, KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Read XML from the specified file that describes a Protempa query and create the query.
static Query	readQueryAsXML(InputStream inputStream, KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Read XML from the specified input stream that describes a Protempa query and create the query.
static Query	readQueryAsXML(Reader reader, KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Read XML from the specified Reader that describes a Protempa query and create the query.
static Query	readQueryAsXML(String str, KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Read XML from the specified string that describes a Protempa query and create the query.
static Query	readQueryAsXML(URL url, KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Read XML from the specified URL that describes a Protempa query and create the query.
static TableDestination	readTableQueryResultsHandlerAsXML(InputStream inputStream, BufferedWriter dataWriter, KnowledgeSource knowledgeSource) Read XML from the specified InputStream that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.
static TableDestination	readTableQueryResultsHandlerAsXML(Reader reader, BufferedWriter dataWriter, KnowledgeSource knowledgeSource) Read XML from the specified Reader that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.
static TableDestination	readTableQueryResultsHandlerAsXML(String str, BufferedWriter dataWriter, KnowledgeSource knowledgeSource) Read XML from the specified string that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.
static TableDestination	readTableQueryResultsHandlerAsXML(URL url, BufferedWriter dataWriter, KnowledgeSource knowledgeSource) Read XML from the specified URL that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.
static TableDestination	readTableQueryResultsHandlerFactoryAsXML(File file, BufferedWriter dataWriter, KnowledgeSource knowledgeSource) Read XML from the specified file that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.
static void	writeQueryAsXML(Query query, File file) Write the given Protempa query to the specified file.
static void	writeQueryAsXML(Query query, File file, boolean surpressSchemaReference) Write the given protempa query to the specified file.
static void	writeQueryAsXML(Query query, Writer writer, boolean surpressSchemaReference) Write the given protempa query to the specified file.
static void	writeTableDestinationAsXML(TableDestination destination, File file, boolean surpressSchemaReference, KnowledgeSource knowledgeSource) Write the given TableDestination query to the specified file.
static void	writeTableDestinationAsXML(TableDestination destination, File file, KnowledgeSource knowledgeSource) Write the given TableDestination query to the specified file.
static void	writeTableDestinationAsXML(TableDestination destination, Writer writer, boolean surpressSchemaReference, KnowledgeSource knowledgeSource) Write the given TableDestination query using the specified Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLConfiguration

public XMLConfiguration(File file)

Call this constructor to use this class as a QueryBuilder.

Parameters:

file - The XML file that contains the query description.

Method Detail

readQueryAsXML

public static Query readQueryAsXML(File file,
                                   KnowledgeSource knowledgeSource,
                                   AlgorithmSource algorithmSource)
                            throws IOException

Read XML from the specified file that describes a Protempa query and create the query.

Parameters:

file - The file to read. The top level element of the XML in the file must be "protempaQuery" and the XML must conform to the Protempa XML schema.

knowledgeSource -

algorithmSource -

Returns:

The described query.

Throws:

IOException - If there is a problem.

readQueryAsXML

public static Query readQueryAsXML(URL url,
                                   KnowledgeSource knowledgeSource,
                                   AlgorithmSource algorithmSource)
                            throws IOException

Read XML from the specified URL that describes a Protempa query and create the query.

Parameters:

url - The url to read. The top level element of the XML must be "protempaQuery" and the XML must conform to the Protempa XML schema.

knowledgeSource -

algorithmSource -

Returns:

The described query.

Throws:

IOException - If there is a problem.

readQueryAsXML

public static Query readQueryAsXML(Reader reader,
                                   KnowledgeSource knowledgeSource,
                                   AlgorithmSource algorithmSource)
                            throws IOException

Read XML from the specified Reader that describes a Protempa query and create the query.

Parameters:

reader - The Reader to read. The top level element of the XML must be "protempaQuery" and the XML must conform to the Protempa XML schema.

knowledgeSource -

algorithmSource -

Returns:

The described query.

Throws:

IOException - If there is a problem.

readQueryAsXML

public static Query readQueryAsXML(InputStream inputStream,
                                   KnowledgeSource knowledgeSource,
                                   AlgorithmSource algorithmSource)
                            throws IOException

Read XML from the specified input stream that describes a Protempa query and create the query.

Parameters:

inputStream - The InputStream to read. The top level element of the XML must be "protempaQuery" and the XML must conform to the Protempa XML schema.

knowledgeSource -

algorithmSource -

Returns:

The described query.

Throws:

IOException - If there is a problem.

readQueryAsXML

public static Query readQueryAsXML(String str,
                                   KnowledgeSource knowledgeSource,
                                   AlgorithmSource algorithmSource)
                            throws IOException

Read XML from the specified string that describes a Protempa query and create the query.

Parameters:

str - The string to read. The top level element of the XML must be "protempaQuery" and the XML must conform to the Protempa XML schema.

knowledgeSource -

algorithmSource -

Returns:

The described query.

Throws:

IOException - If there is a problem.

writeQueryAsXML

public static void writeQueryAsXML(Query query,
                                   File file)
                            throws IOException

Write the given Protempa query to the specified file.

Parameters:

query - The query to be written as XML.

file - The file to write the XML to.

Throws:

IOException - If there is a problem writing the file.

writeQueryAsXML

public static void writeQueryAsXML(Query query,
                                   File file,
                                   boolean surpressSchemaReference)
                            throws IOException

Write the given protempa query to the specified file.

Parameters:

query - The query to be written as XML.

file - The file to write the XML to.

surpressSchemaReference - If true, don't include a reference to the schema in the generated XML file.

Throws:

IOException - If there is a problem writing the file.

writeQueryAsXML

public static void writeQueryAsXML(Query query,
                                   Writer writer,
                                   boolean surpressSchemaReference)
                            throws IOException

Write the given protempa query to the specified file.

Parameters:

query - The query to be written as XML.

writer - The Writer to us to write the XML.

surpressSchemaReference - If true, don't include a reference to the schema in the generated XML file.

Throws:

IOException - If there is a problem writing the file.

readTableQueryResultsHandlerFactoryAsXML

public static TableDestination readTableQueryResultsHandlerFactoryAsXML(File file,
                                                                        BufferedWriter dataWriter,
                                                                        KnowledgeSource knowledgeSource)
                                                                 throws IOException

Read XML from the specified file that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.

Parameters:

file - The file to read. The top level element of the XML in the file must be "tableQueryResultsHandler" and the XML must conform to the Protempa XML schema.

dataWriter - The Writer that the described TableQueryResultsHandler will use to write its output.

Returns:

The described TableQueryResultsHandler.

Throws:

IOException - If there is a problem.

readTableQueryResultsHandlerAsXML

public static TableDestination readTableQueryResultsHandlerAsXML(URL url,
                                                                 BufferedWriter dataWriter,
                                                                 KnowledgeSource knowledgeSource)
                                                          throws IOException

Read XML from the specified URL that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.

Parameters:

url - The URL to read. The top level element of the XML in the file must be "tableQueryResultsHandler" and the XML must conform to the Protempa XML schema.

dataWriter - The Writer that the described TableQueryResultsHandler will use to write its output.

Returns:

The described TableQueryResultsHandler.

Throws:

IOException - If there is a problem.

readTableQueryResultsHandlerAsXML

public static TableDestination readTableQueryResultsHandlerAsXML(Reader reader,
                                                                 BufferedWriter dataWriter,
                                                                 KnowledgeSource knowledgeSource)
                                                          throws IOException

Read XML from the specified Reader that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.

Parameters:

reader - The Reader to read. The top level element of the XML must be "tableQueryResultsHandler" and the XML must conform to the Protempa XML schema.

dataWriter - The Writer that the described TableQueryResultsHandler will use to write its output.

Returns:

The described TableQueryResultsHandler.

Throws:

IOException - If there is a problem.

readTableQueryResultsHandlerAsXML

public static TableDestination readTableQueryResultsHandlerAsXML(InputStream inputStream,
                                                                 BufferedWriter dataWriter,
                                                                 KnowledgeSource knowledgeSource)
                                                          throws IOException

Read XML from the specified InputStream that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.

Parameters:

inputStream - The InputStream to read. The top level element of the XML must be "tableQueryResultsHandler" and the XML must conform to the Protempa XML schema.

dataWriter - The Writer that the described TableQueryResultsHandler will use to write its output.

Returns:

The described TableQueryResultsHandler.

Throws:

IOException - If there is a problem.

readTableQueryResultsHandlerAsXML

public static TableDestination readTableQueryResultsHandlerAsXML(String str,
                                                                 BufferedWriter dataWriter,
                                                                 KnowledgeSource knowledgeSource)
                                                          throws IOException

Read XML from the specified string that describes a Protempa TableQueryResultsHandler and create the TableQueryResultsHandler.

Parameters:

str - The string to read. The top level element of the XML must be "tableQueryResultsHandler" and the XML must conform to the Protempa XML schema.

dataWriter - The Writer that the described TableQueryResultsHandler will use to write its output.

Returns:

The described TableQueryResultsHandler.

Throws:

IOException - If there is a problem.

writeTableDestinationAsXML

public static void writeTableDestinationAsXML(TableDestination destination,
                                              File file,
                                              KnowledgeSource knowledgeSource)
                                       throws IOException

Write the given TableDestination query to the specified file.

Parameters:

destination - The TableDestination to be written as XML.

file - The file to write the XML to.

Throws:

IOException - If there is a problem writing the file.

writeTableDestinationAsXML

public static void writeTableDestinationAsXML(TableDestination destination,
                                              File file,
                                              boolean surpressSchemaReference,
                                              KnowledgeSource knowledgeSource)
                                       throws IOException

Write the given TableDestination query to the specified file.

Parameters:

destination - The TableDestination to be written as XML.

file - The file to write the XML to.

surpressSchemaReference - If true, don't include a reference to the schema in the generated XML file.

Throws:

IOException - If there is a problem writing the file.

writeTableDestinationAsXML

public static void writeTableDestinationAsXML(TableDestination destination,
                                              Writer writer,
                                              boolean surpressSchemaReference,
                                              KnowledgeSource knowledgeSource)
                                       throws IOException

Write the given TableDestination query using the specified Writer.

Parameters:

destination - The TableDestination to be written as XML.

writer - The Writer to us to write the XML.

surpressSchemaReference - If true, don't include a reference to the schema in the generated XML file.

Throws:

IOException - If there is a problem writing the file.

build

public Query build(KnowledgeSource knowledgeSource,
                   AlgorithmSource algorithmSource)
            throws QueryBuildException

Description copied from interface: QueryBuilder

Builds a Query. This method could validate the query specification using the knowledge source and algorithm source.

Specified by:

build in interface QueryBuilder

Parameters:

knowledgeSource - a KnowledgeSource.

algorithmSource - a AlgorithmSource.

Returns:

a Query. Guaranteed not null.

Throws:

QueryBuildException - If the query specification failed validation or some other error occurred.