org.licas_text.query.model

Class QueryModel

java.lang.Object

org.licas_text.query.model.QueryModel

Direct Known Subclasses:

QueryModelText, QueryModelXml

public abstract class QueryModel
extends java.lang.Object

Base class for the different query model types. The model can include both a pattern part and a conditions or constraints part. It can be used to process both text or XML however and so both parts might not always be included in the processing. Text-based would typically consider all text lines without any pattern part.

The model can store different types of query, for example QueryConst.ASXML, TEXT, ASTEXT, NUMERICAL, ASMATHCOMPARE, ASMATHEVAL or even the special cases, such as EXISTS. The default is ASXML, which is a query over XML documents. TEXT, ASTEXT or NUMERICAL are over lines of text, or word tokens in lines of text. The others are special types of case that might include a mathematical evaluator.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	fileList List of files or addresses to retrieve information from
protected java.lang.String	fileType Type of file to read.
protected org.licas_xml.abs.Element	otherMeta A slot for any other metadata that might be passed.
protected java.util.ArrayList<PatternElement>	pattern The pattern to match.
protected java.lang.String	queryID Unique ID to define the query
protected java.lang.String	queryType Defines a search over text or XML elements, or a mathematical operation.
protected PatternElement	selectedPattern A pattern selected as part of some process

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryModel() Create a new instance of QueryModel

Method Summary

Modifier and Type	Method and Description
java.lang.String	constraintValues() Get a full list of constraint values, concatenated with AND.
static QueryModelText	createAsTextModel() Create a as text query model instance.
static QueryModel	createModel(java.lang.String queryType) Create a query model instance.
static QueryModelNumerical	createNumericalModel() Create a numerical query model instance.
static QueryModelText	createTextModel() Create a text query model instance.
static QueryModelXml	createXmlModel() Create an xml query model instance.
PatternConstraint	firstConstraint() Get the first listed constraint in the first listed pattern.
java.lang.String	firstConstraintType() Get the first listed constraint type, in case a special query type.
PatternElement	firstPattern() Get the first pattern in a possible list of patterns.
static QueryModel	fromXml(org.licas_xml.abs.Element queryXml) Utility method to parse the query description into a query model.
java.util.ArrayList<java.lang.String>	getFileList() Get the list of file addresses that the query would be executed over.
java.lang.String	getFileType() Get the value indicating the type of file the file list references.
org.licas_xml.abs.Element	getOtherMeta() Get the other metadata value.
PatternElement	getPatternNestedAt(int index) Get the pattern at the specified index.
java.lang.String	getQueryID() Get the unique query value.
java.util.ArrayList<PatternElement>	getQueryPattern() Get the query pattern that must be matched.
java.lang.String	getQueryType() Get the value indicating to search over text, xml, or a mathematical operation, specified by QueryConst.ASTEXT, etc.
int	getTotalNestedPatternCount(PatternElement pattern) Get a count of the total number of nested patterns, not including the parameter.
int	getTotalPatternCount() Get a count of the total number of patterns, including nested ones.
boolean	isNumericalQuery() Return true if the query type is a numerical type (numerical evaluation).
boolean	isOtherQuery() Return true if the query type is a special type (specific evaluation).
boolean	isTextQuery() Return true if the query type is a text-based type (lines of text).
boolean	isXmlQuery() Return true if the query type is a pattern-based XML type.
boolean	patternToNested(int index) Move the pattern at the specified overall index to a child of its immediate sibling pattern.
boolean	printPatternType() Return true if this model should print out the pattern section.
boolean	removePatternNestedAt(int index) Remove the pattern at the specified index.
void	setFileList(java.util.ArrayList<java.lang.String> theFileList) Set the list of file addresses that the query would be executed over.
void	setFileType(java.lang.String theFileType) Set the value indicating the type of file the file list references.
void	setOtherMeta(org.licas_xml.abs.Element theOtherMeta) Set the other metadata value.
void	setQueryID(java.lang.String theQueryID) Set the unique query ID value.
void	setQueryPattern(java.util.ArrayList<PatternElement> thePattern) Set the query pattern to try to match.
void	setQueryType(java.lang.String theQueryType) Set the value indicating to search over text, xml, or a mathematical operation.
void	setSingleCondition(PatternConstraint newConstraint) Set the pattern element that is the single query condition.
void	setSingleCondition(java.lang.String operator, java.lang.String value) This method can be used to set a single query condition in an empty (this) query model.
void	setSingleCondition(java.lang.String type, java.lang.String operator, java.lang.String value) This method can be used to set a single query condition in an empty (this) query model.
static org.licas_xml.abs.Element	toXml(QueryModel queryModel) Utility method to convert the query model into the XML-based description.
static java.lang.String	typeFromOpOther(java.lang.String operator) Get the likely 'other' query type for the query operator or condition.
static java.lang.String	typeFromOpText(java.lang.String operator) Get the likely 'text' query type for the query operator or condition.

