org.licas_text.query.model

Class QueryModelXml

java.lang.Object

org.licas_text.query.model.QueryModel

org.licas_text.query.model.QueryModelXml

public class QueryModelXml
extends QueryModel

This class stores a query model for XML-based queries. The model includes both a pattern part and a conditions or constraints part and has the type QueryConst.ASXML.

To use this model you would typically add PatternElement objects through the addQueryPattern method. You would typically declare an XML-based pattern as well as a set of constraints on each pattern element. The base model then allows further access to the query elements.

Author:

Kieran Greer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.licas_xml.abs.Element	structure This defines the structure required for the reply.
protected java.lang.String	structureType Defines a default structure condition that a reply can match to

Fields inherited from class org.licas_text.query.model.QueryModel

fileList, fileType, otherMeta, pattern, queryID, queryType, selectedPattern

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addQueryPattern(PatternElement newPattern) Add the pattern element to the list for the query pattern.
org.licas_xml.abs.Element	getOtherMeta() Get the other metadata value.
org.licas_xml.abs.Element	getQueryStructure() Get the reply structure.
java.lang.String	getStructureType() Get the default structure typeCondition that a reply can map to.
void	setOtherMeta(org.licas_xml.abs.Element theOtherMeta) Set the other metadata value.
void	setQueryStructure(java.lang.String theStructureType) Set the structure element based on the structure typeCondition.

Methods inherited from class org.licas_text.query.model.QueryModel

constraintValues, createAsTextModel, createModel, createNumericalModel, createTextModel, createXmlModel, firstConstraint, firstConstraintType, firstPattern, fromXml, getFileList, getFileType, getPatternNestedAt, getQueryID, getQueryPattern, getQueryType, getTotalNestedPatternCount, getTotalPatternCount, isNumericalQuery, isOtherQuery, isTextQuery, isXmlQuery, patternToNested, printPatternType, removePatternNestedAt, setFileList, setFileType, setQueryID, setQueryPattern, setQueryType, setSingleCondition, setSingleCondition, setSingleCondition, toXml, typeFromOpOther, typeFromOpText

Methods inherited from class java.lang.Object

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

Field Detail

structureType

protected java.lang.String structureType

Defines a default structure condition that a reply can match to

structure

protected org.licas_xml.abs.Element structure

This defines the structure required for the reply. Need to define more flexibly

Constructor Detail

QueryModelXml

protected QueryModelXml()

Create a new instance of QueryModelXml

Method Detail

addQueryPattern

public void addQueryPattern(PatternElement newPattern)

Add the pattern element to the list for the query pattern. This is automatically added to the end of the list.

Parameters:

newPattern - the new pattern to add.

setQueryStructure

public void setQueryStructure(java.lang.String theStructureType)

Set the structure element based on the structure typeCondition. This automatically creates the XML-based structure from the typeCondition as well. This value is not required and would typically only be used in more advanced queries, in extended classes of this version.

Parameters:

theStructureType - the structure typeCondition.

getStructureType

public java.lang.String getStructureType()

Get the default structure typeCondition that a reply can map to.

Returns:

the value of structureType.

getQueryStructure

public org.licas_xml.abs.Element getQueryStructure()

Get the reply structure. This is created automatically from a structure typeCondition that is entered.

Returns:

the value of structure.

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.

Overrides:

setOtherMeta in class QueryModel

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).

Overrides:

getOtherMeta in class QueryModel

Returns:

the value of otherMeta.