org.licas_text.query

Class PatternQueryEngine

java.lang.Object

org.licas_text.query.QueryEngine

org.licas_text.query.PatternQueryEngine

public class PatternQueryEngine
extends QueryEngine

This class can be used to match xml-based patterns with additional conditions over an xml-based document or text, to retrieve the matched or related text areas. This processes a QueryModel and relates specifically to a search-style query to find content that matches the desired query pattern and conditions. To be recognised by the default classes, the root request element should have the tag entity of QueryConst.QUERYMODEL, or 'Query_Model'. This should then contain the element pattern to match. This pattern can have certain constraints associated with each element in the pattern. The documentation describes the query structure in more detail.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	lineIndex Search marker

Constructor Summary

Constructors

Constructor and Description
PatternQueryEngine() Create a new instance of PatternQueryEngine.

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<java.lang.String>	getHashCodes(java.util.ArrayList<java.util.ArrayList<org.licas_xml.abs.Element>> elementList) Get the list of hash codes that map to elements in the document.
static java.util.ArrayList<java.lang.Integer>	hashCodeIndexes(org.licas_xml.abs.Element doc, java.util.ArrayList<java.lang.String> matchTo) Traverse the document and match the hash codes in the matchTo list to it and stores the matched element indexes.
protected java.util.ArrayList<java.util.ArrayList<org.licas_xml.abs.Element>>	metaSearchXml(org.licas_xml.abs.Element textToSearch, QueryModel queryModel) Query the xml-based text to find matching information.

Methods inherited from class org.licas_text.query.QueryEngine

allowsCase, allowsWildcards, constraintIsAttribute, constraintNeedsValue, getComparisonOps, getConstraintTypes, getCorrectTextType, getLogicalOps, getReciprocalComparison, getTextTypes, getWildcardCount, isCurrencyChar, isEndConstraint, isNumericalConstraint, isNumericalQueryType, isOtherQueryType, isPatternType, isRangeConstraint, isSearchType, isSingleConstraint, isStartConstraint, isTextQueryType, isWildcard, isWildcard, isXmlQueryType, parseWildcards

Methods inherited from class java.lang.Object

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

Field Detail

lineIndex

protected static int lineIndex

Search marker

Constructor Detail

PatternQueryEngine

public PatternQueryEngine()

Create a new instance of PatternQueryEngine. Can process XML-based content.

Method Detail

metaSearchXml

protected java.util.ArrayList<java.util.ArrayList<org.licas_xml.abs.Element>> metaSearchXml(org.licas_xml.abs.Element textToSearch,
                                                                                            QueryModel queryModel)
                                                                                     throws java.lang.Exception

Query the xml-based text to find matching information.

Parameters:

textToSearch - the xml-based text to search over.

queryModel - the query model.

Returns:

any suitable matches to the request. These are element parts that match the whole query pattern.

Throws:

java.lang.Exception - any error.

getHashCodes

public static java.util.ArrayList<java.lang.String> getHashCodes(java.util.ArrayList<java.util.ArrayList<org.licas_xml.abs.Element>> elementList)

Get the list of hash codes that map to elements in the document.

Parameters:

elementList - a list of elements.

Returns:

the list of element hash codes.

hashCodeIndexes

public static java.util.ArrayList<java.lang.Integer> hashCodeIndexes(org.licas_xml.abs.Element doc,
                                                                     java.util.ArrayList<java.lang.String> matchTo)
                                                              throws java.lang.Exception

Traverse the document and match the hash codes in the matchTo list to it and stores the matched element indexes.

Parameters:

doc - the root element of the main document.

matchTo - a list of element hash codes to match to.

Returns:

the list of line indexes relating to the matched elements.

Throws:

java.lang.Exception - any error.