Methods inherited from class java.lang.Object

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

Field Detail

queryType

protected java.lang.String queryType

Defines a search over text or XML elements, or a mathematical operation. For example QueryConst.ASXML, TEXT, ASTEXT, NUMERICAL, ASMATHCOMPARE, ASMATHEVAL or even the special cases, such as EXISTS.

queryID

protected java.lang.String queryID

Unique ID to define the query

fileType

protected java.lang.String fileType

Type of file to read. Optional, for when using a list of file paths.

fileList

protected java.util.ArrayList<java.lang.String> fileList

List of files or addresses to retrieve information from

pattern

protected java.util.ArrayList<PatternElement> pattern

The pattern to match. This is a list of element names to match in order. Each entry is of type PatternElement.

selectedPattern

protected PatternElement selectedPattern

A pattern selected as part of some process

otherMeta

protected org.licas_xml.abs.Element otherMeta

A slot for any other metadata that might be passed. Linking options, for example.

Constructor Detail

QueryModel

protected QueryModel()

Create a new instance of QueryModel

Method Detail

isXmlQuery

public boolean isXmlQuery()

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

Returns:

true if the query type is QueryConst.ASXML.

isTextQuery

public boolean isTextQuery()

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

Returns:

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

isNumericalQuery

public boolean isNumericalQuery()

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

Returns:

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

isOtherQuery

public boolean isOtherQuery()

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

Returns:

true if the query type is QueryConst.EXISTS.

setQueryType

public void setQueryType(java.lang.String theQueryType)

Set the value indicating to search over text, xml, or a mathematical operation.

Parameters:

theQueryType - can be QueryConst.ASTEXT, etc. Default value is as ASXML.

getQueryType

public java.lang.String getQueryType()

Get the value indicating to search over text, xml, or a mathematical operation, specified by QueryConst.ASTEXT, etc.

Returns:

the value of queryType.

setQueryID

public void setQueryID(java.lang.String theQueryID)

Set the unique query ID value.

Parameters:

theQueryID - a unique value to define the query.

getQueryID

public java.lang.String getQueryID()

Get the unique query value.

Returns:

the value of queryID.

setFileType

public void setFileType(java.lang.String theFileType)

Set the value indicating the type of file the file list references.

Parameters:

theFileType - the file type.

getFileType

public java.lang.String getFileType()

Get the value indicating the type of file the file list references.

Returns:

the value of fileType.

setFileList

public void setFileList(java.util.ArrayList<java.lang.String> theFileList)

Set the list of file addresses that the query would be executed over. The files are not read automatically and so this is just a placeholder to store addresses.

Parameters:

theFileList - list of file or URI addresses, for example.

getFileList

public java.util.ArrayList<java.lang.String> getFileList()

Get the list of file addresses that the query would be executed over. The files are not read automatically and so this is just a placeholder to store addresses.

Returns:

the value of fileList.

setSingleCondition

public void setSingleCondition(java.lang.String operator,
                               java.lang.String value)

This method can be used to set a single query condition in an empty (this) query model. The condition type is set to the model type (default setup).

Parameters:

operator - the comparison operator or evaluation condition.

value - the value to compare with.

setSingleCondition

public void setSingleCondition(java.lang.String type,
                               java.lang.String operator,
                               java.lang.String value)

This method can be used to set a single query condition in an empty (this) query model.

Parameters:

type - this can be different to the model type, for a server file search, for example.

operator - the comparison operator or evaluation condition.

value - the value to compare with.

setSingleCondition

public void setSingleCondition(PatternConstraint newConstraint)

Set the pattern element that is the single query condition.

Parameters:

newConstraint - the new constraint to use.

firstPattern

public PatternElement firstPattern()

Get the first pattern in a possible list of patterns.

Returns:

the first listed pattern, or null if no patterns.

firstConstraint

public PatternConstraint firstConstraint()

Get the first listed constraint in the first listed pattern.

Returns:

the first listed constraint, or null if no value constraints.

firstConstraintType

public java.lang.String firstConstraintType()

Get the first listed constraint type, in case a special query type.

Returns:

the first listed constraint type, or null if no value constraints.

