org.licas_text.query

Class QueryEngine

java.lang.Object

org.licas_text.query.QueryEngine

Direct Known Subclasses:

PatternQueryEngine, TextLinesEngine

public class QueryEngine
extends java.lang.Object

Base class for query engines that does some common evaluations or parsing.

Author:

Kieran Greer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static boolean	allowsCase(java.lang.String queryType) Return true if the query type allows case sensitive comparisons, that is, not numerical.
static boolean	allowsWildcards(java.lang.String constraintType) Return true if the constraint type can process wildcards.
static boolean	constraintIsAttribute(java.lang.String constraintType) Return true if the constraint type requires a value.
static boolean	constraintNeedsValue(java.lang.String constraintType) Return true if the constraint type requires a value.
static java.util.ArrayList<java.lang.String>	getComparisonOps(boolean equivalenceOnly) Return a list of the comparison operators.
static java.util.ArrayList<java.lang.String>	getConstraintTypes(java.lang.String queryType, java.lang.String queryState, boolean includeWildcards) Get a list of all constraint types for the xml-related queries.
static java.lang.String	getCorrectTextType(java.lang.String queryType, java.lang.String constraintType) Get the correct text type for the constraint.
static java.util.ArrayList<java.lang.String>	getLogicalOps() Return a list of the logical operators.
static java.lang.String	getReciprocalComparison(java.lang.String comparison) Return the reciprocal comparison to the one entered, for example a LT would return a GT.
static java.util.ArrayList<java.lang.String>	getTextTypes() Get a list of all types for the text-related queries.
protected int	getWildcardCount(java.lang.String theChar) Return true number wildcard character characters to remove.
protected boolean	isCurrencyChar(char theChar) Return true if the character represents a currency character.
protected boolean	isEndConstraint(java.lang.String constraintType) Return true if the value is recognised as an end constraint type.
static boolean	isNumericalConstraint(java.lang.String constraintType) Return true if the constraint tye is a numerical constraint.
static boolean	isNumericalQueryType(java.lang.String queryType) Return true if the query type is a numerical type (numerical evaluation).
static boolean	isOtherQueryType(java.lang.String queryType) Return true if the query type is a special type (specific evaluation).
static boolean	isPatternType(java.lang.String constraintType) Return true if the value should be added as part of the pattern.
static boolean	isRangeConstraint(java.lang.String constraintType) Return true if the value is recognised a range constraint type.
static boolean	isSearchType(java.lang.String searchType) Return true if the value is recognised as a search type.
static boolean	isSingleConstraint(java.lang.String constraintType) Return true if the value is recognised a single constraint type.
protected boolean	isStartConstraint(java.lang.String constraintType) Return true if the value is recognised as a start constraint type.
static boolean	isTextQueryType(java.lang.String queryType) Return true if the query type is a text-based type (lines of text).
protected boolean	isWildcard(char theChar) Return true if the character represents a wildcard character.
protected boolean	isWildcard(java.lang.String theChar) Return true if the first character represents a wildcard character.
static boolean	isXmlQueryType(java.lang.String queryType) Return true if the query type is a pattern-based XML type.
protected java.util.ArrayList<java.lang.String>	parseWildcards(java.lang.String searchTerm) Parse the search term and convert into separate parts with wildcards.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryEngine

public QueryEngine()

Create a new instance of QueryEngine.

Method Detail

parseWildcards

protected java.util.ArrayList<java.lang.String> parseWildcards(java.lang.String searchTerm)

Parse the search term and convert into separate parts with wildcards.

Parameters:

searchTerm - the search term.

Returns:

the search term with the wildcard parts as separate elements.

isWildcard

protected boolean isWildcard(char theChar)

Return true if the character represents a wildcard character.

Parameters:

theChar - the character to evaluate.

Returns:

true if a wildcard character.

isWildcard

protected boolean isWildcard(java.lang.String theChar)

Return true if the first character represents a wildcard character.

Parameters:

theChar - the string to evaluate.

Returns:

true if a wildcard character.

getWildcardCount

protected int getWildcardCount(java.lang.String theChar)

Return true number wildcard character characters to remove.

Parameters:

theChar - the string to evaluate.

Returns:

the number of wildcard characters. If 0 then any number.

isXmlQueryType

public static boolean isXmlQueryType(java.lang.String queryType)

Return true if the query type is a pattern-based XML type.

Parameters:

queryType - the query type to check.

Returns:

true if the query type is QueryConst.ASXML.

isTextQueryType

public static boolean isTextQueryType(java.lang.String queryType)

Return true if the query type is a text-based type (lines of text).

Parameters:

queryType - the query type to check.

Returns:

true if the query type is QueryConst.ASTEXT or TEXT.

isNumericalQueryType

public static boolean isNumericalQueryType(java.lang.String queryType)

