de.ipcon.db.oql

Class SemiFullTextQuery

java.lang.Object

de.ipcon.db.oql.SemiFullTextQuery

public class SemiFullTextQuery
extends java.lang.Object

A class which helps building queries out of string expressions typed into the MyTISM bookmarks. It's the headless part of the SemiFullTextQueryBuilder from the de.ipcon.db.query package. This class is embedded here to facilitate reusing the oql engine's code.

Author:

Patric Bechtel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT_ALIAS

Constructor Summary

Constructors

Constructor and Description
SemiFullTextQuery(java.lang.String rootAlias, EntityI rootEntity)
SemiFullTextQuery(java.lang.String rootAlias, EntityI rootEntity, boolean onlyDetermineRawOQLClauses)

Method Summary

Modifier and Type	Method and Description
void	addPath(java.lang.String s) Adds an attribute path that should also be queried.
java.util.List<java.lang.String>	appendConstraints(java.lang.StringBuilder sb, java.util.List<java.lang.Object> args, java.lang.String terms) Appends appropriate OQL "where" clauses for the given user input (search terms, raw OQL clauses) to the given StringBuilder and fills the given List with the associated, "extracted" parameter values.
void	appendConstraints(java.lang.StringBuilder sb, java.util.List<java.lang.Object> args, java.lang.String[] must, java.lang.String[] may, java.lang.String[] mustnt)
void	appendConstraints(java.lang.StringBuilder sb, java.util.List<java.lang.Object> args, java.lang.String[] must, java.lang.String[] may, java.lang.String[] mustnt, boolean includeDefaults)
boolean	isFallback()
boolean	setFallback(boolean b)

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ALIAS

public static final java.lang.String ROOT_ALIAS

See Also:

Constant Field Values

Constructor Detail

SemiFullTextQuery

public SemiFullTextQuery(java.lang.String rootAlias,
                         EntityI rootEntity)

SemiFullTextQuery

public SemiFullTextQuery(java.lang.String rootAlias,
                         EntityI rootEntity,
                         boolean onlyDetermineRawOQLClauses)

Parameters:

rootAlias - the identifier which is used in the query for the "root" entity to be queried

rootEntity - the entity to be queried

onlyDetermineRawOQLClauses - flag to determine what to use for a special case when building a query, depends on if the "withInterface" configuration is used

Method Detail

setFallback

public boolean setFallback(boolean b)

isFallback

public boolean isFallback()

addPath

public void addPath(java.lang.String s)
             throws OQLSyntaxException

Adds an attribute path that should also be queried.

Throws:

OQLSyntaxException

appendConstraints

public java.util.List<java.lang.String> appendConstraints(java.lang.StringBuilder sb,
                                                          java.util.List<java.lang.Object> args,
                                                          java.lang.String terms)

Appends appropriate OQL "where" clauses for the given user input (search terms, raw OQL clauses) to the given StringBuilder and fills the given List with the associated, "extracted" parameter values.

Parameters:

sb - the StringBuilder which will get the appropriate contraints appended

args - a List which will be filled with the parameter values to use (probably for comparisons) in the resulting query

terms - the (probably user entered) text search terms (including possibly "must" and "mustnt" modifiers) as well as additional raw OQL "where" clauses (that is anything TextQueryLexer can handle)

Returns:

a list of the raw OQL "where" clauses from the user input terms, if any

appendConstraints

public void appendConstraints(java.lang.StringBuilder sb,
                              java.util.List<java.lang.Object> args,
                              java.lang.String[] must,
                              java.lang.String[] may,
                              java.lang.String[] mustnt)

appendConstraints

public void appendConstraints(java.lang.StringBuilder sb,
                              java.util.List<java.lang.Object> args,
                              java.lang.String[] must,
                              java.lang.String[] may,
                              java.lang.String[] mustnt,
                              boolean includeDefaults)