org.apache.chemistry.opencmis.client.api

Interface QueryStatement

All Superinterfaces:

Cloneable

public interface QueryStatement
extends Cloneable

Query Statement.

Sample code:

 Calendar cal = ...
 Folder folder = ...
 
 QueryStatement qs = 
   session.createQueryStatement("SELECT ?, ? FROM ? WHERE ? > TIMESTAMP ? AND IN_FOLDER(?) OR ? IN (?)");
 
 qs.setProperty(1, "cmis:document", "cmis:name");
 qs.setProperty(2, "cmis:document", "cmis:objectId");
 qs.setType(3, "cmis:document");
 
 qs.setProperty(4, "cmis:document", "cmis:creationDate");
 qs.setDateTime(5, cal);
 
 qs.setId(6, folder);
 
 qs.setProperty(7, "cmis:document", "cmis:createdBy");
 qs.setString(8, "bob", "tom", "lisa"); 
 
 String statement = qs.toQueryString();
 

Method Summary

Modifier and Type	Method and Description
ItemIterable<QueryResult>	query() Executes the query with searchAllVersions set to false.
ItemIterable<QueryResult>	query(boolean searchAllVersions) Executes the query.
ItemIterable<QueryResult>	query(boolean searchAllVersions, OperationContext context) Executes the query.
void	setBoolean(int parameterIndex, boolean... bool) Sets the designated parameter to the given boolean.
void	setDateTime(int parameterIndex, Calendar... cal) Sets the designated parameter to the given DateTime value.
void	setDateTime(int parameterIndex, Date... date) Sets the designated parameter to the given DateTime value.
void	setDateTime(int parameterIndex, long... ms) Sets the designated parameter to the given DateTime value.
void	setDateTimeTimestamp(int parameterIndex, Calendar... cal) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setDateTimeTimestamp(int parameterIndex, Date... date) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setDateTimeTimestamp(int parameterIndex, long... ms) Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.
void	setId(int parameterIndex, ObjectId... id) Sets the designated parameter to the given object ID.
void	setNumber(int parameterIndex, Number... num) Sets the designated parameter to the given number.
void	setProperty(int parameterIndex, PropertyDefinition<?> propertyDefinition) Sets the designated parameter to the query name of the given property.
void	setProperty(int parameterIndex, String typeId, String propertyId) Sets the designated parameter to the query name of the given property.
void	setString(int parameterIndex, String... str) Sets the designated parameter to the given string.
void	setStringContains(int parameterIndex, String str) Sets the designated parameter to the given string in a CMIS contains statement.
void	setStringLike(int parameterIndex, String str) Sets the designated parameter to the given string.
void	setType(int parameterIndex, ObjectType type) Sets the designated parameter to the query name of the given type.
void	setType(int parameterIndex, String typeId) Sets the designated parameter to the query name of the given type ID.
void	setUri(int parameterIndex, URI... uri) Sets the designated parameter to the given URI.
void	setUrl(int parameterIndex, URL... url) Sets the designated parameter to the given URL.
String	toQueryString() Returns the query statement.

Method Detail

setType

void setType(int parameterIndex,
             String typeId)

Sets the designated parameter to the query name of the given type ID.

Parameters:

parameterIndex - the parameter index (one-based)

typeId - the type ID

setType

void setType(int parameterIndex,
             ObjectType type)

Sets the designated parameter to the query name of the given type.

Parameters:

parameterIndex - the parameter index (one-based)

type - the object type

setProperty

void setProperty(int parameterIndex,
                 String typeId,
                 String propertyId)

Sets the designated parameter to the query name of the given property.

Parameters:

parameterIndex - the parameter index (one-based)

propertyId - the property ID

setProperty

void setProperty(int parameterIndex,
                 PropertyDefinition<?> propertyDefinition)

Sets the designated parameter to the query name of the given property.

Parameters:

parameterIndex - the parameter index (one-based)

propertyDefinition - the property definition

setNumber

void setNumber(int parameterIndex,
               Number... num)

Sets the designated parameter to the given number.

Parameters:

parameterIndex - the parameter index (one-based)

num - the number

setString

void setString(int parameterIndex,
               String... str)

Sets the designated parameter to the given string.

Parameters:

parameterIndex - the parameter index (one-based)