Return true if the query type is a numerical type (numerical evaluation).

Parameters:

queryType - the query type to check.

Returns:

true if the query type is QueryConst.NUMERICAL, ASMATHCOMPARE, ASMATHEVAL.

isOtherQueryType

public static boolean isOtherQueryType(java.lang.String queryType)

Return true if the query type is a special type (specific evaluation).

Parameters:

queryType - the query type to check.

Returns:

true if the query type is QueryConst.EXISTS, NOTEXISTS, FILENAME.

isPatternType

public static boolean isPatternType(java.lang.String constraintType)

Return true if the value should be added as part of the pattern.

Parameters:

constraintType - the constraint type.

Returns:

true if a search type.

isSearchType

public static boolean isSearchType(java.lang.String searchType)

Return true if the value is recognised as a search type.

Parameters:

searchType - the search type.

Returns:

true if a search type.

isRangeConstraint

public static boolean isRangeConstraint(java.lang.String constraintType)

Return true if the value is recognised a range constraint type.

Parameters:

constraintType - the constraint type.

Returns:

true if a range constraint type.

isSingleConstraint

public static boolean isSingleConstraint(java.lang.String constraintType)

Return true if the value is recognised a single constraint type. This is currently only the QueryConst.EXISTS value.

Parameters:

constraintType - the constraint type.

Returns:

true if a single constraint type.

isNumericalConstraint

public static boolean isNumericalConstraint(java.lang.String constraintType)

Return true if the constraint tye is a numerical constraint.

Parameters:

constraintType - the constraint type.

Returns:

true if it is a numerical constraint.

isStartConstraint

protected boolean isStartConstraint(java.lang.String constraintType)

Return true if the value is recognised as a start constraint type.

Parameters:

constraintType - the constraint type.

Returns:

true if a start constraint type.

isEndConstraint

protected boolean isEndConstraint(java.lang.String constraintType)

Return true if the value is recognised as an end constraint type.

Parameters:

constraintType - the constraint type.

Returns:

true if an end constraint type.

isCurrencyChar

protected boolean isCurrencyChar(char theChar)

Return true if the character represents a currency character.

Parameters:

theChar - the character to evaluate.

Returns:

true if a currency character.

allowsCase

public static boolean allowsCase(java.lang.String queryType)

Return true if the query type allows case sensitive comparisons, that is, not numerical.

Parameters:

queryType - the query type.

Returns:

true if the query type can make case sensitive comparisons.

allowsWildcards

public static boolean allowsWildcards(java.lang.String constraintType)

Return true if the constraint type can process wildcards.

Parameters:

constraintType - the constraint type.

Returns:

true if the constraint type can process wildcards.

constraintNeedsValue

public static boolean constraintNeedsValue(java.lang.String constraintType)

Return true if the constraint type requires a value.

Parameters:

constraintType - the constraint type.

Returns:

true if a value is required.

constraintIsAttribute

public static boolean constraintIsAttribute(java.lang.String constraintType)

Return true if the constraint type requires a value.

Parameters:

constraintType - the constraint type.

Returns:

true if a value is required.

getCorrectTextType

public static java.lang.String getCorrectTextType(java.lang.String queryType,
                                                  java.lang.String constraintType)

Get the correct text type for the constraint. Can be text lines (TEXT) or pattern-based text (ASTEXT).

Parameters:

queryType - the current type. Might not be changed.

constraintType - the constraint type.

Returns:

true if a value is required.

getConstraintTypes

public static java.util.ArrayList<java.lang.String> getConstraintTypes(java.lang.String queryType,
                                                                       java.lang.String queryState,
                                                                       boolean includeWildcards)

Get a list of all constraint types for the xml-related queries.

Parameters:

queryType - the type of query - ASTEXT, ASXML, NUMERICAL or HIGHLIGHT. If set to null, then the most basic text comparison set is returned, without any of the new options of this package.

queryState - the current construction state of the query. Can be null.

includeWildcards - true if wildcard characters are included.

Returns:

a list of all constraint types.

getTextTypes

public static java.util.ArrayList<java.lang.String> getTextTypes()

Get a list of all types for the text-related queries.

Returns:

a list of all and-or types.

getComparisonOps

public static java.util.ArrayList<java.lang.String> getComparisonOps(boolean equivalenceOnly)

Return a list of the comparison operators.

Parameters:

equivalenceOnly - true if return the equivalence operator only.

Returns:

the comparison operators.

getLogicalOps

public static java.util.ArrayList<java.lang.String> getLogicalOps()

Return a list of the logical operators.

Returns:

the logical operators.

getReciprocalComparison

public static java.lang.String getReciprocalComparison(java.lang.String comparison)

Return the reciprocal comparison to the one entered, for example a LT would return a GT.

Parameters:

comparison - the comparison operator.

Returns:

the reciprocal.