org.exoplatform.services.wcm.utils

Class XPathQueryBuilder

java.lang.Object

org.exoplatform.services.wcm.utils.AbstractQueryBuilder

org.exoplatform.services.wcm.utils.XPathQueryBuilder

public class XPathQueryBuilder
extends AbstractQueryBuilder

Created by The eXo Platform SAS Author : Hoa Pham hoa.pham@exoplatform.com Oct 7, 2008

Nested Class Summary

Nested classes/interfaces inherited from class org.exoplatform.services.wcm.utils.AbstractQueryBuilder

AbstractQueryBuilder.COMPARISON_TYPE, AbstractQueryBuilder.LOGICAL, AbstractQueryBuilder.ORDERBY, AbstractQueryBuilder.PATH_TYPE, AbstractQueryBuilder.QueryTermHelper

Field Summary

Fields inherited from class org.exoplatform.services.wcm.utils.AbstractQueryBuilder

containsClause, excerptClause, fromClause, orderByClause, pathClause, propertiesClause, selectClause, spellCheckClause

Constructor Summary

Constructors

Constructor and Description
XPathQueryBuilder()

Method Summary

Modifier and Type	Method and Description
void	afterDate(String datePropertyName, String date, AbstractQueryBuilder.LOGICAL condition) After date.
void	beforeDate(String datePropertyName, String date, AbstractQueryBuilder.LOGICAL condition) Before date.
void	betweenDates(String datePropertyName, String startDate, String endDate, AbstractQueryBuilder.LOGICAL condition) Between dates.
void	closeGroup() Close group.
void	contains(String scope, String term, AbstractQueryBuilder.LOGICAL condition) Contains.
String	createQueryStatement() Creates the query statement.
void	equal(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Equal.
void	excerpt(boolean enable) Excerpt.
void	fromNodeTypes(String[] nodetypes) From node types.
void	greaterOrEqual(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Greater or equal.
void	greaterThan(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Greater than.
void	isNotNull(String propertyName, AbstractQueryBuilder.LOGICAL condition) Checks a property is not null.
void	isNull(String propertyName, AbstractQueryBuilder.LOGICAL condition) Checks a property is null.
void	lessThan(String propertyName, String value, AbstractQueryBuilder.LOGICAL condition) compare less than
void	lessThanOrEqual(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Less than or equal.
void	like(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Like.
void	merge(AbstractQueryBuilder other) Merge.
void	notContains(String scope, String term, AbstractQueryBuilder.LOGICAL condition) Not contains.
void	notEqual(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Not equal.
void	openGroup(AbstractQueryBuilder.LOGICAL logical) Open group condition for where clause
void	orderBy(String properyName, AbstractQueryBuilder.ORDERBY orderby) Order by.
void	reference(String propName, String value, AbstractQueryBuilder.LOGICAL condition) Reference.
void	selectTypes(String[] returnTypes) Select types.
void	setQueryPath(String path, AbstractQueryBuilder.PATH_TYPE pathtype) Sets the query path.
void	spellCheck(String value) Spell check.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathQueryBuilder

public XPathQueryBuilder()

Method Detail

isNull

public void isNull(String propertyName,
                   AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Checks a property is null.

Specified by:

isNull in class AbstractQueryBuilder

Parameters:

propertyName - the property name

condition - the condition

isNotNull

public void isNotNull(String propertyName,
                      AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Checks a property is not null.

Specified by:

isNotNull in class AbstractQueryBuilder

Parameters:

propertyName - the property name

condition - the condition

lessThan

public void lessThan(String propertyName,
                     String value,
                     AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

compare less than

Specified by:

lessThan in class AbstractQueryBuilder

Parameters:

propertyName - the property name

value - the value

condition - the condition

greaterThan

public void greaterThan(String propName,
                        String value,
                        AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Greater than.

Specified by:

greaterThan in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

lessThanOrEqual

public void lessThanOrEqual(String propName,
                            String value,
                            AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Less than or equal.

Specified by:

lessThanOrEqual in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

greaterOrEqual

public void greaterOrEqual(String propName,
                           String value,
                           AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Greater or equal.

Specified by:

greaterOrEqual in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

equal

public void equal(String propName,
                  String value,
                  AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Equal.

Specified by:

equal in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

notEqual

public void notEqual(String propName,
                     String value,
                     AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Not equal.

Specified by:

notEqual in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

like

public void like(String propName,
                 String value,
                 AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Like.

Specified by:

like in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

afterDate

public void afterDate(String datePropertyName,
                      String date,
                      AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

After date.

Specified by:

afterDate in class AbstractQueryBuilder

Parameters:

datePropertyName - the date property name

date - the date

condition - the condition

beforeDate

public void beforeDate(String datePropertyName,
                       String date,
                       AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Before date.

Specified by:

beforeDate in class AbstractQueryBuilder

Parameters:

datePropertyName - the date property name

date - the date

condition - the condition

betweenDates

public void betweenDates(String datePropertyName,
                         String startDate,
                         String endDate,
                         AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Between dates.

Specified by:

betweenDates in class AbstractQueryBuilder

Parameters:

datePropertyName - the date property name

startDate - the start date

endDate - the end date

condition - the condition

contains

public void contains(String scope,
                     String term,
                     AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Contains.

Specified by:

contains in class AbstractQueryBuilder

Parameters:

scope - the scope

term - the term

condition - the condition

createQueryStatement

public String createQueryStatement()

Description copied from class: AbstractQueryBuilder

Creates the query statement.

Specified by:

createQueryStatement in class AbstractQueryBuilder

Returns:

the string

merge

public void merge(AbstractQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Merge.

Specified by:

merge in class AbstractQueryBuilder

Parameters:

other - the other

notContains

public void notContains(String scope,
                        String term,
                        AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Not contains.

Specified by:

notContains in class AbstractQueryBuilder

Parameters:

scope - the scope

term - the term

condition - the condition

orderBy

public void orderBy(String properyName,
                    AbstractQueryBuilder.ORDERBY orderby)

Description copied from class: AbstractQueryBuilder

Order by.

Specified by:

orderBy in class AbstractQueryBuilder

Parameters:

properyName - the propery name

orderby - the orderby

reference

public void reference(String propName,
                      String value,
                      AbstractQueryBuilder.LOGICAL condition)

Description copied from class: AbstractQueryBuilder

Reference.

Specified by:

reference in class AbstractQueryBuilder

Parameters:

propName - the prop name

value - the value

condition - the condition

spellCheck

public void spellCheck(String value)

Description copied from class: AbstractQueryBuilder

Spell check.

Specified by:

spellCheck in class AbstractQueryBuilder

Parameters:

value - the term

setQueryPath

public void setQueryPath(String path,
                         AbstractQueryBuilder.PATH_TYPE pathtype)

Description copied from class: AbstractQueryBuilder

Sets the query path.

Specified by:

setQueryPath in class AbstractQueryBuilder

Parameters:

path - the path

pathtype - the pathtype

excerpt

public void excerpt(boolean enable)

Description copied from class: AbstractQueryBuilder

Excerpt.

Specified by:

excerpt in class AbstractQueryBuilder

Parameters:

enable - the enable

fromNodeTypes

public void fromNodeTypes(String[] nodetypes)

Description copied from class: AbstractQueryBuilder

From node types.

Specified by:

fromNodeTypes in class AbstractQueryBuilder

Parameters:

nodetypes - the nodetypes

selectTypes

public void selectTypes(String[] returnTypes)

Description copied from class: AbstractQueryBuilder

Select types.

Specified by:

selectTypes in class AbstractQueryBuilder

Parameters:

returnTypes - the return types

closeGroup

public void closeGroup()

Description copied from class: AbstractQueryBuilder

Close group.

Specified by:

closeGroup in class AbstractQueryBuilder

openGroup

public void openGroup(AbstractQueryBuilder.LOGICAL logical)

Description copied from class: AbstractQueryBuilder

Open group condition for where clause

Specified by:

openGroup in class AbstractQueryBuilder

Parameters:

logical - the logical