org.licas_text.parser

Class QueryParser

java.lang.Object

org.licas_text.parser.QueryParser

All Implemented Interfaces:

org.ai_heuristic.def.ParserDef

public class QueryParser
extends java.lang.Object
implements org.ai_heuristic.def.ParserDef

This class can be used to parse an XML-based query description to or from the default QueryModel model type. This can parse both text-based or XML-based queries.

Author:

Kieran Greer

Constructor Summary

Constructors

Constructor and Description
QueryParser() Create a new instance of QueryParser

Method Summary

Modifier and Type	Method and Description
java.lang.Object	parse(org.licas_xml.abs.Element toParse) Parse the XML element back into the appropriate Object.
java.util.ArrayList	parseList(org.licas_xml.abs.Element toParse) Parse the XML element back into the appropriate Object.
org.licas_xml.abs.Element	serialize(int index, QueryModel queryModel, boolean forDisplay) Serialize the object into an XML element.
org.licas_xml.abs.Element	serialize(java.lang.Object queryModel) Serialize the object into an XML element.
org.licas_xml.abs.Element	serializeList(java.util.ArrayList queryList) Serialize the query list into an XML element.
void	serializePatternConstraints(int index, PatternElement pattern, org.licas_xml.abs.Element rootElem) Serialize the pattern element valueConstraints into an XML element.
void	serializePatternElement(int index, PatternElement pattern, org.licas_xml.abs.Element rootElem, org.licas_xml.abs.Element constraintElem) Serialize the pattern element into an XML element.
java.lang.String	toStringDescription(int index, QueryModel queryModel) Serialize the object into a string-based description only.
static org.licas_xml.abs.Element	uriListToXml(java.lang.String fileType, java.util.ArrayList uriList) Convert the query file path list into an xml description for adding to the root model element.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParser

public QueryParser()

Create a new instance of QueryParser

Method Detail

serializeList

public org.licas_xml.abs.Element serializeList(java.util.ArrayList queryList)
                                        throws java.lang.Exception

Serialize the query list into an XML element.

Parameters:

queryList - a list of QueryModel objects.

Returns:

the serialized object list - query models as first child elements.

Throws:

java.lang.Exception - any error.

serialize

public org.licas_xml.abs.Element serialize(java.lang.Object queryModel)
                                    throws java.lang.Exception

Serialize the object into an XML element.

Specified by:

serialize in interface org.ai_heuristic.def.ParserDef

Parameters:

queryModel - the query model to serialize.

Returns:

the serialized object.

Throws:

java.lang.Exception - any error.

serialize

public org.licas_xml.abs.Element serialize(int index,
                                           QueryModel queryModel,
                                           boolean forDisplay)
                                    throws java.lang.Exception

Serialize the object into an XML element.

Parameters:

index - the pattern index. Used for an ID marker only.

queryModel - the query model to serialize.

forDisplay - if true for display only, if false then for data transfer.

Returns:

the serialized object.

Throws:

java.lang.Exception - any error.

serializePatternElement

public void serializePatternElement(int index,
                                    PatternElement pattern,
                                    org.licas_xml.abs.Element rootElem,
                                    org.licas_xml.abs.Element constraintElem)
                             throws java.lang.Exception

Serialize the pattern element into an XML element.

Parameters:

index - the pattern index. Used for an ID marker only.

pattern - the pattern element to serialize.

rootElem - the root element to add to.

constraintElem - the element to add the valueConstraints description to.

Throws:

java.lang.Exception - any error.

serializePatternConstraints

public void serializePatternConstraints(int index,
                                        PatternElement pattern,
                                        org.licas_xml.abs.Element rootElem)
                                 throws java.lang.Exception

Serialize the pattern element valueConstraints into an XML element.

Parameters:

index - the pattern index. Used for an ID marker only.

pattern - the pattern element to serialize.

rootElem - the root element to add to.

Throws:

java.lang.Exception - any error.

parseList

public java.util.ArrayList parseList(org.licas_xml.abs.Element toParse)
                              throws java.lang.Exception

Parse the XML element back into the appropriate Object.

Parameters:

toParse - the element to parse. This should contain mediate child elements that are of type QueryConst.QUERYMODEL, where they are all parsed and added to a vector list.

Returns:

the parsed query model, as a list of QueryModel objects.

Throws:

java.lang.Exception - any error.

parse

public java.lang.Object parse(org.licas_xml.abs.Element toParse)
                       throws java.lang.Exception

Parse the XML element back into the appropriate Object.

Specified by:

parse in interface org.ai_heuristic.def.ParserDef

Parameters:

toParse - the element to parse. This should be of type QueryConst.QUERYMODEL.

Returns:

the parsed query model, of type QueryModel.

Throws:

java.lang.Exception - any error.

toStringDescription

public java.lang.String toStringDescription(int index,
                                            QueryModel queryModel)
                                     throws java.lang.Exception

Serialize the object into a string-based description only.

Parameters:

index - the pattern index. Used for an ID marker only.

queryModel - the query model to serialize.

Returns:

a string-based description of the query, for display purposes only.

Throws:

java.lang.Exception - any error.

uriListToXml

public static org.licas_xml.abs.Element uriListToXml(java.lang.String fileType,
                                                     java.util.ArrayList uriList)

Convert the query file path list into an xml description for adding to the root model element.

Parameters:

fileType - the file type, if known.

uriList - list of URIs or file paths.

Returns:

the list description, including file type if not null.