str - the string

setStringLike

void setStringLike(int parameterIndex,
                   String str)

Sets the designated parameter to the given string. It does not escape backslashes ('\') in front of '%' and '_'.

Parameters:

parameterIndex - the parameter index (one-based)

str - the LIKE string

setStringContains

void setStringContains(int parameterIndex,
                       String str)

Sets the designated parameter to the given string in a CMIS contains statement.

Note that the CMIS specification requires two levels of escaping. The first level escapes ', ", \ characters to \', \" and \\. The characters *, ? and - are interpreted as text search operators and are not escaped on first level. If *, ?, - shall be used as literals, they must be passed escaped with \*, \? and \- to this method.

For all statements in a CONTAINS() clause it is required to isolate those from a query statement. Therefore a second level escaping is performed. On the second level grammar ", ', - and \ are escaped with a \. See the spec for further details.

Summary:

input	first level escaping	second level escaping
*	*	*
?	?	?
-	-	-
\	\\	\\\\ (for any other character following other than * ? -)
\*	\*	\\*
\?	\?	\\?
\-	\-	\\-+
'	\'	\\\'
"	\"	\\\"

Parameters:

parameterIndex - the parameter index (one-based)

str - the CONTAINS string

setId

void setId(int parameterIndex,
           ObjectId... id)

Sets the designated parameter to the given object ID.

Parameters:

parameterIndex - the parameter index (one-based)

id - the object ID

setUri

void setUri(int parameterIndex,
            URI... uri)

Sets the designated parameter to the given URI.

Parameters:

parameterIndex - the parameter index (one-based)

uri - the URI

setUrl

void setUrl(int parameterIndex,
            URL... url)

Sets the designated parameter to the given URL.

Parameters:

parameterIndex - the parameter index (one-based)

url - the URL

setBoolean

void setBoolean(int parameterIndex,
                boolean... bool)

Sets the designated parameter to the given boolean.

Parameters:

parameterIndex - the parameter index (one-based)

bool - the boolean

setDateTime

void setDateTime(int parameterIndex,
                 Calendar... cal)

Sets the designated parameter to the given DateTime value.

Parameters:

parameterIndex - the parameter index (one-based)

cal - the DateTime value as Calendar object

setDateTime

void setDateTime(int parameterIndex,
                 Date... date)

Sets the designated parameter to the given DateTime value.

Parameters:

parameterIndex - the parameter index (one-based)

date - the DateTime value as Date object

setDateTime

void setDateTime(int parameterIndex,
                 long... ms)

Sets the designated parameter to the given DateTime value.

Parameters:

parameterIndex - the parameter index (one-based)

ms - the DateTime value in milliseconds from midnight, January 1, 1970 UTC.

setDateTimeTimestamp

void setDateTimeTimestamp(int parameterIndex,
                          Calendar... cal)

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Parameters:

parameterIndex - the parameter index (one-based)

cal - the DateTime value as Calendar object

setDateTimeTimestamp

void setDateTimeTimestamp(int parameterIndex,
                          Date... date)

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Parameters:

parameterIndex - the parameter index (one-based)

date - the DateTime value as Date object

setDateTimeTimestamp

void setDateTimeTimestamp(int parameterIndex,
                          long... ms)

Sets the designated parameter to the given DateTime value with the prefix 'TIMESTAMP '.

Parameters:

parameterIndex - the parameter index (one-based)

ms - the DateTime value in milliseconds from midnight, January 1, 1970 UTC.

toQueryString

String toQueryString()

Returns the query statement.

Returns:

the query statement, not null

query

ItemIterable<QueryResult> query()

Executes the query with searchAllVersions set to false.

See Also:

Session.query(String, boolean)

query

ItemIterable<QueryResult> query(boolean searchAllVersions)

Executes the query.

Parameters:

searchAllVersions - true if all document versions should be included in the search results, false if only the latest document versions should be included in the search results

See Also:

Session.query(String, boolean)

query

ItemIterable<QueryResult> query(boolean searchAllVersions,
                                OperationContext context)

Executes the query.

Parameters:

searchAllVersions - true if all document versions should be included in the search results, false if only the latest document versions should be included in the search results

context - the operation context to use

See Also:

Session.query(String, boolean, OperationContext)