patternToNested

public boolean patternToNested(int index)

Move the pattern at the specified overall index to a child of its immediate sibling pattern.

Parameters:

index - the pattern index - including all nested patterns of all previous pattern sets.

Returns:

true if the pattern was successfully moved, false otherwise.

getTotalPatternCount

public int getTotalPatternCount()

Get a count of the total number of patterns, including nested ones.

Returns:

a count of the total number of patterns.

getTotalNestedPatternCount

public int getTotalNestedPatternCount(PatternElement pattern)

Get a count of the total number of nested patterns, not including the parameter.

Parameters:

pattern - the pattern to count from.

Returns:

a count of the total number of patterns.

getPatternNestedAt

public PatternElement getPatternNestedAt(int index)

Get the pattern at the specified index. Include nested patterns in the traversal process. The index count starts at 0, but you should start nesting with the furthest pattern first for best results.

Parameters:

index - the index of the pattern as it would be shown over all patterns.

Returns:

the pattern at the specified index, or null if the index is incorrect.

removePatternNestedAt

public boolean removePatternNestedAt(int index)

Remove the pattern at the specified index. Include nested patterns in the traversal process. Traverse all patterns in order, including nested ones.

Parameters:

index - the index of the pattern as it would be drawn.

Returns:

true if the pattern was found, false otherwise.

setQueryPattern

public void setQueryPattern(java.util.ArrayList<PatternElement> thePattern)

Set the query pattern to try to match.

Parameters:

thePattern - the ordered list of element names to match to.

getQueryPattern

public java.util.ArrayList<PatternElement> getQueryPattern()

Get the query pattern that must be matched.

Returns:

the value of pattern.

setOtherMeta

public void setOtherMeta(org.licas_xml.abs.Element theOtherMeta)

Set the other metadata value. The root element must have a MetaConst.META (Meta) tag name.

Parameters:

theOtherMeta - and other metadata.

getOtherMeta

public org.licas_xml.abs.Element getOtherMeta()

Get the other metadata value. This should have a root element tag name of MetaConst.META (Meta).

Returns:

the value of otherMeta.

constraintValues

public java.lang.String constraintValues()

Get a full list of constraint values, concatenated with AND.

Returns:

a description of the full list of constraint values.

printPatternType

public boolean printPatternType()

Return true if this model should print out the pattern section.

Returns:

true a parsed version of this model should print out the pattern section.

typeFromOpText

public static java.lang.String typeFromOpText(java.lang.String operator)

Get the likely 'text' query type for the query operator or condition. Note that there is overlap with XML queries, which can also evaluate text and numbers.

Parameters:

operator - the comparison operator or evaluation condition.

Returns:

the likely query type, or null if not recognised.

typeFromOpOther

public static java.lang.String typeFromOpOther(java.lang.String operator)

Get the likely 'other' query type for the query operator or condition. These queries maybe search for a filename or folder, or exists, etc and do not fall under the category of a general text comparison.

Parameters:

operator - the comparison operator or evaluation condition.

Returns:

the likely query type, or null if not recognised.

createModel

public static QueryModel createModel(java.lang.String queryType)

Create a query model instance.

Parameters:

queryType - the type of model to create, xml, text, numerical, other.

Returns:

instance of the related query model type. If not recognised, then return the ASTEXT query model type.

createXmlModel

public static QueryModelXml createXmlModel()

Create an xml query model instance.

Returns:

instance of the related query model type.

createTextModel

public static QueryModelText createTextModel()

Create a text query model instance.

Returns:

instance of the related query model type.

createAsTextModel

public static QueryModelText createAsTextModel()

Create a as text query model instance. This may perform some type of rule or range processing, not a typical word or line matching.

Returns:

instance of the related query model type.

createNumericalModel

public static QueryModelNumerical createNumericalModel()

Create a numerical query model instance.

Returns:

instance of the related query model type.

fromXml

public static QueryModel fromXml(org.licas_xml.abs.Element queryXml)
                          throws java.lang.Exception

Utility method to parse the query description into a query model. Can also use QueryParser for this.

Parameters:

queryXml - the query description to parse.

Returns:

the constructed query model.

Throws:

java.lang.Exception - any error.

toXml

public static org.licas_xml.abs.Element toXml(QueryModel queryModel)
                                       throws java.lang.Exception

Utility method to convert the query model into the XML-based description. Can also use QueryParser for this.

Parameters:

queryModel - the query model to serialize.

Returns:

the query specification in XML.

Throws:

java.lang.Exception - any error.