Package org.nuxeo.ecm.platform.query.core

Class WhereClauseDescriptor

java.lang.Object

org.nuxeo.ecm.platform.query.core.WhereClauseDescriptor

All Implemented Interfaces:

WhereClauseDefinition

public class WhereClauseDescriptor
extends Object
implements WhereClauseDefinition

Generic descriptor for query where clause, accepting predicates and a fixed part. A custom escaper can also be set.

Since:

5.4

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field	Description
protected String	docType	Deprecated. since 6.0: doc type moved up to the page provider descriptor.
protected boolean	escapeFixedPartParameters
protected Class<? extends Escaper>	escaperClass
protected String	fixedPart
protected PredicateDefinition[]	predicates
protected boolean	quoteFixedPartParameters
protected String	selectStatement	This parameter allows to override the default select statement used by the fixed part ("select * from Document" for NXQL queries, for instance).

Constructor Summary

Constructors

Constructor	Description
WhereClauseDescriptor()

Method Summary

Modifier and Type	Method	Description
WhereClauseDescriptor	clone()
String	getDocType()	Deprecated. since 6.0: use BasePageProviderDescriptor.getSearchDocumentType()
boolean	getEscapeFixedPartParameters()
Class<? extends Escaper>	getEscaperClass()
String	getFixedPart()
PredicateDefinition[]	getPredicates()
boolean	getQuoteFixedPartParameters()
String	getSelectStatement()	Return the custom select statement used by the fixed part ("select * from Document" for NXQL queries, for instance).
void	setFixedPart(String fixedPart)
void	setFixedPath(String fixedPart)
void	setPredicates(PredicateDefinition[] predicates)

Methods inherited from class java.lang.Object

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

Field Detail

docType

@Deprecated
protected String docType

Deprecated.

since 6.0: doc type moved up to the page provider descriptor.

escaperClass

protected Class<? extends Escaper> escaperClass

predicates

protected PredicateDefinition[] predicates

fixedPart

protected String fixedPart

selectStatement

protected String selectStatement

This parameter allows to override the default select statement used by the fixed part ("select * from Document" for NXQL queries, for instance).

Since:

5.9.2

quoteFixedPartParameters

protected boolean quoteFixedPartParameters

escapeFixedPartParameters

protected boolean escapeFixedPartParameters

Constructor Detail

WhereClauseDescriptor

public WhereClauseDescriptor()

Method Detail

getDocType

@Deprecated
public String getDocType()

Deprecated.

since 6.0: use BasePageProviderDescriptor.getSearchDocumentType()

Specified by:

getDocType in interface WhereClauseDefinition

setFixedPath

public void setFixedPath(String fixedPart)

Specified by:

setFixedPath in interface WhereClauseDefinition

getQuoteFixedPartParameters

public boolean getQuoteFixedPartParameters()

Specified by:

getQuoteFixedPartParameters in interface WhereClauseDefinition

getEscapeFixedPartParameters

public boolean getEscapeFixedPartParameters()

Specified by:

getEscapeFixedPartParameters in interface WhereClauseDefinition

getPredicates

public PredicateDefinition[] getPredicates()

Specified by:

getPredicates in interface WhereClauseDefinition

setPredicates

public void setPredicates(PredicateDefinition[] predicates)

Specified by:

setPredicates in interface WhereClauseDefinition

getFixedPart

public String getFixedPart()

Specified by:

getFixedPart in interface WhereClauseDefinition

setFixedPart

public void setFixedPart(String fixedPart)

Specified by:

setFixedPart in interface WhereClauseDefinition

getEscaperClass

public Class<? extends Escaper> getEscaperClass()

Specified by:

getEscaperClass in interface WhereClauseDefinition

getSelectStatement

public String getSelectStatement()

Description copied from interface: WhereClauseDefinition

Return the custom select statement used by the fixed part ("select * from Document" for NXQL queries, for instance).

Specified by:

getSelectStatement in interface WhereClauseDefinition

clone

public WhereClauseDescriptor clone()

Overrides:

clone in class Object

Since:

5.6